Adhering to these typographic guidelines will ensure that your documentation can be accurately and easily exported for translation purposes.
Use bold text to highlight
Use italic text to emphasise
|Programs are launched by users, components are used by programs|
Use this combination for replaceable or variable text.
Code should be presented in mono-spaced text, boxed, as shown below. Input text will be on a pale yellow background. For output text, the background colour will be violet-grey.
qdbus org.kde.NepomukServer /nepomukserver org.kde.NepomukServer.quit rm -r ~/.kde/share/apps/nepomuk rm -r ~/.kde4/share/apps/nepomuk nepomukserver
terminal output is also shown as code, but on a grey background
Even though the criteria above may be met, do not use Bold text in section headers.
Bold text should be avoided in the text within these templates. Italic text for emphasis may still be used - use sparingly for maximum effect.
If an list is long it may be felt desirable to split the list, making it easier to read. If this is done by newline characters it splits the translation sections. The way to achieve this visually but without that side-effect is to use <br /> at the end of the line where you want to break to occur (not on a new line).
(Note the use of "(space)->(space)" to denote the sequence of clicks.)
Everything that is translatable is contained within <translate> and </translate> tags. In most cases any images should be contained within the translatable section, as it is sometimes necessary to us localised versions of the images to explain a point. The rule of thumb is "If in doubt, include it!".