|
|
26.
|
|
|
Start the virtual environment so you can compile the manual using Sphinx: ``. venv/bin/activate``
|
|
|
|
|
(no translation yet)
|
|
|
|
Located in
../source/documentation_info.rst:48
|
|
|
27.
|
|
|
Now make any changes in your preferred editor.
|
|
|
|
|
(no translation yet)
|
|
|
|
Located in
../source/documentation_info.rst:49
|
|
|
28.
|
|
|
Compile a preview of the manual just in English: ``make preview MAHARA=18.10``
|
|
|
|
|
(no translation yet)
|
|
|
|
Located in
../source/documentation_info.rst:50
|
|
|
29.
|
|
|
Change the version number depending on the version of Mahara that you are compiling.
|
|
|
|
|
(no translation yet)
|
|
|
|
Located in
../source/documentation_info.rst:53
|
|
|
30.
|
|
|
Deactivate the virtual environment once you are done editing: ``deactivate``
|
|
|
|
|
(no translation yet)
|
|
|
|
Located in
../source/documentation_info.rst:55
|
|
|
31.
|
|
|
Screenshots
|
|
|
|
|
(no translation yet)
|
|
|
|
Located in
../source/documentation_info.rst:58
|
|
|
32.
|
|
|
are placed using the "figure" directive.
|
|
|
|
|
(no translation yet)
|
|
|
|
Located in
../source/documentation_info.rst:62
|
|
|
33.
|
|
|
always include alt text and a figure description. That sets them apart from the text.
|
|
|
|
|
(no translation yet)
|
|
|
|
Located in
../source/documentation_info.rst:61
|
|
|
34.
|
|
|
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
|
|
|
35.
|
|
|
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
|
