Difference between revisions of "Typographical Guidelines/fi"

Jump to: navigation, search
(Created page with "== Tekstiä Tiedot-, Huomaa-, Vihje- ja Varoitusmallinteissa ==")
(Created page with "Joitakin esimerkkejä: * ''Tallenna työsi tässä vaiheessa.'' * Lisätiedot voivat löytyä kohteesta ''Samba 3 by Example''.... * KDE-käsikirjat ovat ''Docbook''-muodossa.")
Line 24: Line 24:
 
* The first use of an unfamiliar word.
 
* The first use of an unfamiliar word.
  
Some examples:
+
Joitakin esimerkkejä:
* ''Save your work at this point.''
+
* ''Tallenna työsi tässä vaiheessa.''
* Details can be found in ''Samba 3 by Example''....
+
* Lisätiedot voivat löytyä kohteesta ''Samba 3 by Example''....
* KDE Manuals are in ''Docbook'' format.
+
* KDE-käsikirjat ovat ''Docbook''-muodossa.
  
 
{{Tip|1=''Programs'' are launched by users, ''components'' are used by programs}}
 
{{Tip|1=''Programs'' are launched by users, ''components'' are used by programs}}

Revision as of 18:16, 21 August 2011

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

Erilliset sivut selittävät esimerkkikoodin yleistä syntaksia.

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

Contents

Lihavoitu teksti

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.

Kursivoitu teksti

Use italic text to emphasise

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

Joitakin esimerkkejä:

  • Tallenna työsi tässä vaiheessa.
  • Lisätiedot voivat löytyä kohteesta Samba 3 by Example....
  • KDE-käsikirjat ovat Docbook-muodossa.
Ktip.png
 
Tip
Programs are launched by users, components are used by programs


Yhdistetty lihavoitu ja kursivoitu teksti

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.

Tasavälinen teksti

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

Lohkolainaukset

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.

Teksti kappaleotsakkeissa

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

Tekstiä Tiedot-, Huomaa-, Vihje- ja Varoitusmallinteissa

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

Luettelot

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

Asioiden pitäminen yhdessä

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

Parittomat sulkeet

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

Erikoistunnisteet

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

Pulmallinen putkisymboli

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 {{!}} cnd2}} which displays
cmd1 | cnd2

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

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

Kotoistettava sisältö

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