Linux.fi:Merkitsemiskäytäntöjä

Linux.fista
Versio hetkellä 22. lokakuuta 2007 kello 19.14 – tehnyt Heikki (keskustelu | muokkaukset) (tt ja kursivointi kuten keskustelusivulla "päätettiin")
Siirry navigaatioon Siirry hakuun

Tässä wikissä pyritään noudattamaan seuraavia käytäntöjä

Komennot

Yleensä selitys ennen komentoa, eli tähän tyyliin:
Tar.gz-paketti puretaan komennolla

tar xvzf paketti.tar.gz

Jos komentoa ei laiteta omalle rivilleen laatikon sisään (eli laittamalla välilyönti rivin alkuun), se voidaan laittaa varsinaisen tekstin sekaan <tt>- ja </tt>-tagien väliin. Esimerkki:
Pura paketti komennolla tar xvzf paketti.tar.gz ja pidä hauskaa.

Kieli

Wikin artikkelit ovat suomeksi. Artikkelit olisi syytä kirjoittaa kirjakielellä käyttäen suomenkielisiä termejä mikäli sellainen on olemassa. Englanninkielisen käännöksen kertominen on tosin joissain tapauksissa järkevää, esimerkiksi voitaisiin kirjoittaa näin: pino (engl. stack). Käännöksiä voi katsoa vaikka sanastosta tai lokalisointi.orgin sanakirjasta.

Artikkelin lisäksi myös otsikon (eli sivun nimen) pitää olla järkevää suomea. Esimerkiksi "Emulaattorit pääsivu" ei sellaista ole.

Luokittelu

Olemassa olevat luokat luokkasivulta. Luokitus helpottaa asioiden löytämistä. Lisää artikkeli vain luokkahierarkian syvimmällä olevaan luokkaan: KDE-ohjelma kuuluu KDE-ohjelmat-luokkaan, ja se on turha lisätä erikseen Ohjelmat-luokkaan.

Linkit

  • Wikin sisäinen linkki [[näin]], jos tarvitsee taivuttaa tai muuten käyttää eri asua, niin [[kohde|otsikko]] esim. [[Screen|Screenin]]
  • Linkki luokkasivulle: [[:Luokka:Luokannimi|Luokan sivulle]]
  • Interwiki, eli linkit wikipediaan: [[wikipedia:fi:Linux|Linux]]
  • Ulkoiset linkit: [http://www.example.com/ Otsikko]
  • Jos linkki on omalla rivillään, lisätään rivin alkuun pallura (*-merkki)

Kappalejako

Osuva kappalejako parantaa artikkelin luettavuutta. Isommissa artikkeleissa kannattaa usein käyttää hierarkkista kappalejakoa, jossa isoimman wikissä käytettävän otsikkotyypin (esim. ==Omaotsikko==) alla on pienempiä alaotsikoita (esim. ===Alaotsikko1===). Vakinaisia kappaleita ovat "Katso myös", jonka alle sijoitetaan wikin sisäisiä linkkejä ja viittauksia paikalliseen dokumentaatioon (esimerkiksi man-sivut) sekä "Aiheesta muualla", jonka alle sijoitetaan ulkoisia linkkejä.

Wikipediassa olevat artikkelit

Mikäli sivun sisältö ei ole mitenkään erikoista, vaan Wikipedian sisältö on riittävä, on turha forkata Wikipedian sisältöä (eikä lisenssikään sitä salli) vaan homma hoidetaan lisäämällä sivulle mallinne perustietoa (eli {{perustietoa}}) ja tämän jälkeen interwikillä linkki Wikipediaan tyyliin [[wikipedia:fi:otsikko]].

Wiki-tyyli

Pyri linkittämään artikkeleita keskenään. Tee jokaisesta termistä, josta löytyy artikkeli, wikilinkki, ja jos on uusia vaikeita juttuja, niin niistäkin. Artikkelien ei pitäisi olla umpikujia, vaan aina kuuluisi olla keino päästä muualle. Pyrkimyksenä on umpikujalistan tyhjentäminen, ja tyhjänä pitäminen.

Kuvat

Pyri suosimaan png-tiedostomuotoa kuvakaappauksissa, se kun on häviötön ja pakkaa varsinkin paljon tasaisia väripintoja sisältävät kuvat ihan nätisti. Poikkeuksena valokuvia sisältävät ja peleistä otetut kuvakaappaukset, niissä on monesti niin paljon värejä, että png-tiedostosta tulee järjettömän iso. Näissä tapauksissa on syytä suosia jpg:tä.

Jakelut ja ohjelmat

Jakeluiden kanssa pyritään käyttämään mallinetta Jakelu. Lisätietoja sivulla Linux.fi:Merkitsemiskäytäntöjä/Jakelut.

Ohjelmien kanssa pyritään käyttämään mallinetta Ohjelma. Lisätietoja sivulla Linux.fi:Merkitsemiskäytäntöjä/Ohjelmat.

Ohjelmia EI pidä laittaa luokkaan Ohjelmat vaan johonkin kuvaavampaan alaluokkaan.

Muotoilu (<tt> ja kursivointi)

Yleisesti ottaen ohjelmapakettien nimet, tiedostonimet ja komennot (tekstin seassa) merkitään <tt> ja </tt>-tagien väliin. Kursiivilla (''kursivointi'') merkitään valikkotekstit ja käännökset, esimerkiksi:
"Asenna paketti (eng. package) gcc valitsemalla Sovellukset - Lisää/Poista sovelluksia."

Yhteenveto

Muokattaessa on kohteliasta kirjoitaa Yhteenveto-ruutuun jonkunlainen kommentti tehdyistä muutoksista. Tämä helpottaa muutosten erottamista toisistaan. Mikäli muutoksesi ei ole kovin monen merkin laajuinen, rastita "Tämä on pieni muutos" -ruutu.