(Add info about including images in translatable sections) |
|||
Line 16: | Line 16: | ||
==Italic Text== | ==Italic Text== | ||
+ | |||
Use italic text to emphasise | Use italic text to emphasise | ||
:* Words or phrases as in general writing. | :* Words or phrases as in general writing. | ||
Line 26: | Line 27: | ||
:* KDE Manuals are in ''Docbook'' format. | :* KDE Manuals are in ''Docbook'' format. | ||
− | {{Tip| | + | {{Tip|1='''Programs''' are launched by users, ''components'' are used by programs}} |
==Combined Bold and Italic Text== | ==Combined Bold and Italic Text== | ||
+ | |||
Use this combination for replaceable or variable text. | Use this combination for replaceable or variable text. | ||
Line 36: | Line 38: | ||
==Mono-spaced Text== | ==Mono-spaced Text== | ||
+ | |||
Code should be presented in mono-spaced text, boxed, as shown below. Input text should use the background colour "aliceblue". For output text, the background colour should be white. | Code should be presented in mono-spaced text, boxed, as shown below. Input text should use the background colour "aliceblue". For output text, the background colour should be white. | ||
Line 56: | Line 59: | ||
==Special Tags== | ==Special Tags== | ||
+ | |||
:* <nowiki> <keycap></nowiki> and <nowiki> </keycap> </nowiki> denote (keyboard) key names e.g. <keycap>Enter</keycap> | :* <nowiki> <keycap></nowiki> and <nowiki> </keycap> </nowiki> denote (keyboard) key names e.g. <keycap>Enter</keycap> | ||
:* <nowiki><keycap></keycap></nowiki> can also be used around groups of keys to be used concurrently, e.g. '''Ctrl+Alt+F1''' to launch a virtual terminal. (Note that Note that "+" is used to link keys to be pressed concurrently). | :* <nowiki><keycap></keycap></nowiki> can also be used around groups of keys to be used concurrently, e.g. '''Ctrl+Alt+F1''' to launch a virtual terminal. (Note that Note that "+" is used to link keys to be pressed concurrently). | ||
Line 61: | Line 65: | ||
:(Note the use of "(space)->(space)" to denote the sequence of clicks.) | :(Note the use of "(space)->(space)" to denote the sequence of clicks.) | ||
+ | ==Translatable Content== | ||
+ | |||
+ | Everything that is translatable is contained within <nowiki><translate> and </translate></nowiki> 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!". | ||
[[Category:Contributing]] | [[Category:Contributing]] |
There are separate pages explaining Page Layout and syntax with example code.
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
Tip |
---|
Programs are launched by users, components are used by programs |
Use this combination for replaceable or variable text.
Some examples:
Code should be presented in mono-spaced text, boxed, as shown below. Input text should use the background colour "aliceblue". For output text, the background colour should be white.
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 white background
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!".