Malline:Dokumentaatio
Mallineen Dokumentaatio käyttöohje ja tekniset tiedot
Ohje muokkaa
Käytetään muotoilemaan mallineiden käyttöohje ja muut tiedot.
{{Dokumentaatio|
==Ohje==
ohjeteksti
==Templatedata==
Kts. [[Wikipedia:TemplateData]].
}}
Dokumentaatio-mallineen käytön tarkoitus on saada mallineen koodi ja sen dokumentaatio erottumaan toisistaan yhdenmukaisella tavalla, kun mallineen kaikki sisältö on yhdellä sivulla eli mallineen pääsivulla. Ohje ja muu vastaava sisältö tulee Dokumentaatio-mallineen sisään ja luokat tämän jälkeen. Edelleen tämä ja luokat tulevat kokonaisuudessaan -tagien sisään, jotta ne eivät tulostu mallinetta käyttäville sivuille.
Pidemmille ja monimutkaisemmille tapauksille on suositeltavampaa käyttää mallinetta rinnakkaista {{Mallineohje}}-rakennetta. Tällöin mallineen dokumentaatio on omalla ohje-alasivullaan.
Käyttöesimerkki (Malline:Suomen läänit) muokkaa
<noinclude>
{{Dokumentaatio|
== Käyttö ==
Vaakanavigaatio Suomen entisille lääneille:
<code><nowiki>{{Läänit}}</nowiki></code>
[[Ohje:Artikkelin_rakenne#Osioiden_sijoitus|Lisää]] malline soveltuvaan artikkeliin Aiheesta muualla -osion jälkeen.
}}
[[Luokka:Suomen läänien navigaatiomallineet|*]]
</noinclude>
Templatedata muokkaa
Kts. Wikipedia:TemplateData.
Visuaalisesti erottamaan mallineen koodi ja dokumentaatio toisistaan.
| Parametri | Kuvaus | Tyyppi | Tila | |
|---|---|---|---|---|
| 1 | 1 | Mallineen dokumentaatio wikitekstinä | Tuntematon | valinnainen |