|
|
74.
|
|
|
Each section that is related to a navigation menu item should have the path listed, e.g. *Main menu → Create → Files*. It is best if you copy the arrow to get the correct one.
|
|
|
|
|
(no translation yet)
|
|
|
|
Located in
../source/documentation_info.rst:135
|
|
|
75.
|
|
|
Buttons such as *Save* or *Copy page* and also portfolio sections such as *Create*, *Share* etc. are highlighted as emphasized text (with a single \*).
|
|
|
|
|
(no translation yet)
|
|
|
|
Located in
../source/documentation_info.rst:136
|
|
|
76.
|
|
|
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
|
|
|
77.
|
|
|
An index entry should be created for each section.
|
|
|
|
|
(no translation yet)
|
|
|
|
Located in
../source/documentation_info.rst:138
|
|
|
78.
|
|
|
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
|
|
|
79.
|
|
|
``:index:`Decide on the sort order <single: New in Mahara 19.04; Sort order of files in the "Folder" block>```
|
|
|
|
|
(no translation yet)
|
|
|
|
Located in
../source/documentation_info.rst:0
|
|
|
80.
|
|
|
If there is not a punctuation mark just before ":index:" and/or after ">`", you have to insert a space just before ":index:" and/or after ">`".
|
|
|
|
|
(no translation yet)
|
|
|
|
Located in
../source/documentation_info.rst:144
|
|
|
81.
|
|
|
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
|
|
|
82.
|
|
|
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
|
|
|
83.
|
|
|
Heading 1, e.g. 1.: ===============
|
|
|
|
|
(no translation yet)
|
|
|
|
Located in
../source/documentation_info.rst:149
|
