Typographical Guidelines: Difference between revisions

From KDE Wiki Sandbox
(Added constraints on undesirable markup)
No edit summary
Line 6: Line 6:


Use bold text to highlight
Use bold text to highlight
:* Window titles
* Window titles
:* Common labels that are not user-configurable
* Common labels that are not user-configurable
:* Icon captions
* Icon captions
:* Program names
* Program names


:For example:
For example:


:* Highlighting a selection of text will copy it to '''klipper'''.
* Highlighting a selection of text will copy it to '''klipper'''.


==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.
:* Titles when referencing other works.
* Titles when referencing other works.
:* The first use of an unfamiliar word.
* The first use of an unfamiliar word.


:Some examples:
Some examples:
:* ''Save your work at this point.''
* ''Save your work at this point.''
:* Details can be found in ''Samba 3 by Example''....
* Details can be found in ''Samba 3 by Example''....
:* KDE Manuals are in ''Docbook'' format.
* KDE Manuals are in ''Docbook'' format.


{{Tip|1='''Programs''' are launched by users, ''components'' are used by programs}}
{{Tip|1='''Programs''' are launched by users, ''components'' are used by programs}}
Line 34: Line 34:


Some examples:
Some examples:
:* To connect to your remote server, type '''ssh ''username@domain.name''''' in Konsole.
* To connect to your remote server, type '''ssh ''username@domain.name''''' in Konsole.
:* In rpm-based distributions, the command ''rpm -q '''packagename''''' will result in '''''package-version-release'''''.
* In rpm-based distributions, the command ''rpm -q '''packagename''''' will result in '''''package-version-release'''''.


==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 will be on a pale yellow background.  For output text, the background colour will be violet-grey.   


* Code, whether single lines or blocks,use templates to ensure consistency
* Code, whether single lines or blocks,use templates to ensure consistency
Line 56: Line 56:
terminal output
terminal output
is also shown as code, but
is also shown as code, but
on a white background}}
on a grey background}}


==Text in Section Headers==
==Text in Section Headers==
Line 65: Line 65:


Bold text should be avoided in the text within these templates.  Italic text for emphasis may still be used - use sparingly for maximum effect.
Bold text should be avoided in the text within these templates.  Italic text for emphasis may still be used - use sparingly for maximum effect.
==Lists==
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 <nowiki><br /></nowiki> at the end of the line where you want to break to occur (not on a new line).


==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).
:* Sequences of menu choices should use <nowiki> <menuchoice> </nowiki>and <nowiki> </menuchoice> </nowiki> for example <menuchoice> View -> Message List -> Aggregation -> Standard Mailing List </menuchoice>
* Sequences of menu choices should use <nowiki> <menuchoice> </nowiki>and <nowiki> </menuchoice> </nowiki> for example <menuchoice> View -> Message List -> Aggregation -> Standard Mailing List </menuchoice>
:(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==
==Translatable Content==

Revision as of 10:42, 3 October 2010

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.

Bold Text

Use bold text to highlight

  • Window titles
  • Common labels that are not user-configurable
  • Icon captions
  • Program names

For example:

  • Highlighting a selection of text will copy it to klipper.

Italic Text

Use italic text to emphasise

  • Words or phrases as in general writing.
  • Titles when referencing other works.
  • The first use of an unfamiliar word.

Some examples:

  • Save your work at this point.
  • Details can be found in Samba 3 by Example....
  • KDE Manuals are in Docbook format.
Tip
Programs are launched by users, components are used by programs


Combined Bold and Italic Text

Use this combination for replaceable or variable text.

Some examples:

  • To connect to your remote server, type ssh username@domain.name in Konsole.
  • In rpm-based distributions, the command rpm -q packagename will result in package-version-release.

Mono-spaced 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.

  • Code, whether single lines or blocks,use templates to ensure consistency
  • Check Edit to see the code to use the Input template:
qdbus org.kde.NepomukServer /nepomukserver org.kde.NepomukServer.quit
rm -r ~/.kde/share/apps/nepomuk
rm -r ~/.kde4/share/apps/nepomuk
nepomukserver
  • Output works the same way:
terminal output
is also shown as code, but
on a grey background

Text in Section Headers

Even though the criteria above may be met, do not use Bold text in section headers.

Text in Information, Note, Tip or Warning Templates

Bold text should be avoided in the text within these templates. Italic text for emphasis may still be used - use sparingly for maximum effect.

Lists

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

Special Tags

  • <keycap> and </keycap> denote (keyboard) key names e.g. Enter
  • <keycap></keycap> 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).
  • Sequences of menu choices should use <menuchoice> and </menuchoice> for example View -> Message List -> Aggregation -> Standard Mailing List

(Note the use of "(space)->(space)" to denote the sequence of clicks.)

Translatable Content

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!".