Difference between revisions of "Typographical Guidelines"

Jump to: navigation, search
(Mono-spaced Text: Set new standard for Input and Output code)
Line 41: Line 41:
  
 
==Mono-spaced Text==
 
==Mono-spaced Text==
Code should be presented in mono-spaced text.   
+
Code should be presented in mono-spaced text, boxed, as shown belowInput text should use the background colour "aliceblue"For output text, the background colour should be white. 
:* 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 <nowiki><pre></nowiki> markup style
+
  
:Some Examples:
+
:* Code, whether single lines or blocks,use the <nowiki><pre></nowiki> markup style
  
  A leading space creates mono-spaced text
+
:::* These blocks of text uses <nowiki><pre></nowiki> markup.  Use your '''Edit''' button to view the markup:
  
:::* This block of text uses <nowiki><pre></nowiki> markup.  Use your '''Edit''' button to view it:
+
<pre style="margin-left: 4em; background-color:aliceblue; border:2px dotted #BCBCBC">
<pre style="margin-left: 4em"><nowiki>
+
qdbus org.kde.NepomukServer /nepomukserver org.kde.NepomukServer.quit
|<imagemap>
+
rm -r ~/.kde/share/apps/nepomuk
&lt;translate>Image:Okular.png&lt;/translate>|48px
+
rm -r ~/.kde4/share/apps/nepomuk
default &lt;translate>[[Okular|Okular]]&lt;/translate>
+
nepomukserver
desc none
+
</pre>
</imagemap>||'''&lt;translate>[[Okular|Okular]]&lt;/translate>'''
+
 
 +
 
 +
<pre style="margin-left: 4em; background-color:white; border:2px dotted #BCBCBC">
 +
terminal output
 +
is also shown as code, but
 +
on a white background
 
</pre>
 
</pre>
  

Revision as of 13:33, 27 June 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
Some examples:
  • Press Ctrl+Alt+F1 to launch a virtual terminal.
Note that "+" is used to link keys to be pressed concurrently.
  • 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.
Help-hint.png 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 should use the background colour "aliceblue". For output text, the background colour should be white.

  • Code, whether single lines or blocks,use the <pre> markup style
  • These blocks of text uses <pre> markup. Use your Edit button to view the markup:
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

Special Tags

  • <keycap> and </keycap> denote (keyboard) key names e.g. Enter
  • 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.

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