|
|
8.
|
|
|
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
|
|
|
9.
|
|
|
todo: for keeping a running ToDo list
|
|
|
|
|
(no translation yet)
|
|
|
|
Located in
../source/documentation_info.rst:26
|
|
|
10.
|
|
|
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
|
|
|
11.
|
|
|
Little buttons can be included in the text.
|
|
|
|
|
(no translation yet)
|
|
|
|
Located in
../source/documentation_info.rst:19
|
|
|
12.
|
|
|
Screenshots of Mahara sections are not made inline, but receive the "figure" directive. They always have an alt tag and also a brief description which will show up below the image and is numbered in LaTeX PDF.
|
|
|
|
|
(no translation yet)
|
|
|
|
Located in
../source/documentation_info.rst:20
|
|
|
13.
|
|
|
Screenshots should have as little instructions as possible about the steps that are to be taken in them. Preferably, only the step numbers so that they can be exchanged more easily and the text of the steps is translatable because it is text and not part of the image. That could also mean that translators can translate the steps but don't immediately have to change the screenshot.
|
|
|
|
|
(no translation yet)
|
|
|
|
Located in
../source/documentation_info.rst:21
|
|
|
14.
|
|
|
Inline images that are refered to in the textsuch as |edit| should be included as shortcuts with the reference at the bottom of the page.
|
|
|
|
|
(no translation yet)
|
|
|
|
Located in
../source/documentation_info.rst:22
|
|
|
15.
|
|
|
An index entry should be created for each section.
|
|
|
|
|
(no translation yet)
|
|
|
|
Located in
../source/documentation_info.rst:138
|
|
|
16.
|
|
|
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
|
|
|
17.
|
|
|
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
|
