Typograafisia ohjeita

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

Näiden typograafisten ohjeiden noudattaminen takaa, että dokumentaatiosi voi olla tarkka ja helposti vietävä kotoistamistarkoituksiin.

Lihavoitu teksti

Käytä lihavoitua tekstiä korostamiseen

• Ikkunaotsikot
• Yleiset nimiöt, jotka eivät ole käyttäjän asettavissa
• Kuvaketekstit
• Ohjelmanimet

Esimerkiksi:

• Tekstivalinnan korostaminen kopioi sen kohteeseen Klipper.

Kursivoitu teksti

Käytä kursivoitua tekstiä painottamiseen

• Sanoja ja fraaseja yleisessä kirjoituksessa.
• Otsikkoja, jotka viittaavat muihin töihin.
• Epätavallisen sanan ensimmäinen käyttö.

Joitakin esimerkkejä:

• Tallenna työsi tässä vaiheessa.
• Lisätiedot voivat löytyä kohteesta Samba 3 by Example....
• KDE-käsikirjat ovat Docbook-muodossa.

Tip

Käyttäjä käynnistää Ohjelmat, ohjelmat käynnistävät 'komponentit

Yhdistetty lihavoitu ja kursivoitu teksti

Käytä tätä yhdistelmää korvattavaa tai muuttuvaa tekstiä varten.

Joitakin esimerkkejä:

• Etäpalvelimeen yhdistämiseksi kirjoita ssh [email protected] pääteikkunassa Konsole.
• Rpm-perustaisissa jakeluversioissa, komento rpm -q packagename aiheuttaa kohteessa package-version-release.

Tasavälinen teksti

Koodi pitäisi esittää tasavälisenä tekstinä, tavallisesti laatikoituna, kuten näytetään alla. Syötetekstillä on pelkkä keltainen tausta. Tulostetekstille taustaväri on violetinharmaa.

• Käytä koodissa, joko yksittäisrivisessä tai lohkoissa, mallinteita yhtenäisyyden takaamiseksi

• Käytä tämän kaltaista syötemallinnetta:

  {{Input|3=Syöte|<nowiki>
  qdbus org.kde.NepomukServer /nepomukserver org.kde.NepomukServer.quit
  rm -r ~/.kde/share/apps/nepomuk
  rm -r ~/.kde4/share/apps/nepomuk
  nepomukserver</nowiki>}}

  Tämä näyttää tämän kaltaiselta:

  qdbus org.kde.NepomukServer /nepomukserver org.kde.NepomukServer.quit
  rm -r ~/.kde/share/apps/nepomuk
  rm -r ~/.kde4/share/apps/nepomuk
  nepomukserver

• Tuloste toimii samalla tavalla:

  {{Output|3=Tuloste|<nowiki>päätetuloste näytetään 
  myös koodina, 
  mutta harmaalla taustalla</nowiki>}}

  mikä näyttää seuraavana

  päätetuloste näytetään 
  myös koodina, 
  mutta harmaalla taustalla

Note

Huomaa 3=Kotoistettu teksti|<nowiki>-käyttö joissakin teksteissä </nowiki> sellaisten tilanteiden välttämiseksi, jotka rikkovat näyttömuodon

• Syöte- tai tulostemallinteen alkaminen rivinvaihdolla rikkoo näyttömuodon, jos se on luetteloiden sisällä. Jatka vain samalla rivillä, jos sinun täytyy korjata tämä.

• Voit myös yhdistää syöte/tulostealueet GeSHi-syntaksikorostamiseen. Syötealue, kuten tämä

  {{Input|<syntaxhighlight lang="php" rivi>
  # Alusta yhteinen koodi
  $preIP = dirname( __FILE__ );
  require_once( "$preIP/includes/WebStart.php" );
  </syntaxhighlight>}}

antaa tulokseksi

# Alusta yhteinen koodi
$preIP = dirname( __FILE__ );
require_once( "$preIP/includes/WebStart.php" );

• Yksittäiset koodisanat voidaan pitää rivin sisällä käyttäen

  <code></code>

  Se näyttää tämän näköisen koodin.

• <tt> </tt>

  on hyödyllinen näytettäessä tiedostonimiä ja polkuja. Se näyttää tältä: 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!".