These "rules" are soft rules. The goal is to have a
well structured wiki, easy and quick to edit.
Input format of pages
It is preferable to use the Markdown format to edit your pages.
The Markdown documentation is very small. It is available
Try to avoid the use of direct HTML formatting in your pages.
To link to some resource existing in the wiki, use local
links, not global ones (starting with http:// or whatever).
Links to other resources may obviously be global.
If you want to quickly edit an existing page on the wiki,
the easiest way is to click the button edit on the top
It would be nice, but it's not absolutely necessary, to
write some meaningful comment in the Commit message field,
to help tracking changes.
If you want to write some new complex wiki page, the best option
is to clone the wiki repository, edit and preview locally, and
then use the git machinery to commit and push changes back to
To clone the wiki git repository, click Git Access on the top
of the page.
Local server (for linux)
In the git repository is a folder tools that contains a basic web server
This allows you to quickly see how your pages are rendered.
It should render your pages more or less as the production server does.
Refer to the documentation included within the mini server for more information.
If it does not work, contact us.
If you want to add an attachment to a page, it is preferable to use the
git machinery (git add / git commit / git push) and use
sub-directories. If your page is called MyPage.md then put the
attachments in the sub-directory MyPage. You can then refer
to them with the syntax [this is an attachment](MyPage/attachment.xyz).
You may use the button Attach a file that you see when
you edit the page directly on the server. But then the file will not be
put in the wiki git repository and it's harder to track it.
Avoid this method if possible.