Browsing Louisiana French translation

39.

Little buttons can be included in the text like |edit|, |manage|. They are added through a substitution. All replacements are kept in the file *shortcuts.rstext* which is included in each file in which a substitution is used by placing "``.. include:: /shortcuts.rstext``" in the first line of the file. Substitutions are referenced in the text as "``*Edit* button |edit|``" for example pointing out what the action is that you do with them. Translators should not edit the substitution "``|edit|``" itself, but only change "``*Edit* button``" taking care to include the \* again without placing any spaces between the \* and the text to ensure that the word appears highlighted.

40.

An index entry should be created for each section.

41.

New features receive an index entry as well in the form "single: New in Mahara 1.x, [the functionality that is new]".

42.

Long sections should be broken up into several pages to make the editing more manageable instead of having everything on one very long page.

43.

reStructuredText does not have a set hierarchy of heading levels. They depend on the individual files. However, to be consistent, the following convention exists:

44.

Heading 1, e.g. 1.: ===============

45.

Heading 2, e.g. 1.1.: ---------------

46.

Heading 3, e.g. 1.1.1.: ~~~~~~~~~~~~~~~

47.

Heading 4, e.g. 1.1.1.1.: ^^^^^^^^^^^^^^^

48.

Headings below h4 should be avoided.