|
|
3.
|
|
|
This is a list in progress as I work on the user manual. There are a number of things for which I created conventions. I want to keep them in a central space so that others have access to them and that I can refer to them as well. ;-)
|
|
|
|
|
(no translation yet)
|
|
|
|
Located in
../source/documentation_info.rst:10
|
|
|
4.
|
|
|
The list is not in any particular order.
|
|
|
|
|
(no translation yet)
|
|
|
|
Located in
../source/documentation_info.rst:10
|
|
|
5.
|
|
|
Screenshots
|
|
|
|
|
(no translation yet)
|
|
|
|
Located in
../source/documentation_info.rst:58
|
|
|
6.
|
|
|
are placed using the "figure" directive.
|
|
|
|
|
(no translation yet)
|
|
|
|
Located in
../source/documentation_info.rst:62
|
|
|
7.
|
|
|
always include alt text and a figure description. The latter will be numbered in the PDF export. That sets them apart from the text.
|
|
|
|
|
(no translation yet)
|
|
|
|
Located in
../source/documentation_info.rst:18
|
|
|
8.
|
|
|
are generally placed above a list if they are part of step-by-step instructions.
|
|
|
|
|
(no translation yet)
|
|
|
|
Located in
../source/documentation_info.rst:62
|
|
|
9.
|
|
|
should have as few 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 screenshots.
|
|
|
|
|
(no translation yet)
|
|
|
|
Located in
../source/documentation_info.rst:65
|
|
|
10.
|
|
|
get callouts that are created in Gimp with the `script <https://mahara.org/view/view.php?id=60234>`_ that Iñaki adapted.
|
|
|
|
|
(no translation yet)
|
|
|
|
Located in
../source/documentation_info.rst:21
|
|
|
11.
|
|
|
that have callouts refer to the steps that need to be taken and that are explained below the figure.
|
|
|
|
|
(no translation yet)
|
|
|
|
Located in
../source/documentation_info.rst:66
|
|
|
12.
|
|
|
should only show the necessary area and not the entire screen or URL address bars etc. where not necessary.
|
|
|
|
|
(no translation yet)
|
|
|
|
Located in
../source/documentation_info.rst:67
|
