Typographical Guidelines

Revision as of 11:13, 14 June 2010 by Annew (Talk | contribs) (Draft typographical usage)

(diff) ← Older revision | Latest revision (diff) | Newer revision → (diff)
Jump to: navigation, search

Adhering to these guidelines will ensure that your documentation can be accurately and easily exported for translation purposes.

Bold Text

Use bold text to highlight

  • Menu items
  • Window titles
  • Common labels that are not user-configurable
  • Icon captions
  • (Keyboard) Key names
  • Program names
Some examples:
  • Press Enter to execute the command.
  • Press Ctrl+Alt+F1 to launch a virtual terminal.
Note that "+" is used to link keys to be pressed concurrently.
  • Select View -> Message List -> Aggregation -> Standard Mailing List to see a traditional view.
Note the use of "(space)->(space)" to denote the sequence of clicks.
  • 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.

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.

  • A single line of code will be correctly displayed if a space is inserted at the beginning of the line.
  • Blocks of code may use the <pre> markup style
Some Examples:
 A leading space creates mono-spaced text
  • This block of text uses <pre> markup. Use your Edit button to view it:
<nowiki>
|<imagemap>
<translate>Image:Okular.png</translate>|48px
default <translate>[[Okular|Okular]]</translate>
desc none
</imagemap>||'''<translate>[[Okular|Okular]]</translate>'''

Content is available under Creative Commons License SA 4.0 unless otherwise noted.