Jump to: navigation, search

Information about the group Translation of the wiki page Typographical Guidelines.
Typographical GuidelinesCurrent message text
...Guidelines/Page display title/nlTypografische richtlijnen
...ns:Typographical Guidelines/1/nl''There is a separate pages explaining [[Special:myLanguage/Toolbox|general syntax]] with example code.''
...ns:Typographical Guidelines/2/nlAdhering to these typographic guidelines will ensure that your documentation can be accurately and easily exported for translation purposes.
...ns:Typographical Guidelines/3/nl== Bold Text ==
...ns:Typographical Guidelines/4/nlUse bold text to highlight
* Window titles
* Common labels that are not user-configurable
* Icon captions
* Program names
...ns:Typographical Guidelines/5/nlFor example:
...ns:Typographical Guidelines/6/nl* Highlighting a selection of text will copy it to '''Klipper'''.
...ns:Typographical Guidelines/7/nl== Italic Text ==
...ns:Typographical Guidelines/8/nlUse italic text to emphasise 
* Words or phrases as in general writing.
* Titles when referencing other works.
* The first use of an unfamiliar word.
...ns:Typographical Guidelines/9/nlSome examples:
* ''Save your work at this point.''
* Details can be found in ''Samba 3 by Example''....
* KDE Manuals are in ''Docbook'' format.
...s:Typographical Guidelines/10/nl{{Tip|1=''Programs'' are launched by users, ''components'' are used by programs}}
...s:Typographical Guidelines/11/nl== Combined Bold and Italic Text ==
...s:Typographical Guidelines/12/nlUse this combination for replaceable or variable text.
...s:Typographical Guidelines/13/nlSome examples:
* To connect to your remote server, type <code>ssh</code> '''''''''' in '''Konsole'''.
* In rpm-based distributions, the command <code>rpm -q</code> '''''packagename''''' will result in '''''package-version-release'''''.
...s:Typographical Guidelines/14/nl== Mono-spaced Text ==
...s:Typographical Guidelines/15/nlCode 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.
...s:Typographical Guidelines/16/nl* Code, whether single lines or blocks, use templates to ensure consistency
...s:Typographical Guidelines/17/nl* Use the  Input template like this: {{Input|1=<nowiki>{{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&lt;/nowiki>}}</nowiki>}} This will display 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
...s:Typographical Guidelines/18/nl* Output works the same way: {{Output|1=<nowiki>{{Output|1=<nowiki>terminal output 
is also shown as code, 
but on a grey background&lt;/nowiki>}}</nowiki>}} which displays as {{Output|1=<nowiki>terminal output 
is also shown as code, 
but on a grey background</nowiki>}}
...s:Typographical Guidelines/19/nl{{Note|1=Note the use of <code><nowiki>1=<nowiki> some text &lt;/nowiki></nowiki></code> to avoid situations that break the display format}}
...s:Typographical Guidelines/20/nl* 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.
...s:Typographical Guidelines/21/nl* You can also combine input/output areas with [ GeSHi syntaxhiglighting]. An input area like this {{Input|1=<nowiki>{{Input|<syntaxhighlight lang="php" line>
# Initialise common code
$preIP = dirname( __FILE__ );
require_once( "$preIP/includes/WebStart.php" );
}} will result in {{Input|<syntaxhighlight lang="php" line>
# Initialise common code
$preIP = dirname( __FILE__ );
require_once( "$preIP/includes/WebStart.php" );
...s:Typographical Guidelines/22/nl* Single code words can be kept in-line by using {{Input|1=<nowiki><code></code></nowiki>}}  It will <code>display</code> like this.
...s:Typographical Guidelines/23/nl* {{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>
...s:Typographical Guidelines/24/nl== Block Quotes ==
...s:Typographical Guidelines/25/nlThe 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.
...s:Typographical Guidelines/26/nl<blockquote>Here is an example of the display that you get by using the blockquote tags.</blockquote>
...s:Typographical Guidelines/27/nl== Text in Section Headers ==
...s:Typographical Guidelines/28/nlEven though the criteria above may be met, do not use Bold text in section headers or in links.
...s:Typographical Guidelines/29/nl== Text in Information, Note, Tip or Warning Templates ==
...s:Typographical Guidelines/30/nlBold text should be avoided in the text within these templates.  Italic text for emphasis may still be used - use sparingly for maximum effect.
...s:Typographical Guidelines/31/nl== Lists ==
...s:Typographical Guidelines/32/nlYou 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.
...s:Typographical Guidelines/33/nl== Keeping things together ==
...s:Typographical Guidelines/34/nlAfter 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!
...s:Typographical Guidelines/35/nlIf 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>.
...s:Typographical Guidelines/36/nl== Unbalanced brackets ==
...s:Typographical Guidelines/37/nl<!--}}-->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 />
<nowiki><!-- }} -->{{ A line
...s:Typographical Guidelines/38/nlAnother 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]].)
...s:Typographical Guidelines/39/nl== Special Tags ==
...s:Typographical Guidelines/40/nl* <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).
* Sequences of menu choices should use <nowiki> <menuchoice> </nowiki>and <nowiki> </menuchoice> </nowiki> for example <menuchoice> View -> Message List -> Aggregation -> Standard Mailing List </menuchoice>
* 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.
...s:Typographical Guidelines/41/nl== The Problematic Pipe Symbol ==
...s:Typographical Guidelines/42/nlIn 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}}
...s:Typographical Guidelines/46/nl<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.
...s:Typographical Guidelines/47/nlIn 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>}}
...s:Typographical Guidelines/43/nl== Translatable Content ==
...s:Typographical Guidelines/44/nlEverything that is translatable is contained within <nowiki>&lt;translate> and &lt;/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!".
...s:Typographical Guidelines/45/nl[[Category:Translator_Help]]
NavigationShowing 48 messages.
KDE® and the K Desktop Environment® logo are registered trademarks of KDE e.V.Legal