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

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 kahvihuoneessa. Mikäli mahdollista, tule myös IRC-kanavalle keskustelemaan ennen suurempia muokkausoperaatioita.

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 kä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.

Yksittäisen artikkelin kohderyhmä ja tavoitteet

Linux.fi:n artikkeleille ei ole yhtä yhteistä kohderyhmää, ja yksittäisessä artikkelissakin saattaa olla eri tasoisille ja eri tavoin ajatteleville lukijoille suunnattuja osuuksia. Näitä ei kuitenkaan tulisi sekoittaa.

Tyyliseikat

Kieli

Wikin artikkelit ovat suomeksi. Artikkelit kirjoitetaan 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 vaikkapa lokalisointi.orgin 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:
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), voidaan se laittaa varsinaisen tekstin sekaan <tt>- ja </tt>-tagien väliin. Tagien laittamista varten muokkaustyökaluriviltä löytyy <tt>-nappi> Esimerkki:
Pura paketti komennolla tar xvf paketti.tar.gz ja pidä hauskaa.

Skriptit

Jos artikkeliin liittyy esimerkiksi bash-skripti, laita se <syntaxhighlight lang="bash"> ja </syntaxhighlight> -tagien väliin. Näitäkin varten löytyy pikanappi muokkaustyökaluriviltä. Esimerkki:

#!/bin/bash
echo Hei $USER

Taulukko muista tuetuista kielistä löytyy lisäosan SyntaxHighlight-kotisivulta.

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.

Mallineet

Jos koet tarpeelliseksi lisätä saman sisällön useammalle sivulle, tee siitä malline. Jos joku luokittelu on yhtenevä jonkin mallineen kanssa, laita luokkalinkki mallineeseen, niin sitäkään ei tarvitse erikseen lisätä moneen paikkaan.

• Lista olemassaolevista mallineista.
• Luokka olemassaolevista Mallineista.

Linkit

• Wikin sisäinen linkki [[näin]] esim. [[Screen]]in, jos tarvitsee taivuttaa tai muuten käyttää eri asua, niin [[kohde|otsikko]] esim. [[Lähdekoodi|Lähdekoodeja]]
• Linkki luokkasivulle: [[:Luokka:Luokannimi|Luokan sivulle]]
• Interwiki, eli linkit Wikipediaan tai ArchWikiin: [[wikipedia:fi:Linux|Linux]], [[wikipedia:en:Linux|Linux]] [[archwiki:Linux|Linux]]
• Ulkoiset linkit: [https://www.example.com/ Otsikko]

Vinkki: Jos lisäät ulkoista linkkiä, hyvä tapa linkin wikiin lisäämisen ohessa on lisätä se myös Internet Archiveen, jolloin jos linkin sisältö sattuu poistumaan verkosta, se voidaan tulevaisuudessa ohjata arkistoituun tallenteeseen.

• Jos linkki on omalla rivillään, lisätään rivin alkuun asteriski (*-merkki) tai <li>
• Jos artikkelin nimi pitää olla pienellä kirjaimella alkava. Lisätään rivin alkuun {{pienaakkonen}}

Ilmoituslaatikot ja huomautukset

Huomautus: Jos sivulle haluaa huomautus laatikon, se tehdään seuraavasti: {{Huomautus|Huomautettava teksti}}

Vinkki: Jos sivulle haluaa vinkki laatikon, se tehdään seuraavasti: {{Vinkki|Vinkin teksti}}

Varoitus!!! Jos sivulle haluaa varoitus laatikon, se tehdään seuraavasti: {{Varoitus|Varoituksen teksti}}

Jos sivulle haluaa komennoista kertovan ohjeen, se tehdään seuraavasti: {{Oikeudet}}

Komennot, jotka alkavat $-merkillä suoritetaan tavallisena käyttäjänä ja komennot, jotka alkavat #-merkillä suoritetaan pääkäyttäjänä. Katso myös su, sudo ja doas.

Tällä mallineella annetaan vinkki tai varoitus, että ohjelma olisi hyvä suorittaa hiekkalaatikossa. Se tapahtuu seuraavasti: {{Hiekkalaatikko|ohjelman nimi|}}

Vinkki: Jos Wonderwall ohjelmistoa on välttämättä pakko käyttää, on suositeltavaa sen eristäminen muusta järjestelmästä suorittamalla se eristetyssä hiekkalaatikossa kuten Firejail-ohjelmistossa tai virtuaalikoneessa.

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}} tai {{perustietoa|haettava sivu}}) Ja jos englannin kielisestä wikistä löyty, niin sen voi linkittää näin: {{Perustietoa|Linux}} tai {{Perustietoa|en:haettava sivu}}.

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.

Tiedostot

Lisenssit

Selvitä lähettämäsi teosten mahdollisesti käyttämät lisenssit, ja jos wikin tarjoamat lisenssityypit eivät vastaa teoksen listaamia, merkitse manuaalisesti lisenssitiedot tiedoston kuvaukseen Yhteenveto-kohtaan sekä ehdota puuttuvien lisenssien lisäämistä esim. Kahvihuoneessa tai Linux.fi:n keskustelukanavalla #linux.fi:linux.fi Matrixissa sekä #wikilinux IRCnetissä.

Teoksen koostuessa useammasta eri lisenssistä, Tallenna tiedosto-sivulla valitse lisenssiksi Ei lisenssiä ja lisää itse lisenssit manuaalisesti Yhteenveto-kohtaan, esimerkiksi:

==Lisenssi==
{{GPL}}
{{CCO}}
{{Logo}}

Logot

Mahdollisuuksien yritä ensisijaisesti käyttää svg-vektorigrafiikkatiedostoja, logojen kanssa, mutta jos tämä ei ole mahdollista, tai värit eivät toistu oikein, bittikarttagrafiikkatiedostot kuten png, jpg tai gif voivat olla soveliaampia vaihtoehtoja.

Kuvakaappaukset

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.

Linux yhteensopivien palvelujen kanssa pyritään käyttämään mallinetta Palvelu. Lisätietoja sivulla Linux.fi:Merkitsemiskäytäntöjä/Palvelu.

Yritykset ja yhteisöt

Yrityksien ja säätiöiden kanssa pyritään käyttämään mallinetta Yritys. Lisätietoja sivulla Linux.fi:Merkitsemiskäytäntöjä/Yritys.

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

Järjestöjen kanssa pyritään käyttämään mallinetta Järjestö. Lisätietoja sivulla Linux.fi:Merkitsemiskäytäntöjä/Järjestö.

Muut

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

Ohjelmointikielien kanssa pyritään käyttämään mallinetta Ohjelmointikieli.

Lisätietoja sivulla Linux.fi:Merkitsemiskäytäntöjä/Ohjelmointikieli.

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 (engl. 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.