Difference between revisions of "Typographical Guidelines"

Jump to: navigation, search
(The Problematic Pipe Symbol: fixed typos)
(4 intermediate revisions by one user not shown)
Line 2: Line 2:
 
<translate>
 
<translate>
  
 +
<!--T:1-->
 
''There is a separate pages explaining [[Special:myLanguage/Toolbox|general syntax]] with example code.''
 
''There is a separate pages explaining [[Special:myLanguage/Toolbox|general syntax]] with example code.''
  
 +
<!--T:2-->
 
Adhering to these typographic guidelines will ensure that your documentation can be accurately and easily exported for translation purposes.
 
Adhering to these typographic guidelines will ensure that your documentation can be accurately and easily exported for translation purposes.
  
== Bold Text ==  
+
== Bold Text == <!--T:3-->
  
 +
<!--T:4-->
 
Use bold text to highlight
 
Use bold text to highlight
 
* Window titles
 
* Window titles
Line 14: Line 17:
 
* Program names
 
* Program names
  
 +
<!--T:5-->
 
For example:
 
For example:
  
 +
<!--T:6-->
 
* Highlighting a selection of text will copy it to '''Klipper'''.
 
* Highlighting a selection of text will copy it to '''Klipper'''.
  
== Italic Text ==  
+
== Italic Text == <!--T:7-->
  
 +
<!--T:8-->
 
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 25: Line 31:
 
* The first use of an unfamiliar word.
 
* The first use of an unfamiliar word.
  
 +
<!--T:9-->
 
Some examples:
 
Some examples:
 
* ''Save your work at this point.''
 
* ''Save your work at this point.''
Line 30: Line 37:
 
* KDE Manuals are in ''Docbook'' format.
 
* KDE Manuals are in ''Docbook'' format.
  
 +
<!--T:10-->
 
{{Tip|1=''Programs'' are launched by users, ''components'' are used by programs}}
 
{{Tip|1=''Programs'' are launched by users, ''components'' are used by programs}}
  
== Combined Bold and Italic Text ==  
+
== Combined Bold and Italic Text == <!--T:11-->
  
 +
<!--T:12-->
 
Use this combination for replaceable or variable text.
 
Use this combination for replaceable or variable text.
  
 +
<!--T:13-->
 
Some examples:
 
Some examples:
 
* To connect to your remote server, type <code>ssh</code> '''''username@domain.name''''' in '''Konsole'''.
 
* To connect to your remote server, type <code>ssh</code> '''''username@domain.name''''' in '''Konsole'''.
 
* In rpm-based distributions, the command <code>rpm -q</code> '''''packagename''''' will result in '''''package-version-release'''''.
 
* In rpm-based distributions, the command <code>rpm -q</code> '''''packagename''''' will result in '''''package-version-release'''''.
  
== Mono-spaced Text ==  
+
== Mono-spaced Text == <!--T:14-->
  
 +
<!--T:15-->
 
Code should be presented in mono-spaced text, usually boxed, as shown below.  Input text will be on a pale yellow background.  For output text, the background colour will be violet-grey.   
 
Code should be presented in mono-spaced text, usually boxed, as shown below.  Input text will be on a pale yellow background.  For output text, the background colour will be violet-grey.   
  
 +
<!--T:16-->
 
* Code, whether single lines or blocks, use templates to ensure consistency
 
* Code, whether single lines or blocks, use templates to ensure consistency
  
 +
<!--T:17-->
 
