Ero sivun ”Linux.fi:Merkitsemiskäytäntöjä” versioiden välillä
Siirry navigaatioon
Siirry hakuun
Linux.fi:Merkitsemiskäytäntöjä (muokkaa)
Versio 31. maaliskuuta 2022 kello 22.10
, 31. maaliskuuta 2022Vinkki pienääkkösen käytöstä.
(aloitettu uusi väliotsikko, sitä lienee syytä työstää) |
p (Vinkki pienääkkösen käytöstä.) |
||
| (40 välissä olevaa versiota 9 käyttäjän tekeminä ei näytetä) | |||
| Rivi 6: | Rivi 6: | ||
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. | 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 | 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. | Nämä käytännöt eivät myöskään ole aivan ehdottomia, ja niistä voidaan tarvittaessa poiketa. | ||
| Rivi 14: | Rivi 14: | ||
== Tyyliseikat == | == Tyyliseikat == | ||
=== Kieli === | === Kieli === | ||
Wikin artikkelit ovat suomeksi. Artikkelit | 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 [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. | Artikkelin lisäksi myös otsikon (eli sivun nimen) pitää olla järkevää suomea. Esimerkiksi "Emulaattorit pääsivu" ei sellaista ole. | ||
| Rivi 24: | Rivi 23: | ||
Tar.gz-paketti puretaan komennolla | Tar.gz-paketti puretaan komennolla | ||
tar xvzf paketti.tar.gz | tar xvzf paketti.tar.gz | ||
Jos komentoa ei laiteta omalle rivilleen laatikon sisään (eli laittamalla välilyönti rivin alkuun), se | Jos komentoa ei laiteta omalle rivilleen laatikon sisään (eli laittamalla välilyönti rivin alkuun), voidaan se laittaa varsinaisen tekstin sekaan <nowiki><tt>- ja </tt></nowiki>-tagien väliin. Tagien laittamista varten muokkaustyökaluriviltä löytyy <nowiki><tt></nowiki>-nappi> Esimerkki:<br> | ||
Pura paketti komennolla <tt>tar | Pura paketti komennolla <tt>tar xvf paketti.tar.gz</tt> ja pidä hauskaa. | ||
===Skriptit=== | |||
Jos artikkeliin liittyy esimerkiksi [[bash]]-skripti, laita se <nowiki><syntaxhighlight lang="bash"></nowiki> ja <nowiki></syntaxhighlight></nowiki> -tagien väliin. Näitäkin varten löytyy pikanappi muokkaustyökaluriviltä. Esimerkki: | |||
<syntaxhighlight lang="bash"> | |||
#!/bin/bash | |||
echo Hei $USER | |||
</syntaxhighlight> | |||
Taulukko muista tuetuista kielistä löytyy lisäosan [https://www.mediawiki.org/wiki/Extension:SyntaxHighlight SyntaxHighlight-kotisivulta.] | |||
=== Luokittelu === | === Luokittelu === | ||
| Rivi 31: | Rivi 39: | ||
=== Mallineet === | === Mallineet === | ||
Jos koet tarpeelliseksi lisätä saman sisällön useammalle sivulle, tee siitä malline. Jos joku luokittelu | 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 [https://www.linux.fi/wiki/Linux.fi:Mallineet mallineista]. | |||
* Luokka olemassaolevista [[:Luokka:Mallineet|Mallineista]]. | |||
=== 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> | ||
* Interwiki, eli linkit | * Interwiki, eli linkit Wikipediaan tai ArchWikiin: <nowiki>[[wikipedia:fi:Linux|Linux]]</nowiki>, <nowiki>[[wikipedia:en:Linux|Linux]]</nowiki> <nowiki>[[archwiki:Linux|Linux]]</nowiki> | ||
* Ulkoiset linkit: <nowiki>[ | * Ulkoiset linkit: <nowiki>[https://www.example.com/ Otsikko]</nowiki> | ||
* Jos linkki on omalla rivillään, lisätään rivin alkuun | * Jos linkki on omalla rivillään, lisätään rivin alkuun [[wikipedia:fi:Asteriski|asteriski]] (<nowiki>*</nowiki>-merkki) tai <nowiki><li></nowiki> | ||
* Jos artikkelin nimi pitää olla pienellä kirjaimella alkava. Lisätään rivin alkuun <nowiki>{{pienaakkonen}}</nowiki> | |||
=== Ilmoituslaatikot ja huomautukset === | |||
{{Huomautus|Jos sivulle haluaa huomautus laatikon, se tehdään seuraavasti: <nowiki>{{Huomautus|Huomautettava teksti}}</nowiki>}} | |||
{{Vinkki|Jos sivulle haluaa vinkki laatikon, se tehdään seuraavasti: <nowiki>{{Vinkki|Vinkin teksti}}</nowiki>}} | |||
{{Varoitus|Jos sivulle haluaa varoitus laatikon, se tehdään seuraavasti: <nowiki>{{Varoitus|Varoituksen teksti}}</nowiki>}} | |||
Jos sivulle haluaa komennoista kertovan ohjeen, se tehdään seuraavasti: <nowiki>{{Oikeudet}}</nowiki> | |||
{{Oikeudet}} | |||
JTällä mallineella annetaan vinkki tai varoitus, että ohjelma olisi hyvä suorittaa hiekkalaatikossa. Se tapahtuu seuraavasti: <nowiki>{{Hiekkalaatikko|ohjelman nimi|}}</nowiki> {{Hiekkalaatikko|Wonderwall|}} | |||
=== Kappalejako === | === Kappalejako === | ||
| Rivi 44: | Rivi 64: | ||
=== 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>) | 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> tai <nowiki>{{perustietoa|haettava sivu}}</nowiki>) Ja jos englannin kielisestä wikistä löyty, niin sen voi linkittää näin: <nowiki>{{Perustietoa|Linux}}</nowiki> tai <nowiki>{{Perustietoa|en:haettava sivu}}</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. | ||
=== | === Tiedostot === | ||
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ä. | ====Lisenssit==== | ||
Selvitä lähettämäsi teosten mahdollisesti käyttämät [[Lisensointi|lisenssit]], ja jos wikin tarjoamat [[Järjestelmäviesti:Licenses|lisenssityypit]] eivät vastaa teoksen listaamia, merkitse manuaalisesti lisenssitiedot tiedoston kuvaukseen Yhteenveto-kohtaan sekä ehdota puuttuvien lisenssien lisäämistä esim. [[Linux.fi:Kahvihuone|Kahvihuoneessa]] tai Linux.fi:n keskustelukanavalla [https://matrix.to/#/#linux.fi:linux.fi #linux.fi:linux.fi] [[Matrix]]issa sekä [[Linux.fi:IRC|#wikilinux]] IRCnetissä. | |||
Teoksen koostuessa useammasta eri lisenssistä, [[Toiminnot:Tallenna|Tallenna tiedosto]]-sivulla valitse lisenssiksi Ei lisenssiä ja lisää itse lisenssit manuaalisesti Yhteenveto-kohtaan, esimerkiksi: | |||
<pre> | |||
==Lisenssi== | |||
{{GPL}} | |||
{{CCO}} | |||
{{Logo}} | |||
</pre> | |||
====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 === | === Jakelut ja ohjelmat === | ||
| Rivi 56: | Rivi 92: | ||
Ohjelmien kanssa pyritään käyttämään mallinetta [[Malline:Ohjelma|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]]. | ||
Linux yhteensopivien palvelujen kanssa pyritään käyttämään mallinetta [[Malline:Palvelu|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 [[Malline:Yritys|Yritys]]. Lisätietoja sivulla [[Linux.fi:Merkitsemiskäytäntöjä/Yritys]]. | |||
Yhteisöjen kanssa pyritään käyttämään mallinetta [[Malline:Yhteisö|Yhteisö]]. Lisätietoja sivulla [[Linux.fi:Merkitsemiskäytäntöjä/Yhteisö]]. | |||
Järjestöjen kanssa pyritään käyttämään mallinetta [[Malline:Järjestö|Järjestö]]. Lisätietoja sivulla [[Linux.fi:Merkitsemiskäytäntöjä/Järjestö]]. | |||
==== Muut ==== | |||
Ytimien kanssa pyritään käyttämään mallinetta [[Malline:Ydin|Ydin]]. Lisätietoja sivulla [[Linux.fi:Merkitsemiskäytäntöjä/Ydin]]. | |||
Ohjelmointikielien kanssa pyritään käyttämään mallinetta [[Malline:Ohjelmointikieli|Ohjelmointikieli]]. | |||
Lisätietoja sivulla [[Linux.fi:Merkitsemiskäytäntöjä/Ohjelmointikieli]]. | |||
Ohjelmia EI pidä laittaa luokkaan [[:Luokka:Ohjelmat|Ohjelmat]] vaan johonkin kuvaavampaan alaluokkaan. | Ohjelmia EI pidä laittaa luokkaan [[:Luokka:Ohjelmat|Ohjelmat]] vaan johonkin kuvaavampaan alaluokkaan. | ||
| Rivi 61: | Rivi 114: | ||
=== 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 ( | "Asenna paketti (engl. ''package'') <tt>gcc</tt> valitsemalla ''Sovellukset'' - ''Lisää/Poista sovelluksia''." | ||
=== Yhteenveto === | === Yhteenveto === | ||