Wikiprojekti:Mallineet/Metatieto
Mallineiden metatieto on kaikki mallineeseen liittyvä sisältö pois lukien itse mallinekoodi. Metatiedot sijaitsevat seuraavasti:
- mallineen alasivulla (Malline:MallineenNimi/ohje)
- kaikki muu paitsi mallineen luokat
- itse mallineen sivulla (Malline:MallineenNimi)
- mallineen luokat
Jokaisen mallineen ohjeessa tulisi vähintään mainita mihin mallinetta käytetään ja olla kopioitava mallinekutsu. Lisäksi tietolaatikoilla ja muilla mallineilla, joilla on parametreja, tulisi olla TemplateData (josta haetaan tidot VisualEditoriin).
Mallineen sivulle koodin loppuun lisätään <noinclude>{{Mallineohje|Luokka1|Luokka2}}</noinclude> , jossa Luokka1, Luokka2 jne. ovat mallineen luokkia. Tämä Mallineohje-malline tulostaa ohje-alasivulla olevan ohjeen näkyväksi itse mallineeseen.
Esimerkit: Tietolaatikkomalline:
Ohje-sivun rakenne
[muokkaa | muokkaa wikitekstiä]Kukin osio tulee tyypillisesti omaan kappaleeseensa, pois lukien:
- mallinehuomio, jos se ylipäätään on tarpeen, tulee sivun alkuun
- luokat annetaan varsinaisen mallineen sivulla mallineohje-mallinekutsuun
{{Mallineen ohjesivu}}
{{Mallinehuomio}}
== Käyttötarkoitus ==
== Ohje ==
== Parametrit ==
==Templatedata==
Metatiedot
[muokkaa | muokkaa wikitekstiä]Mallinehuomio
[muokkaa | muokkaa wikitekstiä]Mallinehuomio on malline, jolla merkitään mallineen normaalista käyttökunnosta poikkeava tila kuten, onko siinä jotain vikaa, sopiiko sitä käyttää, yms.
- Malline:Mallinehuomio
- Malline sisältää huomattavasti ohjelmallisuutta
- Malline:Mallinehuomio/korjattava (entinen Malline:Korjattava/malline)
- Mallineessa on jokin vika
- Malline:Mallinehuomio/kesken
- Malline on vasta kehitteillä. Eli ei yleiseen käyttöön.
- Malline:Mallinehuomio/vanhentunut
- Malline poistetaan tai on jo poistettu käytöstä mutta itse malline säilytetään arkistoituna.
Käyttötarkoitus
[muokkaa | muokkaa wikitekstiä]Kertoo mihin mallinetta käytetään.
Ohje
[muokkaa | muokkaa wikitekstiä]Seikkaperäinen ohje, siitä miten mallinnetta käytetään
Mallinekutsu
[muokkaa | muokkaa wikitekstiä]Tilanteen mukaan ohjeessa voi olla vaikkapa seuraavanlaisia mallinekutsuja:
- Ohjeeksi ja esimerkiksi tarkoitettu täysin täytetty mallinekutsu.
- Muokkauksen aloittamiseksi yleisellä wikikoodilla täytetty mallinekutsu.
Parametrit
[muokkaa | muokkaa wikitekstiä]Tarvittaessa annetaan tiedot kustakin mallineen parametrista. Käytä Mallineen parametrit -ohje/alku mallinesysteemiä. Huomaa, että toiminto koostuu kolmesta mallineesta.
Luokat
[muokkaa | muokkaa wikitekstiä]Mallineluokan nimessä tulee esiintyä päätteenä sana "mallineet", jotta se ei sekoitun artikkeliluokkiin. Luokan nimen tulee noudattaa suomen kielen kielioppia Navigaatiomallineiden luokkien tulee sisältää pääte "navigaatiomallineet" (ei "navigointimallineet")
Luokka:Mallineet on pääluokka kaikille mallineille. Luokat annetaan Mallineohje-mallineen parametreinä.
Mallineet luokitellaan kahteen eri luokkahierarkiaan tyypin mukaan ja aiheen mukaan. Näin jotta luokittelu palvelisi kahta varsin erilaista tarkoitus. Mallineiden hallinnoinnista kiinnostuneet mallineprojektilaiset haluvat löytää mallineita tyypin mukaan (Esimerkiksi tietolaatikot tarvitsemat kiireemmin kelpo ohjeen kuin navigaatiot). Mallineiden käyttäjät tyypillisesti hakevat mallineita taasen aiheen mukaan. Luokitus aiheiden mukaan seurailee artikkelien luokitusta.
Käytössä olevat tyypin mukaiset luokat:
- Tietolaatikko
- Pohjamallineet - mallineet joita käytetään toisten mallineiden tekemiseen; käytetään tehdessä mallineita, joissa on toistuvia elementtejä
- Vaakanavigaatio, sijaitsee artikkelin lopussa ja on koko sivun levyinen
- Pystynavigaatio, sijaitsee yleensä artikkelin alussa, vie yleensä kuvan verran tilaa
TemplateData
[muokkaa | muokkaa wikitekstiä]TemplateData on vakiomuotoisesti annettu tieto mallineen käytöstä ja parametreistä. Visuaalinen muokkain käyttää TemplateDataa.
TemplateDataa voi muokata koodina tai kaavakkeessa. Kun malline on muokkaustilassa sivun yläosaa ilmestyy "Hallitse mallineen dokumentaatiota" -painike, josta aukeaa TemplateDatan muokkauskaavake.
Mallineen TempalateData-parametrit[1]
- label
- VisualEditorissa näkyvä parametrin nimi
- Arvona versaalilla alkava lyhyt teksti
- description
- Arvona monisanaisempi kuvaus parametrin käytöstä
- Tässä voi antaa myös esimerkkejä
- type
- Parametrin sisällön tyyppi
- Määrittää sen, kuinka VisualEditor tulkitsee parametrin arvon
- string
- Teksti
- number
- kokonaisluku
- string/wiki-user-name
- string/wiki-page-name
- string/line
- Short text field - use for names, labels, and other short-form fields.
- default
- contains the default value of this parameter (in quotes). The information can be skipped, if the parameter has no default value as in this example.
- required
- controls whether filling out the parameter is mandatory for that template. Enter true if the value is required for the template and false if it is not required. In this case, both count and sub_string are required values.
- aliases
- (optional) List of aliases eg "aliases": [ "2", "Caption", "imagecaption" ]. An alias is an alternative name for the parameter that may be used instead of (not in addition to) the primary name. Aliases are not documented in a separate parameter object. If they need more information, they should be in their own property marked "deprecated".
- deprecated
- Vain tarvittaessa
- Tooltip for the user detailing the intent for the deprecated parameters, a boolean or string value.
- inherits
- Vain tarkittaessa
- Key to another parameter. The current parameter will inherit from that one, with local properties overriding the inherited ones.
Toiminnan mahdollistavat mallineet ja muut sivut
[muokkaa | muokkaa wikitekstiä]Wikipedia:Visuaalinen_muokkain/TemplateData
Nykyiset viralliset mallineet ohje-alasivua käytettäessä:
- Malline:Mallineohje - tulostaa mallinesivulle ohjeet ohje-alasivulta
- Malline:Mallineen ohjesivu - tulostaa ohjesivulle ohjeen/huomautuksen
- Malline:Mallineen parametrit -ohje/alku - käytetään parametrien ohjeiden antamiseen
- Malline:Mallineohjeen luontilaatikko - Lataa mallineohjepohjan annetulle nimelle.
Esimerkkejä ja pohjia:
- Wikipedia:Artikkelipohja/Malline-ohje - esimerkkipohja ohjesivulle
- Wikipedia:Sivupohja/Mallineohje - käsin kopioitava pohja
- Wikipedia:Sivupohja/Mallineohje luontilaatikolle - pohja sellaisessa muodossa, että se toimii luontilaatikkomallineen kanssa
- Malline:Mallineohjemalli - malline ja sen ohje esimerkiksi
Vain minimalistisen triviaaleille ohjeille, ohje voidaan antaa suoraan mallineen sivulla:
- Malline:Dokumentaatio - lisää laatikon, johon varsinainen mallineen käyttöohje sijoitetaan, kun ohje on mallineen sivulla eikä tämän ohje-alasivulla.
Käytöstä mahdollisesti poistettavat:
- Malline:Mallinerivi - tulostaa tiivistelmän mallinelistauksiin eli ohjeistaviin näkymiin. Nykyisellään listaukset ovat vanhentuneet ja harvassa on tiivistelmä eli ne eivät oli niin hyödyllisiä kuin voisivat olla. Tähän on vielä useita viittauksia mallineita luetteloivilta sivuilta -> luetteloille tehtävä jotain ennen poistoa.