* Use the  Input template like this: {{Input|1=<nowiki>{{Input|1=<nowiki>
 
* Use the  Input template like this: {{Input|1=<nowiki>{{Input|1=<nowiki>
 
qdbus org.kde.NepomukServer /nepomukserver org.kde.NepomukServer.quit
 
qdbus org.kde.NepomukServer /nepomukserver org.kde.NepomukServer.quit
Line 57: Line 70:
  
  
 +
<!--T:18-->
 
* Output works the same way: {{Output|1=<nowiki>{{Output|1=<nowiki>terminal output  
 
* Output works the same way: {{Output|1=<nowiki>{{Output|1=<nowiki>terminal output  
 
is also shown as code,  
 
is also shown as code,  
Line 63: Line 77:
 
but on a grey background</nowiki>}}
 
but on a grey background</nowiki>}}
  
 +
<!--T:19-->
 
{{Note|1=Note the use of <code><nowiki>1=<nowiki> some text &lt;/nowiki></nowiki></code> to avoid situations that break the display format}}
 
{{Note|1=Note the use of <code><nowiki>1=<nowiki> some text &lt;/nowiki></nowiki></code> to avoid situations that break the display format}}
  
 +
<!--T:20-->
 
* Starting an Input or Output template on a new line will break the display format if it is within lists.  Simply continue on the same line if you need to correct this.
 
* Starting an Input or Output template on a new line will break the display format if it is within lists.  Simply continue on the same line if you need to correct this.
  
 +
<!--T:21-->
 
* You can also combine input/output areas with [http://www.mediawiki.org/wiki/Extension:SyntaxHighlight_GeSHi GeSHi syntaxhiglighting]. An input area like this {{Input|1=<nowiki>{{Input|<syntaxhighlight lang="php" line>
 
* You can also combine input/output areas with [http://www.mediawiki.org/wiki/Extension:SyntaxHighlight_GeSHi GeSHi syntaxhiglighting]. An input area like this {{Input|1=<nowiki>{{Input|<syntaxhighlight lang="php" line>
 
# Initialise common code
 
# Initialise common code
Line 78: Line 95:
 
</syntaxhighlight>}}
 
</syntaxhighlight>}}
  
 +
<!--T:22-->
 
* Single code words can be kept in-line by using {{Input|1=<nowiki><code></code></nowiki>}}  It will <code>display</code> like this.
 
* Single code words can be kept in-line by using {{Input|1=<nowiki><code></code></nowiki>}}  It will <code>display</code> like this.
  
 +
<!--T:23-->
 
* {{Input|1=<nowiki>&lt;tt> &lt;/tt></nowiki>}} is useful for displaying filenames and paths.  This looks like this: <tt>  a/path/to/here </tt>
 
* {{Input|1=<nowiki>&lt;tt> &lt;/tt></nowiki>}} is useful for displaying filenames and paths.  This looks like this: <tt>  a/path/to/here </tt>
  
== Block Quotes ==  
+
== Block Quotes == <!--T:24-->
  
 +
<!--T:25-->
 
The tags <nowiki><blockquote></nowiki> and <nowiki></blockquote></nowiki> should be used when quoting other works or other pages.  This produces a proportional italic font, with some padding.
 
The tags <nowiki><blockquote></nowiki> and <nowiki></blockquote></nowiki> should be used when quoting other works or other pages.  This produces a proportional italic font, with some padding.
  
 +
<!--T:26-->
 
<blockquote>Here is an example of the display that you get by using the blockquote tags.</blockquote>
 
<blockquote>Here is an example of the display that you get by using the blockquote tags.</blockquote>
  
== Text in Section Headers ==  
+
== Text in Section Headers == <!--T:27-->
  
 +
<!--T:28-->
 
Even though the criteria above may be met, do not use Bold text in section headers or in links.
 
Even though the criteria above may be met, do not use Bold text in section headers or in links.
  
== Text in Information, Note, Tip or Warning Templates ==  
+
== Text in Information, Note, Tip or Warning Templates == <!--T:29-->
  
 +
<!--T:30-->
 
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 ==  
+
== Lists == <!--T:31-->
  
 +
<!--T:32-->
 
You can have various kinds of lists in your pages &mdash; bulleted, numbered or itemized. Find details on the [[Special:myLanguage/Toolbox#Bulleted Lists|Toolbox]] page.
 
You can have various kinds of lists in your pages &mdash; bulleted, numbered or itemized. Find details on the [[Special:myLanguage/Toolbox#Bulleted Lists|Toolbox]] page.
  
== Keeping things together ==  
+
== Keeping things together == <!--T:33-->
  
 +
<!--T:34-->
 
After your text is written some markup is automatically added by the translation system. This means that whenever it sees a blank line, it starts a new unit. When your text is presented to translators, they typically see it one unit at a time, so it is important not to leave a blank lines in the middle of something that should be treated as a unit. Normally an entire paragraph should be kept in a single unit; and under no circumstance should a sentence be split between units!
 
After your text is written some markup is automatically added by the translation system. This means that whenever it sees a blank line, it starts a new unit. When your text is presented to translators, they typically see it one unit at a time, so it is important not to leave a blank lines in the middle of something that should be treated as a unit. Normally an entire paragraph should be kept in a single unit; and under no circumstance should a sentence be split between units!
  
 +
<!--T:35-->
 
If you need a linebreak in the middle of a section, the preferred way to achieve this is without breaking units is to use <nowiki><br /></nowiki> at the end of the line where you want to break to occur (not on a new line). If you need space between the lines add <nowiki><br /><br /></nowiki>.
 
If you need a linebreak in the middle of a section, the preferred way to achieve this is without breaking units is to use <nowiki><br /></nowiki> at the end of the line where you want to break to occur (not on a new line). If you need space between the lines add <nowiki><br /><br /></nowiki>.
  
== Unbalanced brackets ==  
+
== Unbalanced brackets == <!--T:36-->
  
 +
<!--T:37-->
 
<!--}}-->The translation system marks any translated unit as incompletely translated if it contains any kind of unbalanced brackets. If you need to have unbalanced brackets in your text, please add a balancing bracket in a comment tag, like this:<br />
 
<!--}}-->The translation system marks any translated unit as incompletely translated if it contains any kind of unbalanced brackets. If you need to have unbalanced brackets in your text, please add a balancing bracket in a comment tag, like this:<br />
 
{{Input|1=
 
{{Input|1=
 
<nowiki><!-- }} -->{{ A line  
 
<nowiki><!-- }} -->{{ A line  
  
 +
<!--T:38-->
 
Another line}}<!-- {{ --></nowiki>
 
Another line}}<!-- {{ --></nowiki>
 
}}<!--{{-->
 
}}<!--{{-->
 
This goes for all kinds of brackets, even ordinary parentheses. (Of course it is normally better to avoid blank lines within a mark up unit - see [[Special:myLanguage/Typographical_Guidelines#Keeping_things_together|Keeping things together]].)
 
This goes for all kinds of brackets, even ordinary parentheses. (Of course it is normally better to avoid blank lines within a mark up unit - see [[Special:myLanguage/Typographical_Guidelines#Keeping_things_together|Keeping things together]].)
  
== Special Tags ==  
+
== Special Tags == <!--T:39-->
  
 +
<!--T:40-->
 
* <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. <keycap>Ctrl + Alt + F1</keycap> to launch a virtual terminal. (Note that "(space)+(space)" 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. <keycap>Ctrl + Alt + F1</keycap> to launch a virtual terminal. (Note that "(space)+(space)" is used to link keys to be pressed concurrently).
Line 123: Line 152:
 
* In general, if the user needs to choose an element, even if it is not in a menu, the <nowiki><menuchoice></menuchoiсe></nowiki> markup should be used.
 
* In general, if the user needs to choose an element, even if it is not in a menu, the <nowiki><menuchoice></menuchoiсe></nowiki> markup should be used.
  
== The Problematic Pipe Symbol ==
+
== The Problematic Pipe Symbol == <!--T:41-->
  
In some situations the pipe symbol cannot be used - for instance when giving parameters in a template - as it has a system meaning.  In such cases please use <nowiki>{{Pipe}}</nowiki>
+
<!--T:42-->
 +
In some situations the pipe symbol cannot be used - for instance when giving parameters in a template - as it has a system meaning.  In such cases please use <nowiki>{{!}}</nowiki>.  For example, if you want to display a command line containing the pipe character using the <nowiki>{{Input|...}}</nowiki> template, the simplest way to do it is this: <code><nowiki>{{Input|1=cmd1 {{!}} cmd2}}</nowiki></code> which displays {{Input|1=cmd1 {{!}} cmd2}}
  
== Translatable Content ==
+
<!--T:46-->
 +
<br />If you just write <code><nowiki>{{Input|1=cmd1 | cmd2}}</nowiki></code> you get instead {{Input|1=cmd1 | cmd2}}
 +
the problem being, that <code>cmd2</code> is seen as a second parameter to the template, which in this case is not used.
  
 +
<!--T:47-->
 +
In many cases, you can also enclose the text containing the pipe character between <nowiki><nowiki>...</nowiki> </nowiki> tags, like this <code><nowiki>{{Input|1=<nowiki>cmd1 | cmd2</nowiki></nowiki><nowiki>}}</nowiki></code>, which also displays {{Input|1=<nowiki>cmd1 | cmd2</nowiki>}}
 +
 +
== Translatable Content == <!--T:43-->
 +
 +
<!--T:44-->
 
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 use localised versions of the images to explain a point.  The rule of thumb is "If in doubt, include it!".
 
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 use localised versions of the images to explain a point.  The rule of thumb is "If in doubt, include it!".
  
  
 +
<!--T:45-->
 
[[Category:Translator_Help]]
 
[[Category:Translator_Help]]
 
</translate>
 
</translate>

Revision as of 10:04, 27 August 2011

Other languages:Czech 6% • ‎English 100% • ‎Finnish 99% • ‎Italian 52% • ‎Dutch 2% • ‎Brazilian Portuguese 100% • ‎Chinese (China) 4%

There is a separate pages explaining general syntax with example code.

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

Contents

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.
Ktip.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, usually 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
  • Use the Input template like this:
    {{Input|1=<nowiki>
    qdbus org.kde.NepomukServer /nepomukserver org.kde.NepomukServer.quit
    rm -r ~/.kde/share/apps/nepomuk
    rm -r ~/.kde4/share/apps/nepomuk
    nepomukserver</nowiki>}}
    This will display like this:
    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:
    {{Output|1=<nowiki>terminal output 
    is also shown as code, 
    but on a grey background</nowiki>}}
    which displays as
    terminal output 
    is also shown as code, 
    but on a grey background
noframe
 
Note
Note the use of 1=<nowiki> some text </nowiki> to avoid situations that break the display format
  • Starting an Input or Output template on a new line will break the display format if it is within lists. Simply continue on the same line if you need to correct this.
  • You can also combine input/output areas with GeSHi syntaxhiglighting. An input area like this
    {{Input|<syntaxhighlight lang="php" line>
    # Initialise common code
    $preIP = dirname( __FILE__ );
    require_once( "$preIP/includes/WebStart.php" );
    </syntaxhighlight>}}
    will result in
    1. # Initialise common code
    2. $preIP = dirname( __FILE__ );
    3. require_once( "$preIP/includes/WebStart.php" );
  • Single code words can be kept in-line by using
    <code></code>
    It will display like this.
  • <tt> </tt>
    is useful for displaying filenames and paths. This looks like this: a/path/to/here

Block Quotes

The tags <blockquote> and </blockquote> should be used when quoting other works or other pages. This produces a proportional italic font, with some padding.

Here is an example of the display that you get by using the blockquote tags.

Text in Section Headers

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

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

You can have various kinds of lists in your pages — bulleted, numbered or itemized. Find details on the Toolbox page.

Keeping things together

After your text is written some markup is automatically added by the translation system. This means that whenever it sees a blank line, it starts a new unit. When your text is presented to translators, they typically see it one unit at a time, so it is important not to leave a blank lines in the middle of something that should be treated as a unit. Normally an entire paragraph should be kept in a single unit; and under no circumstance should a sentence be split between units!

If you need a linebreak in the middle of a section, the preferred way to achieve this is without breaking units is to use <br /> at the end of the line where you want to break to occur (not on a new line). If you need space between the lines add <br /><br />.

Unbalanced brackets

The translation system marks any translated unit as incompletely translated if it contains any kind of unbalanced brackets. If you need to have unbalanced brackets in your text, please add a balancing bracket in a comment tag, like this:

<!-- }} -->{{ A line 

Another line}}<!-- {{ -->

This goes for all kinds of brackets, even ordinary parentheses. (Of course it is normally better to avoid blank lines within a mark up unit - see Keeping things together.)

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 "(space)+(space)" 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
  • In general, if the user needs to choose an element, even if it is not in a menu, the <menuchoice></menuchoiсe> markup should be used.

The Problematic Pipe Symbol

In some situations the pipe symbol cannot be used - for instance when giving parameters in a template - as it has a system meaning. In such cases please use {{!}}. For example, if you want to display a command line containing the pipe character using the {{Input|...}} template, the simplest way to do it is this: {{Input|1=cmd1 {{!}} cmd2}} which displays
cmd1 | cmd2

If you just write {{Input|1=cmd1 | cmd2}} you get instead
 cmd2

the problem being, that cmd2 is seen as a second parameter to the template, which in this case is not used.

In many cases, you can also enclose the text containing the pipe character between <nowiki>... </nowiki> tags, like this {{Input|1=<nowiki>cmd1 | cmd2</nowiki>}}, which also displays
cmd1 | cmd2

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 use localised versions of the images to explain a point. The rule of thumb is "If in doubt, include it!".


KDE® and the K Desktop Environment® logo are registered trademarks of KDE e.V.Legal