Guidelines for Contributors

The OARiNZ Knowledge Base uses a topic-based stucture, in which each page covers a single topic. In general, all pages follow the same structure. For an example, view this page’s source text.

1.  Introductory paragraph

The start of each page is a short paragraph which defines the topic and includes links to closely related topics.

2.  Page table of contents

Insert the (:toc:) markup to generate a table of contents for the page, using the headings on the page as entries.

3.  Body text

Write the main body of the topic, using headings to provide structure, and citations to refer to external supporting information.

4.  See also references

These are internal links to related topics on other Knowledge Base pages. This section is optional.

5.  External links

These are links to related Web pages outside the Knowledge Base. This section is optional — it is better to put all links to external sites on their relevant topic pages, rather than on general-purpose “Web Resources” pages.

6.  Categories

These are links to category (subject heading) pages, made using the category markup: [[!category name]]. A separate “Categories” heading is not required.

7.  References

If the page includes citations, the wiki will automatically generate a sorted list of references at the end of the page. The references may include a “Further reading” section — items defined but not explicitly cited — instead of an external links section.