Typographical Guidelines/fi: Difference between revisions

    From KDE TechBase
    (Created page with "* {{Input|3=Syöte|<nowiki><tt> </tt></nowiki>}} on hyödyllinen näytettäessä tiedostonimiä ja polkuja. Se näyttää tältä: <tt> a/path/to/here </tt>")
    (Updating to match new version of source page)
     
    (23 intermediate revisions by 5 users not shown)
    Line 1: Line 1:
    #REDIRECT [[Userbase:Special:myLanguage/Typographical Guidelines]]
    <languages />
    <languages />


    ''Erilliset sivut selittävät esimerkkikoodin [[Special:myLanguage/Toolbox|yleistä syntaksia]].''
     
    {{Warning|This page is a duplicate of https://userbase.kde.org/Typographical_Guidelines  and its contents will be progressively merged to userbase. Please do no longer update here. }}
     
    ''There is a separate pages explaining [[Special:myLanguage/Toolbox|general syntax]] with example code.''


    Näiden typograafisten ohjeiden noudattaminen takaa, että dokumentaatiosi  voi olla tarkka ja helposti vietävä kotoistamistarkoituksiin.
    Näiden typograafisten ohjeiden noudattaminen takaa, että dokumentaatiosi  voi olla tarkka ja helposti vietävä kotoistamistarkoituksiin.
    Line 29: Line 36:
    * KDE-käsikirjat ovat ''Docbook''-muodossa.
    * KDE-käsikirjat ovat ''Docbook''-muodossa.


    {{Tip|3=Vihje|Käyttäjä käynnistää ''Ohjelmat'', ohjelmat käynnistävät 'komponentit''}}
    {{Tip|2=Vihje|Käyttäjä käynnistää ''Ohjelmat'', ohjelmat käynnistävät 'komponentit''}}


    == Yhdistetty lihavoitu ja kursivoitu teksti ==  
    == Yhdistetty lihavoitu ja kursivoitu teksti ==  
    Line 62: Line 69:
    mutta harmaalla taustalla</nowiki>}}
    mutta harmaalla taustalla</nowiki>}}


    {{Note|3=Huomaa|Huomaa <code><nowiki>3=Kotoistettu teksti|<nowiki>-käyttö joissakin teksteissä &lt;/nowiki></nowiki></code> sellaisten tilanteiden välttämiseksi, jotka rikkovat näyttömuodon}}
    {{Note|2=Huomaa|Huomaa <code><nowiki>3=Kotoistettu teksti|<nowiki>-käyttö joissakin teksteissä &lt;/nowiki></nowiki></code> 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ä.
    * 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ä.
    Line 83: Line 90:
    == Lohkolainaukset ==  
    == Lohkolainaukset ==  


    The tags <nowiki><blockquote></nowiki> and <nowiki></blockquote></nowiki> should be used when quoting other works or other pagesThis produces a proportional italic font, with some padding.
    Tageja <nowiki><blockquote></nowiki> ja <nowiki></blockquote></nowiki> pitäisi käyttää, kun lainataan muiden töitä tai muita sivujaTämä tuottaa tasasuhteisen kursiivifontin, joka sisältää täytemerkkejä.


    <blockquote>Here is an example of the display that you get by using the blockquote tags.</blockquote>
    <blockquote>Tässä on näyttöesimerkki, jonka saat käyttämällä lohkolainaustageja.</blockquote>


    == Teksti kappaleotsakkeissa ==  
    == Teksti kappaleotsakkeissa ==  


    Even though the criteria above may be met, do not use Bold text in section headers or in links.
    Vaikka yllä olevat kriteerit saattoivat täyttyä, älä käytä vahvistettua tekstiä kappaleotsakkeissa tai linkeissä.


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


    Bold text should be avoided in the text within these templatesItalic text for emphasis may still be used - use sparingly for maximum effect.
    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 ==  
    == Luettelot ==  


    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.
    Voit käyttää erilaisia luetteloja sivuillasi &mdash; etumerkillisiä, numeroituja tai alkioituja. Lisätietoja löytyy [[Special:myLanguage/Toolbox#Bulleted Lists|Työkalupakki]]-sivulta.


    == Asioiden pitäminen yhdessä ==  
    == 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!
    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!


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


    == Parittomat sulkeet ==  
    == 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:<br />
    <!--}}-->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:<br />
    {{Input|1=
    {{Input|3=Syöte|
    <nowiki><!-- }} -->{{ A line
    <nowiki><!-- }} -->{{ Rivi


    Another line}}<!-- {{ --></nowiki>
    Tonen rivi}}<!-- {{ --></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]].)
    Tämä koskee kaiken tyyppisiä sulkeita, jopa tavallisia kaarisulkeita. (Tietysti on tavallisesti parempi välttää tyhjiä rivejä markup-yksikön sisällä - katso [[Special:myLanguage/Typographical_Guidelines#Keeping_things_together|Asioiden pitäminen yhdessä]].)


    == 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 ==


    In some situations the pipe symbol cannot be used - for instance when giving parameters in a template - as it has a system meaningIn 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 {{!}} cnd2}}</nowiki></code> which displays {{Input|1=cmd1 {{!}} cnd2}}
    Joissakin tilanteissa putkisymbolia ei voida käyttää - esimerkiksi annettaessa parametreja mallinteessa - koska sillä on järjestelmämerkitysSellaisissa tapauksissa käytä <nowiki>{{!}}</nowiki>.  Esimerkiksi, jos haluat näyttää komentorivin, joka sisältää putkimerkin käyttäen <nowiki>{{Input|...}}</nowiki>-mallinnetta, yksinkertaisin tapa tehdä se on: <code><nowiki>{{Input|1=cmd1 {{!}} cmd2}}</nowiki></code> mikä näyttää {{Input|1=cmd1 {{!}} cmd2}}


    <br />If you just write <code><nowiki>{{Input|1=cmd1 | cnd2}}</nowiki></code> you get instead {{Input|1=cmd1 | cnd2}}
    <br />Jos vain kirjoitat <code><nowiki>{{Input|1=cmd1 | cmd2}}</nowiki></code> saat sen sijaan {{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.
    jossa pulmana on, että <code>cmd2</code> nähdään mallinteen toisena parametrina, mitä ei tässä tapauksessa käytetä.


    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>}}
    Monissa tapauksissa voit myös sulkea putkimerkin sisältävän merkin tagien <nowiki><nowiki>...</nowiki> </nowiki> väliin, kuten tämä <code><nowiki>{{Input|1=<nowiki>cmd1 | cmd2</nowiki></nowiki><nowiki>}}</nowiki></code>, joka myös näyttää {{Input|1=<nowiki>cmd1 | cmd2</nowiki>}}


    == Kotoistettava sisältö ==  
    == Kotoistettava sisältö ==  


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




    [[Category:Translator_Help]]
    [[Category:Translator_Help]]

    Latest revision as of 15:00, 21 May 2019


    Warning
    This page is a duplicate of https://userbase.kde.org/Typographical_Guidelines and its contents will be progressively merged to userbase. Please do no longer update here.


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

    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.
    Vihje
    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
    Huomaa
    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

    Joissakin tilanteissa putkisymbolia ei voida käyttää - esimerkiksi annettaessa parametreja mallinteessa - koska sillä on järjestelmämerkitys. Sellaisissa tapauksissa käytä {{!}}. Esimerkiksi, jos haluat näyttää komentorivin, joka sisältää putkimerkin käyttäen {{Input|...}}-mallinnetta, yksinkertaisin tapa tehdä se on: {{Input|1=cmd1 {{!}} cmd2}} mikä näyttää

    cmd1 | cmd2


    Jos vain kirjoitat {{Input|1=cmd1 | cmd2}} saat sen sijaan

     cmd2

    ,

    jossa pulmana on, että cmd2 nähdään mallinteen toisena parametrina, mitä ei tässä tapauksessa käytetä.

    Monissa tapauksissa voit myös sulkea putkimerkin sisältävän merkin tagien <nowiki>... </nowiki> väliin, kuten tämä {{Input|1=<nowiki>cmd1 | cmd2</nowiki>}}, joka myös näyttää

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