|
|
36.
|
|
|
Conventions
|
|
|
|
|
(no translation yet)
|
|
|
|
Located in
../source/documentation_info.rst:120
|
|
|
37.
|
|
|
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.
|
|
|
|
|
(no translation yet)
|
|
|
|
Located in
../source/documentation_info.rst:124
|
|
|
38.
|
|
|
Buttons such as *Save* or *Copy page* and also portfolio sections such as *Content*, *Porfolio* etc. are highlighted as emphasized text (with a single \*).
|
|
|
|
|
(no translation yet)
|
|
|
|
Located in
../source/documentation_info.rst:73
|
|
|
39.
|
|
|
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
|
|
|
40.
|
|
|
An index entry should be created for each section.
|
|
|
|
|
(no translation yet)
|
|
|
|
Located in
../source/documentation_info.rst:138
|
|
|
41.
|
|
|
New features receive an index entry as well in the form "single: New in Mahara 1.x, [the functionality that is new]".
|
|
|
|
|
(no translation yet)
|
|
|
|
Located in
../source/documentation_info.rst:76
|
|
|
42.
|
|
|
Long sections should be 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:77
|
|
|
43.
|
|
|
reStructuredText does not have a set hierarchy of heading levels. They depend on the individual files. However, to be consistent, the following convention exists:
|
|
|
|
|
(no translation yet)
|
|
|
|
Located in
../source/documentation_info.rst:147
|
|
|
44.
|
|
|
Heading 1, e.g. 1.: ===============
|
|
|
|
|
(no translation yet)
|
|
|
|
Located in
../source/documentation_info.rst:149
|
|
|
45.
|
|
|
Heading 2, e.g. 1.1.: ---------------
|
|
|
|
|
(no translation yet)
|
|
|
|
Located in
../source/documentation_info.rst:150
|
