|
|
18.
|
|
|
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 at the beginning of each file in which a substitution is used. They are referenced in the text as "*Edit* button |edit|" for example pointing out what the action is that you do with them.
|
|
|
|
|
(no translation yet)
|
|
|
|
Located in
../source/documentation_info.rst:29
|
|
|
19.
|
|
|
An index entry should be created for each section.
|
|
|
|
|
(no translation yet)
|
|
|
|
Located in
../source/documentation_info.rst:138
|
|
|
20.
|
|
|
New features receive an index entry as well in the form "single: New in Mahara 1.5; [the thing that is new]".
|
|
|
|
|
(no translation yet)
|
|
|
|
Located in
../source/documentation_info.rst:31
|
|
|
21.
|
|
|
Long sections should be broken up into several pages to make the editing more manageable.
|
|
|
|
|
(no translation yet)
|
|
|
|
Located in
../source/documentation_info.rst:55
|
|
|
22.
|
|
|
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
|
|
|
23.
|
|
|
Heading 1, e.g. 1.: ===============
|
|
|
|
|
(no translation yet)
|
|
|
|
Located in
../source/documentation_info.rst:149
|
|
|
24.
|
|
|
Heading 2, e.g. 1.1.: ---------------
|
|
|
|
|
(no translation yet)
|
|
|
|
Located in
../source/documentation_info.rst:150
|
|
|
25.
|
|
|
Heading 3, e.g. 1.1.1.: ~~~~~~~~~~~~~~~
|
|
|
|
|
(no translation yet)
|
|
|
|
Located in
../source/documentation_info.rst:151
|
|
|
26.
|
|
|
Heading 4, e.g. 1.1.1.1.: ^^^^^^^^^^^^^^^
|
|
|
|
|
(no translation yet)
|
|
|
|
Located in
../source/documentation_info.rst:152
|
|
|
27.
|
|
|
Headings below h4 should be avoided.
|
|
|
|
|
(no translation yet)
|
|
|
|
Located in
../source/documentation_info.rst:154
|
