|
|
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
|
|
|
46.
|
|
|
Heading 3, e.g. 1.1.1.: ~~~~~~~~~~~~~~~
|
|
|
|
|
(no translation yet)
|
|
|
|
Located in
../source/documentation_info.rst:151
|
|
|
47.
|
|
|
Heading 4, e.g. 1.1.1.1.: ^^^^^^^^^^^^^^^
|
|
|
|
|
(no translation yet)
|
|
|
|
Located in
../source/documentation_info.rst:152
|
|
|
48.
|
|
|
Headings below h4 should be avoided.
|
|
|
|
|
(no translation yet)
|
|
|
|
Located in
../source/documentation_info.rst:154
|
|
|
49.
|
|
|
The index page does not have headings besides the main heading. That prevents the table of contents and the other sections that have headings to be the main chapters of the manual. Keep index page headings to just bold with \**.
|
|
|
|
|
(no translation yet)
|
|
|
|
Located in
../source/documentation_info.rst:155
|
