|
|
1.
|
|
|
Information for Mahara documentation writers
|
|
|
|
|
Informatie voor Mahara documentatieschrijvers
|
|
Translated and reviewed by
Koen Roggemans
|
|
|
|
Located in
../source/documentation_info.rst:6
|
|
|
2.
|
|
|
This is a list in progress as I work on the documentation. There are a number of things for which I create 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. ;-)
|
|
|
|
|
Deze lijst evolueert terwijl ik werk aan de documentatie. Er zijn vele zaken waarvoor ik afspraken maak. Ik wil ze op een centrale plaats bewaren, zodat anderen er toegang toe hebben en ik er kan naar verwijzen ;-)
|
|
Translated and reviewed by
Koen Roggemans
|
|
|
|
Located in
../source/documentation_info.rst:8
|
|
|
3.
|
|
|
The list is not in any particular order.
|
|
|
|
|
Deze lijst staat niet in een bepaalde volgorde.
|
|
Translated and reviewed by
Koen Roggemans
|
|
|
|
Located in
../source/documentation_info.rst:10
|
|
|
4.
|
|
|
Screenshots
|
|
|
|
|
Schermafdrukken
|
|
Translated and reviewed by
Koen Roggemans
|
|
|
|
Located in
../source/documentation_info.rst:58
|
|
|
5.
|
|
|
are placed using the "figure" directive.
|
|
|
|
|
worden geplaatst door gebruik te maken van het label "figure".
|
|
Translated and reviewed by
Koen Roggemans
|
|
|
|
Located in
../source/documentation_info.rst:62
|
|
|
6.
|
|
|
always include alt text and a figure description. The latter will be numbered in the PDF export. That sets them apart from the text.
|
|
|
|
|
gebruik altijd alt-teksten en een afbeeldingsbeschrijving. Die zullen genummerd worden in de PDF-export, wat hen onderscheidt van de teksten.
|
|
Translated and reviewed by
Koen Roggemans
|
|
|
|
Located in
../source/documentation_info.rst:18
|
|
|
7.
|
|
|
are generally placed above a list if they are part of step-by-step instructions.
|
|
|
|
|
worden meestal geplaatst boven een lijst als ze deel zijn van stap voor stap-instructies.
|
|
Translated and reviewed by
Koen Roggemans
|
|
|
|
Located in
../source/documentation_info.rst:62
|
|
|
8.
|
|
|
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.
|
|
|
|
|
zouden zo weinig mogelijk instructies moeten bevatten over de stappen die er voor moeten genomen worden. Bij voorkeur enkel de stapnummers, zodat ze gemakkelijk uitgewisseld en vertaald kunnen worden vermits de tekst dan geen deel is van de afbeelding. Dat kan ook betekenen dat de vertalers de stappen kunnen vertalen en niet onmiddellijk de afbeeldingen moeten vervangen.
|
|
Translated and reviewed by
Koen Roggemans
|
|
|
|
Located in
../source/documentation_info.rst:65
|
|
|
9.
|
|
|
are created with Shutter in Ubuntu. It is easy to add the callouts which indicate the steps to take. However, any other screenshot software can be used. Preferably, the callouts look similarly for consistency. The color is #4C711D.
|
|
|
|
|
zijn gemaakt met Shutter in Ubuntu. Het is gemakkelijk om de tekstballonnetjes toe te voegen die de verschillende stappen aanduiden. Natuurlijk kan er gelijk welke schermafdruksoftware gebruikt worden. Bij voorkeur zien de tekstballonnetjes er hetzelfde uit voor consistentie. De gebruikte kleur is #4C711D.
|
|
Translated and reviewed by
Koen Roggemans
|
|
|
|
Located in
../source/documentation_info.rst:18
|
|
|
10.
|
|
|
that have callouts refer to the steps that need to be taken and that are explained below the figure.
|
|
|
|
|
hebben tekstballonnetjes die refereren naar de stappen die genomen moeten worden en die onder de figuur uitgelegd worden.
|
|
Translated and reviewed by
Koen Roggemans
|
|
|
|
Located in
../source/documentation_info.rst:66
|
