Browsing Chinese (Traditional) translation

1.

Information for Mahara documentation writers

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. ;-)

3.

The list is not in any particular order.

4.

Screenshots

5.

are placed using the "figure" directive.

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.

7.

are generally placed above a list if they are part of step-by-step instructions.

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.

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.

10.

that have callouts refer to the steps that need to be taken and that are explained below the figure.