Typographical Guidelines/fi: Difference between revisions

    From KDE TechBase
    (Created page with "Tonen rivi}}<!-- {{ --></nowiki> }}<!--{{--> Tämä koskee kaiken tyyppisiä sulkeita, jopa tavallisia kaarisulkeita. (Tietysti on tavallisesti parempi välttää tyhjiä rivejä...")
    (Created page with "* <nowiki> <keycap></nowiki> ja <nowiki> </keycap> </nowiki> tarkoittaa (näppäimistön) näppäinnimiä, esim.: <keycap>Enter</keycap> * <nowiki><keycap></keycap></nowiki> void...")
    Line 117: Line 117:
    == Erikoistunnisteet ==  
    == Erikoistunnisteet ==  


    * <nowiki> <keycap></nowiki> and <nowiki> </keycap> </nowiki> denote (keyboard) key names e.g. <keycap>Enter</keycap>
    * <nowiki> <keycap></nowiki> ja <nowiki> </keycap> </nowiki> tarkoittaa (näppäimistön) näppäinnimiä, esim.: <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> voidaan myös käyttää samanaikaisesti käytettävän näppäinryhmän ympärillä, esim.: <keycap>Ctrl + Alt + F1</keycap> virtuaalipääteikkunan käynnistämiseksi. (Huomaa, että "(space)+(space)" käytetään linkittämään näppäimet, joita painetaa samanaikaisesti).
    * Sequences of menu choices should use <nowiki> <menuchoice> </nowiki>and <nowiki> </menuchoice> </nowiki> for example <menuchoice> View -> Message List -> Aggregation -> Standard Mailing List </menuchoice>
    * Valikkovalintojen sarjojen pitäisi käyttää <nowiki> <menuchoice> </nowiki> ja <nowiki> </menuchoice> </nowiki> esimerkiksi <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.
    * Yleensä, jos käyttäjän on valittava elementti, vaikkakin se ei ole valikko, <nowiki><menuchoice></menuchoiсe></nowiki> -markup-merkintää pitäisi käyttää.


    == Pulmallinen putkisymboli ==
    == Pulmallinen putkisymboli ==

    Revision as of 07:47, 27 August 2011

    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

    Tageja <blockquote> ja </blockquote> pitäisi käyttää, kun lainataan muiden töitä tai muita sivuja. Tämä tuottaa tasasuhteisen kursiivifontin, joka sisältää täytemerkkejä.

    Tässä on näyttöesimerkki, jonka saat käyttämällä lohkolainaustageja.

    Teksti kappaleotsakkeissa

    Vaikka yllä olevat kriteerit saattoivat täyttyä, älä käytä vahvistettua tekstiä kappaleotsakkeissa tai linkeissä.

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

    Vahvennettua tekstiä pitäisi välttää näiden mallinteiden sisäisessä tekstissä. Painottamiseen voidaan yhä käyttää kursiivia tekstiä - käytä sitä säästeliäästi vaikutuksen maksimoimiseksi.

    Luettelot

    Voit käyttää erilaisia luetteloja sivuillasi — etumerkillisiä, numeroituja tai alkioituja. Lisätietoja löytyy Työkalupakki-sivulta.

    Asioiden pitäminen yhdessä

    Tekstin kirjoittamisen jälkeen jotain markup-merkkejä lisätään automaattisesti kotoistamisjärjestelmään. Tämä tarkoittaa, että milloin näet tyhjän rivin, se aloittaa uuden yksikön. Kun teksti esitellään kotoistajille, he näkevät sen tyypillisesti yksi yksikkö kerrallaan, joten on tärkeää olla jättämättä tyhjiä rivejä keskelle sellaista tekstiä, jota tulisi käsitellä yhtenä yksikkönä. Normaalisti koko kappale pitäisi pitää yhdessä yksikössä; ja missään oloissa lausetta ei pitäisi jakaa kahteen yksikköön!

    Jos tarvitset rivinvaihdon kesken kappaletta, suositeltavampi tapa saavuttaa se rikkomatta kappaletta on käyttää <br /> sen rivin lopussa, jossa haluat rivinvaihdon tapahtuvan (ei uuden rivin alussa). Jos tarvitse tilaa rivien väliin, lisää <br /><br />.

    Parittomat sulkeet

    Kotoistamisjärjestelmä merkitsee jokaisen kotoistetun yksikön kotoistamattomaksi, jos se sisältää minkään tyyppisiä parittomia sulkumerkkejä. Jos tarvitset parittomia sulkumerkkejä tekstissäsi, lisää parillinen sulkumerkki kommenttitagiin, kuten tämä, like this:

    <!-- }} -->{{ Rivi 
    
    Tonen rivi}}<!-- {{ -->
    

    Tämä koskee kaiken tyyppisiä sulkeita, jopa tavallisia kaarisulkeita. (Tietysti on tavallisesti parempi välttää tyhjiä rivejä markup-yksikön sisällä - katso Asioiden pitäminen yhdessä.)

    Erikoistunnisteet

    • <keycap> ja </keycap> tarkoittaa (näppäimistön) näppäinnimiä, esim.: Enter
    • <keycap></keycap> voidaan myös käyttää samanaikaisesti käytettävän näppäinryhmän ympärillä, esim.: Ctrl + Alt + F1 virtuaalipääteikkunan käynnistämiseksi. (Huomaa, että "(space)+(space)" käytetään linkittämään näppäimet, joita painetaa samanaikaisesti).
    • Valikkovalintojen sarjojen pitäisi käyttää <menuchoice> ja </menuchoice> esimerkiksi View -> Message List -> Aggregation -> Standard Mailing List
    • Yleensä, jos käyttäjän on valittava elementti, vaikkakin se ei ole valikko, <menuchoice></menuchoiсe> -markup-merkintää pitäisi käyttää.

    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!".