|
|
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
|
|
|
|
|
Konventionen
|
|
Translated and reviewed by
Ralf Hilgenstock
|
|
|
|
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.
|
|
|
|
|
Jeder Abschnitt, der auf ein Navigationsmenu verweist, beschreibt den Pfad, z.B. *Inhalt → Dateien*. Am besten kopieren Sie den Pfeil.
|
|
Translated and reviewed by
Ralf Hilgenstock
|
|
|
|
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.
|
|
|
|
|
Kleine Buttons können direkt in eine Textzeile eingefügt werden wie |edit| oder |manage|. Sie werden über einen Texteintrag eingefügt und dann automatisch ersetzt. Die Ersetzungen werden in der Datei *shortcuts.rstext* eingetragen. Diese wird in jede Datei eingefügt, in der Ersetzungen vorkommen. Dazu wird "``.. include:: /shortcuts.rstext``" in die erste Zeile der Datei eingefügt.Im Text werden die Ersetzungen wie folgt eingesetzt "``*Edit* button |edit|``". Übersetzer lassen den Eintrag zwischen den vertikalen Strichen unübersetzt "``|edit|``". Übersetzt wird nur "``*Edit* button``". Achte darauf, das \* stehen zu lassen und kein Leerzeichen zwischen dem \* und dem Text zu lassen, damit eine Hervorhebung erfolgt.
|
|
Translated and reviewed by
Ralf Hilgenstock
|
|
|
|
Located in
../source/documentation_info.rst:126
|
|
|
55.
|
|
|
An index entry should be created for each section.
|
|
|
|
|
Ein Index-Eintrag sollte für jeden Abschnitt erzeugt werden.
|
|
Translated and reviewed by
Ralf Hilgenstock
|
|
|
|
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
|
|
|
57.
|
|
|
``:index:`Decide on the sort order <single: New in Mahara 15.04; Sort order of files in the "Folder" block>```
|
|
|
|
|
(no translation yet)
|
|
|
|
Located in
../source/documentation_info.rst:0
|
|
|
58.
|
|
|
Long sections like the administration are broken up into several pages to make the editing more manageable instead of having everything on one very long page.
|
|
|
|
|
(no translation yet)
|
|
|
|
Located in
../source/documentation_info.rst:146
|
