4 175
muokkausta
Ero sivun ”Linux.fi:Merkitsemiskäytäntöjä” versioiden välillä
Siirry navigaatioon
Siirry hakuun
Linux.fi:Merkitsemiskäytäntöjä (muokkaa)
Versio 15. maaliskuuta 2008 kello 21.22
, 15. maaliskuuta 2008pientä viilailua
p (vielä irc) |
(pientä viilailua) |
||
| Rivi 1: | Rivi 1: | ||
Tässä wikissä | Tässä wikissä noudatetaan pääasiassa seuraavia käytäntöjä yhtenäisen tyylin säilyttämiseksi, luettavuuden parantamiseksi ja turhan työn estämiseksi. | ||
== | == Yleisiä periaatteita == | ||
'''Tee yhteistyötä!''' Ennen kuin teet isompia muutoksia esimerkiksi luokkarakenteeseen, keskustele asiasta jollakin keskustelusivulla tai [[Linux.fi:Kahvihuone|kahvihuoneessa]]. Mikäli mahdollista, tule myös [[Linux.fi:IRC|IRC-kanavalle]] keskustelemaan ennen suurempia muokkausoperaatioita. | |||
==Komennot== | Huomioi, että Linux.fi ei liity mitenkään Wikimedian projekteihin (Wikipedia, Wiktionary, Wikiquote, yms.), vaan on kokonaan erillinen sivusto, jolla on omat sääntönsä ja käytäntönsä. Isompien muutosten perustelu vain sillä, että niin tehdään esimerkiksi Wikipediassa, ei käy. Wikipediasta voidaan toki ottaa mallia toimiviksi havaituissa asioissa. | ||
Näiden käytäntöjen tarkoitus ei ole hankaloittaa muokkaamista. Jos joku ei ole vielä tutustunut kaikkiin merkitsemiskäytäntöihin yksityiskohtaisesti ja tekee jotain pieniä virheitä, tulee ne korjata ja ystävällisesti huomauttaa asiasta kyseiselle käyttäjälle. | |||
Nämä käytännöt eivät myöskään ole aivan ehdottomia, ja niistä voidaan tarvittaessa poiketa. | |||
== Tyyliseikat == | |||
=== 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 [[Sanasto|sanastosta]] tai lokalisointi.orgin [http://www.lokalisointi.org/sanakirja/ sanakirjasta]. | |||
Artikkelin lisäksi myös otsikon (eli sivun nimen) pitää olla järkevää suomea. Esimerkiksi "Emulaattorit pääsivu" ei sellaista ole. | |||
=== Komennot === | |||
Yleensä selitys ennen komentoa, eli tähän tyyliin:<br> | Yleensä selitys ennen komentoa, eli tähän tyyliin:<br> | ||
Tar.gz-paketti puretaan komennolla | Tar.gz-paketti puretaan komennolla | ||
| Rivi 11: | Rivi 24: | ||
Pura paketti komennolla <tt>tar xvzf paketti.tar.gz</tt> ja pidä hauskaa. | Pura paketti komennolla <tt>tar xvzf paketti.tar.gz</tt> ja pidä hauskaa. | ||
== | === Luokittelu === | ||
== | |||
Olemassa olevat luokat [[Luokat|luokkasivulta.]] Luokitus helpottaa asioiden löytämistä. Lisää artikkeli vain luokkahierarkian syvimmällä olevaan luokkaan: KDE-ohjelma kuuluu [[:Luokka:KDE-ohjelmat|KDE-ohjelmat]]-luokkaan, ja se on turha lisätä erikseen [[:Luokka:Ohjelmat|Ohjelmat-luokkaan]]. | Olemassa olevat luokat [[Luokat|luokkasivulta.]] Luokitus helpottaa asioiden löytämistä. Lisää artikkeli vain luokkahierarkian syvimmällä olevaan luokkaan: KDE-ohjelma kuuluu [[:Luokka:KDE-ohjelmat|KDE-ohjelmat]]-luokkaan, ja se on turha lisätä erikseen [[:Luokka:Ohjelmat|Ohjelmat-luokkaan]]. | ||
==Mallineet== | === Mallineet === | ||
Jos koet tarpeelliseksi lisätä saman sisällön useammalle sivulle, tee siitä malline. Jos joku luokittelu kulkee käsi kädessä jonkun mallineen kanssa, laita luokkalinkki mallineeseen, niin sitäkään ei tarvitse erikseen lisätä moneen paikkaan. | Jos koet tarpeelliseksi lisätä saman sisällön useammalle sivulle, tee siitä malline. Jos joku luokittelu kulkee käsi kädessä jonkun mallineen kanssa, laita luokkalinkki mallineeseen, niin sitäkään ei tarvitse erikseen lisätä moneen paikkaan. | ||
==Linkit== | === Linkit === | ||
* Wikin sisäinen linkki <nowiki>[[näin]]</nowiki> esim. <nowiki>[[Screen]]in</nowiki>, jos tarvitsee taivuttaa tai muuten käyttää eri asua, niin <nowiki>[[kohde|otsikko]]</nowiki> esim. <nowiki>[[Lähdekoodi|Lähdekoodeja]]</nowiki> | * Wikin sisäinen linkki <nowiki>[[näin]]</nowiki> esim. <nowiki>[[Screen]]in</nowiki>, jos tarvitsee taivuttaa tai muuten käyttää eri asua, niin <nowiki>[[kohde|otsikko]]</nowiki> esim. <nowiki>[[Lähdekoodi|Lähdekoodeja]]</nowiki> | ||
* Linkki luokkasivulle: <nowiki>[[:Luokka:Luokannimi|Luokan sivulle]]</nowiki> | * Linkki luokkasivulle: <nowiki>[[:Luokka:Luokannimi|Luokan sivulle]]</nowiki> | ||
| Rivi 29: | Rivi 37: | ||
* Jos linkki on omalla rivillään, lisätään rivin alkuun pallura (<nowiki>*</nowiki>-merkki) | * Jos linkki on omalla rivillään, lisätään rivin alkuun pallura (<nowiki>*</nowiki>-merkki) | ||
==Kappalejako== | === Kappalejako === | ||
Osuva kappalejako parantaa artikkelin luettavuutta. Isommissa artikkeleissa kannattaa usein käyttää hierarkkista kappalejakoa, jossa isoimman wikissä käytettävän otsikkotyypin (esim. <nowiki>==Omaotsikko==</nowiki>) alla on pienempiä alaotsikoita (esim. <nowiki>===Alaotsikko1===</nowiki>). 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ä. | Osuva kappalejako parantaa artikkelin luettavuutta. Isommissa artikkeleissa kannattaa usein käyttää hierarkkista kappalejakoa, jossa isoimman wikissä käytettävän otsikkotyypin (esim. <nowiki>==Omaotsikko==</nowiki>) alla on pienempiä alaotsikoita (esim. <nowiki>===Alaotsikko1===</nowiki>). 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== | === 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ä [[lisenssi|lisenssikään]] sitä salli) vaan homma hoidetaan lisäämällä sivulle mallinne perustietoa (eli <nowiki>{{perustietoa}}</nowiki>) ja tämän jälkeen interwikillä linkki Wikipediaan tyyliin <nowiki>[[wikipedia:fi:otsikko]]</nowiki>. | Mikäli sivun sisältö ei ole mitenkään erikoista, vaan Wikipedian sisältö on riittävä, on turha forkata Wikipedian sisältöä (eikä [[lisenssi|lisenssikään]] sitä salli) vaan homma hoidetaan lisäämällä sivulle mallinne perustietoa (eli <nowiki>{{perustietoa}}</nowiki>) ja tämän jälkeen interwikillä linkki Wikipediaan tyyliin <nowiki>[[wikipedia:fi:otsikko]]</nowiki>. | ||
==Wiki-tyyli== | === 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 [[Toiminnot:Deadendpages|umpikujalistan]] tyhjentäminen, ja tyhjänä pitäminen. | 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 [[Toiminnot:Deadendpages|umpikujalistan]] tyhjentäminen, ja tyhjänä pitäminen. | ||
==Kuvat== | === 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ä. | 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 == | === Jakelut ja ohjelmat === | ||
Jakeluiden kanssa pyritään käyttämään mallinetta Jakelu. Lisätietoja sivulla [[Linux.fi:Merkitsemiskäytäntöjä/Jakelut]]. | Jakeluiden kanssa pyritään käyttämään mallinetta [[Malline:Jakelu|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]]. | Ohjelmien kanssa pyritään käyttämään mallinetta [[Malline:Ohjelma|Ohjelma]]. Lisätietoja sivulla [[Linux.fi:Merkitsemiskäytäntöjä/Ohjelmat]]. | ||
Ohjelmia EI pidä laittaa luokkaan [[:Luokka:Ohjelmat|Ohjelmat]] vaan johonkin kuvaavampaan alaluokkaan. | Ohjelmia EI pidä laittaa luokkaan [[:Luokka:Ohjelmat|Ohjelmat]] vaan johonkin kuvaavampaan alaluokkaan. | ||
== Muotoilu (<nowiki><tt></nowiki> ja kursivointi)== | === Muotoilu (<nowiki><tt></nowiki> ja kursivointi)=== | ||
Yleisesti ottaen ohjelmapakettien nimet, tiedostonimet ja komennot (tekstin seassa) merkitään <nowiki><tt></nowiki> ja <nowiki></tt></nowiki>-tagien väliin. Kursiivilla (<nowiki>''kursivointi''</nowiki>) merkitään valikkotekstit ja käännökset, esimerkiksi:<br> | Yleisesti ottaen ohjelmapakettien nimet, tiedostonimet ja komennot (tekstin seassa) merkitään <nowiki><tt></nowiki> ja <nowiki></tt></nowiki>-tagien väliin. Kursiivilla (<nowiki>''kursivointi''</nowiki>) merkitään valikkotekstit ja käännökset, esimerkiksi:<br> | ||
"Asenna paketti (eng. ''package'') <tt>gcc</tt> valitsemalla ''Sovellukset'' - ''Lisää/Poista sovelluksia''." | "Asenna paketti (eng. ''package'') <tt>gcc</tt> valitsemalla ''Sovellukset'' - ''Lisää/Poista sovelluksia''." | ||
==Yhteenveto== | === 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. | 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. | ||
[[Luokka:Wiki]] | [[Luokka:Wiki]] | ||