|
|
1.
|
|
|
Information for Mahara documentation writers
|
|
|
|
|
Informatie voor Mahara documentatieschrijvers
|
|
Translated and reviewed by
Koen Roggemans
|
|
|
|
Located in
../source/documentation_info.rst:6
|
|
|
2.
|
|
|
This is a list in progress as I work on the documentation. There are a number of things for which I create conventions. I want to keep them in a central space so that others have access to them and that I can refer to them as well. ;-)
|
|
|
|
|
Deze lijst evolueert terwijl ik werk aan de documentatie. Er zijn vele zaken waarvoor ik afspraken maak. Ik wil ze op een centrale plaats bewaren, zodat anderen er toegang toe hebben en ik er kan naar verwijzen ;-)
|
|
Translated and reviewed by
Koen Roggemans
|
|
|
|
Located in
../source/documentation_info.rst:8
|
|
|
3.
|
|
|
The list is not in any particular order.
|
|
|
|
|
Deze lijst staat niet in een bepaalde volgorde.
|
|
Translated and reviewed by
Koen Roggemans
|
|
|
|
Located in
../source/documentation_info.rst:10
|
|
|
4.
|
|
|
Screenshots are placed as figures and always include alt text and a figure description. The latter will receive numbering in the PDF export.
|
|
|
|
|
(no translation yet)
|
|
|
|
Located in
../source/documentation_info.rst:10
|
|
|
5.
|
|
|
Admonitions in use are:
|
|
|
|
|
Gebruikte verwijzingen zijn:
|
|
Translated and reviewed by
Koen Roggemans
|
|
|
|
Located in
../source/documentation_info.rst:21
|
|
|
6.
|
|
|
note: for anything that should receive a bit more attention
|
|
|
|
|
opmerking: voor alles dat wat meer aandacht nodig heeft
|
|
Translated and reviewed by
Koen Roggemans
|
|
|
|
Located in
../source/documentation_info.rst:23
|
|
|
7.
|
|
|
warning: for anything that needs to be done with caution
|
|
|
|
|
waarschuwing: voor alles dat voorzichting gedaan moet worden
|
|
Translated and reviewed by
Koen Roggemans
|
|
|
|
Located in
../source/documentation_info.rst:24
|
|
|
8.
|
|
|
seealso: for references to other documents if they need special attention. References to other documents can also be included in the text inline.
|
|
|
|
|
zie ook: voor referenties naar andere documenten als ze speciale aandacht nodig hebben. Referenties naar andere documenten kunnen ook in de tekst opgenomen worden.
|
|
Translated and reviewed by
Koen Roggemans
|
|
|
|
Located in
../source/documentation_info.rst:25
|
|
|
9.
|
|
|
todo: for keeping a running ToDo list
|
|
|
|
|
takenlijst: voor het bijhouden van een takenlijst
|
|
Translated and reviewed by
Koen Roggemans
|
|
|
|
Located in
../source/documentation_info.rst:26
|
|
|
10.
|
|
|
Buttons such as *Save* or *Copy page* and also portfolio sections such as *Content*, *Porfolio* etc. are highlighted as emphasized text (with a single \*).
|
|
|
|
|
Knoppen zoals * Bewaar* of *Kopieer pagina* en ook portfoliosecties zoals *Inhoud*; *Portfolio* enz worden benadrukt als vette tekst (met een enkele \*).
|
|
Translated and reviewed by
Koen Roggemans
|
|
|
|
Located in
../source/documentation_info.rst:73
|
