Writing guidelines

Creating a page

Do not create a new page by making a new link in an existing page. To create a page, please use your web browser's URL address bar (you can make the link on the page later).

The names of the page must be in English and be rather short (max. 3 words, separated by a ”-”).

Be sure to place the page in the correct namespace and to verify that you are not going to create a page in a namespace that does not exist.


Use titles in a way that is reasonable and logical. Always begin with a first-level title.

Avoid titles that are too long.

If a page becomes too hierarchical, it is better to cut the topic into several different pages.


  • the tone should be educational and professional,
  • if necessary, make a link to an entry in the Glossary (create one if needed)
  • when it is useful, make links to other pages in the wiki

Wiki Syntax

Wiki Syntax is really easy, and you have a toolbar just above the text-entry field to help you.

Never make an internal link by copying/pasting a URL into a page.

Use relative links as often as possible. For example, rather than :2.0:contribute:plugins, use .:plugins.


To create a note, simply do the following (for a simple note):

This is a note.

You can also add a note with the word “tip”, “important”, or “warning” to help identify a tip, an important note, or a warning. For example:

<note tip>
This is a tip.

Automatic table of contents

The pagetoc plugin is an efficient way to include links to pages in the wiki and to automatically generate a table of contents for it. For example:


It is possible to add multiple pages to to a pagetoc entry, such as:


Two modifiers allow controlling how the link is displayed, they are placed after the name of the page. The first modifier is an alternate title for the page, and the second allows hiding the table of contents (|x in the example). For example:

:2.0:hosting:a-page|Super documentation|x
Last modified: 01/03/2008 at 14:14 by Ryan Anderson