|
|
47.
|
|
|
Try not to put everything into an admonition because then the truly important information is lost.
|
|
|
|
|
(no translation yet)
|
|
|
|
Located in
../source/documentation_info.rst:110
|
|
|
48.
|
|
|
**seealso**: for references to other documents if they need special attention. References to other documents can also be included in the text inline.
|
|
|
|
|
**seealso**: voor referenties naar andere documenten als daar speciale aandacht voor nodig is. referneties naar andere documenten kunnen ook in de tekst inline opgenomen worden.
|
|
Translated and reviewed by
Koen Roggemans
|
|
|
|
Located in
../source/documentation_info.rst:112
|
|
|
49.
|
|
|
The `Sphinx user documentation <http://sphinx.pocoo.org/>`_ is a great place to deepend your knowledge and understanding of using rST with Sphinx. If you have any questions, you can also check out the `Sphinx discussion group <http://groups.google.com/group/sphinx-dev/>`_.
|
|
|
|
|
(no translation yet)
|
|
|
|
Located in
../source/documentation_info.rst:117
|
|
|
50.
|
|
|
**todo**: for keeping a running ToDo list. ToDo lists are currently disabled.
|
|
|
|
|
(no translation yet)
|
|
|
|
Located in
../source/documentation_info.rst:117
|
|
|
51.
|
|
|
Conventions
|
|
|
|
|
Conventies
|
|
Translated and reviewed by
Koen Roggemans
|
|
|
|
Located in
../source/documentation_info.rst:120
|
|
|
52.
|
|
|
Each section that is related to a navigation menu item should have the path listed, e.g. *Content → Files*. It is best if you copy the arrow to get the correct one.
|
|
|
|
|
Elke sectie die met het navigatiemenu te maken heeft, zou het pad moeten tonen, vb *Inhoud → Bestanden*. Je kunt best te pijl kopiëren om de juiste te hebben.
|
|
Translated and reviewed by
Koen Roggemans
|
|
|
|
Located in
../source/documentation_info.rst:124
|
|
|
53.
|
|
|
Buttons such as *Save* or *Copy page* and also portfolio sections such as *Content*, *Portfolio* etc. are highlighted as emphasized text (with a single \*).
|
|
|
|
|
(no translation yet)
|
|
|
|
Located in
../source/documentation_info.rst:125
|
|
|
54.
|
|
|
Little buttons can be included in the text like |edit|, |manage|. They are added through a substitution. All replacements are kept in the file *shortcuts.rstext* which is included in each file in which a substitution is used by placing "``.. include:: /shortcuts.rstext``" in the first line of the file. Substitutions are referenced in the text as "``*Edit* button |edit|``" for example pointing out what the action is that you do with them. Translators should not edit the substitution "``|edit|``" itself, but only change "``*Edit* button``" taking care to include the \* again without placing any spaces between the \* and the text to ensure that the word appears highlighted.
|
|
|
|
|
(no translation yet)
|
|
|
|
Located in
../source/documentation_info.rst:126
|
|
|
55.
|
|
|
An index entry should be created for each section.
|
|
|
|
|
Er moet een indexverwijzing gemaakt worden voor elke sectie.
|
|
Translated and reviewed by
Koen Roggemans
|
|
|
|
Located in
../source/documentation_info.rst:138
|
|
|
56.
|
|
|
New features receive an index entry as well in the form "single: New in Mahara x, [the functionality that is new]". Index entries can be placed either above an entire section or inline. Inline is preferable for small functional changes so that readers are directly taken to the new functionality. This can be done like so:
|
|
|
|
|
(no translation yet)
|
|
|
|
Located in
../source/documentation_info.rst:128
|
