|
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
|
|
18.
|
|
|
Heading 1, e.g. 1.: ===============
|
|
|
|
(no translation yet)
|
|
|
|
Located in
../source/documentation_info.rst:149
|
|
19.
|
|
|
Heading 2, e.g. 1.1.: ---------------
|
|
|
|
(no translation yet)
|
|
|
|
Located in
../source/documentation_info.rst:150
|
|
20.
|
|
|
Heading 3, e.g. 1.1.1.: ~~~~~~~~~~~~~~~
|
|
|
|
(no translation yet)
|
|
|
|
Located in
../source/documentation_info.rst:151
|
|
21.
|
|
|
Heading 4, e.g. 1.1.1.1.: ^^^^^^^^^^^^^^^
|
|
|
|
(no translation yet)
|
|
|
|
Located in
../source/documentation_info.rst:152
|
|
22.
|
|
|
Headings below h4 should be avoided.
|
|
|
|
(no translation yet)
|
|
|
|
Located in
../source/documentation_info.rst:154
|