Ohje:Malline
Windesol - Tuuli- & aurinkovoima tietosanakirja
Malline:Tyyliopas Windesolin mallineet ovat sivuja, joiden avulla saman sisällön voi esittää useammalla sivulla. Tämä tapahtuu asettamalla malline toiselle sivulle. Mallineeseen tehdyt muokkaukset näkyvät kaikilla niillä sivuilla, joihin malline on asetettu. Esimerkiksi oheinen tyyliopaslaatikko on navigaatiomalline, joka on avuksi samaan kokonaisuuteen kuuluvia sivuja selattaessa. Malline on sijoitettu sivulle tekstinpätkällä {{Tyyliopas}}. Monet mallineet myös laittavat artikkelin automaattisesti sopivaan luokkaan. Mallineen suurin hyöty saavutetaan silloin, kun sama asia tulisi toistaa samalla tavalla useilla eri sivuilla.
Tässä ohjeessa käydään yksityiskohtaisesti läpi kuinka mallineita voidaan liittää artikkeleihin, kuinka luoda mallineita sekä lopuksi kuinka mallineeseen saadaan toiminnallisuutta. Olemassa olevia mallineita voi selata sivulla Windesol - Tuuli- & aurinkovoima tietosanakirja:Malline.
Sisällysluettelo |
Mallineen liittäminen
Malline voi sijaita kahdessa eri nimiavaruudessa. Yleisimmin mallineen tunnistaa etuliitteestä Malline: nimessä, mutta myös artikkelin alasivu voi toimia mallineena.
Malline-nimiavaruudessa olevan mallineen liittäminen osaksi artikkelia
Yksinkertaisimmillaan malline voidaan liittää artikkeliin sulkemalla mallineen nimi (ilman nimiavaruusosaa Malline:) tuplakaarisulkeiden sisälle:
{{Mallineen nimi}}
Tällaisissa tapauksissa malline on niin kutsuttu listaava tai luetteloiva malline ilman sen kummempaa toiminnallisuutta, tai rakennettu siten että malline toimii yleisimmissä tapauksissa ilman parametreja.
Kun malline vaatii parametreja eli arvoja jotka määrittävät mallineen sisältöä, lisätään ne mallineen nimen perään pystyviivalla eroteltuna:
{{Mallineen nimi | 1 | 2 | 3}}
{{Mallineen nimi | parametri2 = 2 | parametri1 = 1 | parametri3 = 3}}
{{Mallineen nimi | 1 | 2 | parametri4 = 4}}
- Ensimmäisessä tapauksessa malline vastaanottaa parametreja tietyssä järjestyksessä, eikä parametria tule eikä pidä nimetä.
- Toisessa tapauksessa mallineen parametrit on nimetty, ja nimet tulee liittää osaksi mallinekutsua. Tällöin parametrien järjestyksellä ei ole väliä, vaan MediaWiki järjestelee parametrit nimen perusteella oikein
- Kolmannessa tapauksessa mallineella on sekä tietyssä järjestyksessä käsiteltäviä parametreja, että nimettyjä parametreja. Tällöin järjestyksessä käsiteltävien parametrien tulee sijaita oikeassa kohdassa, mutta nimetyt parametrit voivat olla halutussa järjestyksessä mallinekutsun lopussa.
Mallineen luonti
Mikäli tarvitsemaasi mallinetta ei löydy, tulee miettiä:
- Tullaanko sama / samankaltainen tieto toistamaan useilla sivuilla
- Mikäli ei, tulisi mallineen sijasta rakentaa tieto suoraan artikkeliin
- Looginen nimi mallineelle
- Mallineen vakiosijainti artikkelissa (ylhäällä oikealla, alhaalla keskellä, jossain muualla)
- Mallineen toiminta mikäli kyseessä on muu kuin listaava / luetteloiva malline
Kun nämä kohdat on selvillä, voit aloittaa mallineen luonnin kirjoittamalla esimerkiksi vasemmalle hakuun Malline:Mallineen nimi.
Toiminnallisuuden lisääminen mallineeseen
Mallineisiin voidaan lisätään toiminnallisuutta parametreilla ja funktioilla.
Parametrit
Parametrit ovat eräänlaisia muuttujia, jotka vastaanottavat mallinekutsussa (katso yllä) mallineelle erilaisia arvoja. Parametrit suljetaan mallineen sisällä kolmoiskaarisulkeisiin ( {{{ ja }}} ) ja ne voidaan asettaa minne tahansa tavallisen mallinesisällön sisään.
Esimerkki:
Malline parametrilla jonka arvo on {{{1}}}
Esimerkki tulostaisi kohtaan {{{1}}} mallineelle ensiksi määritellyn parametrin. Mikäli kolmoiskaarisulkeiden sisällä olisi numeron sijasta tekstiä, esimerkiksi {{{parametri}}}, pitäisi mallinetta kutsuessa määritellä parametri = arvo.
Parametrien ketjuttaminen
Välillä mallinetta luodessa tulee ajatusvirheitä parametrien nimissä, tai tarvitaan tulostaa tietty asia kun yksi parametri kahdesta (tai useammasta parametrista) on määritelty. Näissä tapauksissa parametreja voidaan ketjuttaa:
{{{param|{{{parametri}}}}}}
Yllä mainitussa esimerkissä tulostettaisiin parametrin param arvo, tai jos sitä ei olisi määritelty, tulostettaisiin parametrin parametri arvo. Tällä keinolla laajasti käytössä olevan mallineen parametrien nimiä voidaan muuttaa ilman että mallinetta käyttävät sivut häiriintyy muutoksesta, ja saadaan aikaa päivittää mallinetta käyttävät sivut käyttämään uusia parametreja.
Parametreja voidaan käytännössä ketjuttaa kuinka monta tahansa lisäämällä aina pystypalkki ja uusi parametri yllä olevan esimerkin mukaisesti parametrin nimen tai numeron perään.
Parametrin ehdollistaminen ja oletusarvon käyttö
Parametri voidaan tarvittaessa ehdollistaa käyttämällä parametrien ketjuttamisessa kuvattua tapaa, mutta sen sijaan että määriteltäisiin uusi parametri, voidaan määritellä tyhjä (eli ehdollistaa) tai oletusarvo:
{{{1|ei arvoa}}} {{{2|}}}
Yllä oleva esimerkki tulostaisi ensimmäisen parametrin arvon tai ei arvoa ja lisäisi tulosteen perään toisen parametrin arvon mikäli se olisi määritelty.
Mediawikin avainsanat
Sisällysluettelon avainsanat
| Avainsana | Selite |
|---|---|
| __NOTOC__ | Piilottaa sisällysluettelon sivulta. |
| __FORCETOC__ | Pakottaa sisällysluettelon esiin |
| __TOC__ | Sijoittaa sisällysluettelon valittuun paikkaan välittämättä avainsanasta __NOTOC__. |
Muut avainsanat
| Avainsana | Selite |
|---|---|
| __NOEDITSECTION__ | Piilottaa sivulta [muokkaa] -linkit otsikkotasojen vierestä. |
| __NEWSECTIONLINK__ | Lisää välilehden + ei-keskustelusivuille joiden avulla voi lisätä uuden osa-alueen sivulle. |
| __NOCONTENTCONVERT__ __NOCC__ | Estää sisällön maakohtaisen muuntamisen artikkeleita tarkasteltaessa. |
| __NOGALLERY__ | Näyttää kuvaluokissa kuvat tekstimuotoisena, ei galleriana. |
| __NOTITLECONVERT__ __NOTC__ | Kuten __NOCC__ mutta vaikuttaa vain artikkelin otsikkoon. |
| __HIDDENCAT__ | Luokittelee sivun muttei näytä luokkaa itse sivulla. Käytetään luokan alla. |
Taikasanat
Aika
| Muuttuja | Tulos | Selitys |
|---|---|---|
| {{CURRENTMONTH}} | 05 | Meneillään oleva kuukausi kahdella numerolla |
| {{CURRENTMONTHNAME}} | toukokuu | Meneillään olevan kuukauden nimi |
| {{CURRENTMONTHNAMEGEN}} | toukokuun | Meneillään olevan kuukauden nimi geniivissä |
| {{CURRENTMONTHABBREV}} | toukokuu | Meneillään oleva päivä kahdella numerolla |
| {{CURRENTDAY}} | 22 | |
| {{CURRENTDAY2}} | 22 | |
| {{CURRENTDOW}} | 2 | |
| {{CURRENTDAYNAME}} | tiistai | |
| {{CURRENTWEEK}} | 21 | |
| {{CURRENTYEAR}} | 2012 | |
| {{CURRENTTIME}} | 06.28 | |
| {{CURRENTTIMESTAMP}} | 20120522062854 |
Paikallinen aika
| Muuttuja | Tulos | Selitys |
|---|---|---|
| {{LOCALDAY}} | 22 | |
| {{LOCALDAY2}} | 22 | |
| {{LOCALDAYNAME}} | tiistai | |
| {{LOCALDOW}} | 2 | |
| {{LOCALMONTH}} | 05 | |
| {{LOCALMONTHABBREV}} | toukokuu | |
| {{LOCALMONTHNAME}} | toukokuu | |
| {{LOCALTIME}} | 09.28 | |
| {{LOCALHOUR}} | 09 | |
| {{LOCALWEEK}} | 21 | |
| {{LOCALYEAR}} | 2012 | |
| {{LOCALTIMESTAMP}} | 20120522092854 |
Tilastot
| Muuttuja | Tulos | Selitys | |
|---|---|---|---|
| {{CURRENTVERSION}} | 1.14.0 | ||
| {{NUMBEROFEDITS}} {{NUMBEROFEDITS:R}} | 3 236 3236 | ||
| {{NUMBEROFARTICLES}} {{NUMBEROFARTICLES:R}} | 206206
| ||
| {{NUMBEROFPAGES}} {{NUMBEROFPAGES:R}} | 1 479 1479 | ||
| {{NUMBEROFFILES}} {{NUMBEROFFILES:R}} | 243 243 | ||
| {{NUMBEROFUSERS}} {{NUMBEROFUSERS:R}} | 186 186 | ||
| {{NUMBEROFADMINS}} {{NUMBEROFADMINS:R}} | 7 7 | ||
| {{PAGESINNAMESPACE}} | {{#if:{{#ifexpr:Malline:PAGEINNS:0}}|ei käytössä}} | ||
| {{PAGESINNS:ns}} {{PAGESINNS:ns:R}} | {{PAGESINNS:2}} {{#if:{{#ifexpr:Malline:PAGEINNS:0}} | = Malline:PAGESINNS:2}} {{PAGESINNS:2:R}} {{#if:{{#ifexpr:Malline:PAGEINNS:0}}| ei käytössä|= Malline:PAGESINNS:2}} | |
| {{PAGESINCATEGORY:Luokka}} {{PAGESINCAT:Luokka}} | {{PAGESINCATEGORY:Wikipedian ylläpito}} 0 |
Sivun nimi ja siihen liittyvä tieto
| Muuttuja | Tulos | Selitys |
|---|---|---|
| {{PAGENAME}} | Malline | Sivun nimi ilman nimiavaruutta |
| {{PAGENAMEE}} | Malline | |
| {{SUBPAGENAME}} {{SUBPAGENAMEE}} | Malline Malline | |
| {{BASEPAGENAME}} {{BASEPAGENAMEE}} | Malline Malline | |
| {{NAMESPACE}} {{NAMESPACEE}} | Ohje Ohje | Sivun nimiavuus |
| {{FULLPAGENAME}} {{FULLPAGENAMEE}} | Ohje:Malline Ohje:Malline | Sivun nimiavaruus ja nimi |
| {{TALKSPACE}} {{TALKSPACEE}} | Keskustelu ohjeesta Keskustelu_ohjeesta | |
| {{SUBJECTSPACE}} {{SUBJECTSPACEE}} | Ohje Ohje | |
| {{ARTICLESPACE}} {{ARTICLESPACEE}} | Ohje Ohje | |
| {{TALKPAGENAME}} {{TALKPAGENAMEE}} | Keskustelu ohjeesta:Malline Keskustelu_ohjeesta:Malline | |
| {{SUBJECTPAGENAME}} {{SUBJECTPAGENAMEE}} | Ohje:Malline Ohje:Malline | |
| {{ARTICLEPAGENAME}} {{ARTICLEPAGENAMEE}} | Ohje:Malline Ohje:Malline | |
| {{REVISIONID}} | 1488 | |
| {{REVISIONDAY}} | 11 | |
| {{REVISIONDAY2}} | 11 | |
| {{REVISIONMONTH}} | 8 | |
| {{REVISIONYEAR}} | 2008 | |
| {{REVISIONTIMESTAMP}} | 20080811092347 | |
| {{SITENAME}} | Windesol - Tuuli- & aurinkovoima tietosanakirja | |
| {{SERVER}} | http://www.windesol.fi | |
| {{SCRIPTPATH}} | /windesol | |
| {{SERVERNAME}} | www.windesol.fi |
noinclude
noinclude on nimensä mukaisesti tagi, joka estää mallineen ohjeiden, sisäisten luokkien ja muiden mallineeseen kuulumattomien tietojen vuotamisen artikkeleihin. Tagit kokonaisuudessaan ovat<noinclude>tiedot</noinclude>
includeonly
includeonly on niin ikään etenkin mallineita varten kehitetty tagi. Tagi sisällyttää ainoastaan kutsuvaan artikkeliin tagien sisällä olevan tiedon, ja on hyödyllinen esimerkiksi silloin kun mallineen tulee luokitella sitä käyttävä artikkeli tiettyyn luokkaan, mutta mallineen itsensä ei tarvitse kyseiseen luokkaan kuulua. Tagit kokonaisuudessaan ovat<includeonly>tiedot</includeonly>

