|
|
13.
|
|
|
note: for anything that should receive a bit more attention
|
|
|
|
|
(no translation yet)
|
|
|
|
Located in
../source/documentation_info.rst:23
|
|
|
14.
|
|
|
warning: for anything that needs to be done with caution
|
|
|
|
|
(no translation yet)
|
|
|
|
Located in
../source/documentation_info.rst:24
|
|
|
15.
|
|
|
seealso: for references to other documents if they need special attention. References to other documents can also be included in the text inline.
|
|
|
|
|
(no translation yet)
|
|
|
|
Located in
../source/documentation_info.rst:25
|
|
|
16.
|
|
|
todo: for keeping a running ToDo list
|
|
|
|
|
(no translation yet)
|
|
|
|
Located in
../source/documentation_info.rst:26
|
|
|
17.
|
|
|
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
|
|
|
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
|
