Malli dokumentatsioon

See on artikli teatekastide metamall. Mall pole mõeldud otse kasutamiseks, vaid mallide loojatele artiklite teatekastimallide ehitamiseks, näiteks nagu on tehtud malli {{Lisaviiteid}} puhul. Võimalik on valida teatekasti värvi, kasutada ette antud ja enda poolt valitud pilte jm.

Tüüpilised parameetrid

Allolevas kastis on antud kõige tavalisemad parameetrid, millega malli {{Ambox}} poole pöörduda. Allpool on iga parameetrit lähemalt kirjeldatud.

{{Ambox
| name  = 
| subst = <includeonly>{{subst:substcheck}}</includeonly>
| small = {{{small|}}}
| type  = 
| image = 
| sect  = {{{1|}}}
| issue = 
| talk  = {{{talk|}}}
| fix   = 
| date  = {{{date|}}}
| cat   = 
| all   = 
}}

name

Parameeteris name on antud malli nimi. Näiteks kui malliks on {{Lisaviiteid}}, siis on parameeter antud nii: |name=Lisaviiteid.

Juhul kui mall teisendatakse uue nime alla, siis tuleks parameetrit uuendada. Parameetril on kaks eesmärki:

  • Kui metamalli kasutav mall on valesti asendatud, siis annab metamall valesti asendatud malli nime teada, mis aitab toimetajatel probleemi lahendada.
  • See aitab teha malli abilehe kasulikumaks. Näiteks näidatakse kuupäeva isegi siis, kui seda pole argumendina kasutatud. Lisaks sellele tekib võimalus malli ennast kategoriseerida.

subst

Parameeter subst aitab metamallil tuvastada, kas mall on korrektselt asendatud ja väljastada asjakohase hoiatuse. Niisugune lehekülg lisatakse ka kategooriasse Kategooria:Valesti asendatud mallidega leheküljed. Kasuta koodi täpselt nii nagu see ülal kastis antud on.

small (väike)

Parameeter small on mõeldud väikesemõõdulise teatekasti tekitamiseks. Kui parameetri kood jätta selliseks nagu ülal kastis (malli sisse tulev argument small antakse edasi), siis saab kasutaja artiklisse lisatavas mallis kasutada argumenti |small=left, mis tekitab sellise tulemuse:

Ilma argumendita small tekitab niisuguse tulemuse:

Valikuvariandid:

  • Teatekastide puhul, mis mitte kunagi ei tohiks väiksed olla, kasuta |small=no või jäta parameeter small tühjaks. Sel juhul ei teki malli kasutajale võimalust määrata väikest teatekasti.
  • Kui teatekast peab alati olema väike, siis lisa |small=left.
  • Kui teatekast peab olema vaikimisi väike, siis kasuta koodi |small={{{small|left}}}. Sel juhul saab kasutaja soovi korral kasutada artiklis |small=no, mis on ülimuslik vaikimisi väärtuse suhtes, ja tekitada suure teatekasti.

type (tüüp)

Parameeter type määrab teabekasti vasema serva riba värvitooni ja vaikimisi pildi. Allpool on näidatud seitset olemasolevat tüüpi koos vaikimisi piltidega.

Kui argument type pole antud, siis pannakse vaikimisi tüübiks |type=notice.

image (pilt)

Parameetri image abil saad valida enda poolt soovitud ikooni mallis kasutamiseks. Ikooni määramisel kasuta tavapärast Vikipeedia pildisüntaksit. Tavaliselt jääb ikooni laius vahemikku 40-50 pikslit. Näiteid:

  • siin on kasutatud argumenti |image=[[Pilt:Unbalanced scales.svg|40px|link=|alt=]]:
  • siin on kasutatud argumenti |image=[[Pilt:Ambox wikify.svg|50x40px|link=|alt=]]:

Kasulik teada:

  • Kui parameeter image on väärtustamata, siis kasutatakse vaikimisi pilti vastavalt argumendile type.
  • Kui on antud |image=none, siis pilti teatekasti ei teki ja tekst laiub üle kogu kasti.
  • Selleks, et enda poolt valitud ikooni kasutamisel takistada lingi ja pildi kohal näidatava teksti tekkimist, kasuta pildisüntaksis tühjasid parameetreid |link=|alt= (nagu näidetes).

sect (sihitis)

Artikli teatekastide tekst algab tavaliselt sõnaga Artiklis.... Kui teatekasti kasutatakse artikli alajaotuse juures, siis on parem muuta teksti nii, et see algaks sõnaga Alajaotuses.... Veel võimalusi: Loendis..., Isikuartiklis..., ...

Kui malli kirjutada |sect={{{1|}}}, siis saab malli kasutaja ise määrata esimese teatekastis kasutava sõna: esimest nimetut argumenti kasutatakse teksti algusena. Näiteks {{Lisaviiteid|Alajaotuses}} tekitab sellise tulemuse:

Antud parameetri kasutamisel võta esimene sõna malli argumendist issue ära, sest muidu tekib see kahekordselt.

issue (probleem) ja fix (lahendus)

Parameeter issue on mõeldud artiklis sisalduva probleemi välja toomiseks. Soovitavalt võiks see olla lühike ja konkreetne ning sisaldada vikilinke vastavatele Vikipeedia abilehtedele.

Parameeter fix ütleb, mida artikli parandamiseks teha tuleb.

Kui malli kasutatakse kompaktses vormis (parameetri |small=left abil), siis näidatakse teatekasti sees vaid parameetris issue olevat teksti. Allolevas näites on kasutatud järgmisi parameetreid:

  • |issue=Artikkel kasutab '''ebaselget viitamisstiili'''.
  • |fix=Viiteid saab teistsuguse või ühtlustatud viitamisstiiliga, allmärkustega või välislinkidega selgemaks teha.

Tavasuuruses väljastab mall kogu teksti:

Kompaktses suuruses (parameetriga |small=left) näitab mall vaid argumendis issue olevat teksti:

talk

Osades artikli teadetekastides on link arutelulehele, samuti saab toimetaja määrata seonduva arutelulehe alajaotuse, et link viiks otse teemaga seotud arutelu juurde. Selle omaduse sisse lülitamiseks tuleb parameetri talk väärtus läbi lasta, näiteks nii: |talk={{{talk|}}}.

Malli kasutaja saab siis vastavat parameetrit (näites talk) kasutada järgmiselt:

  • |talk=ALAJAOTUSE PEALKIRI - link viib osutatud alajaotuse peale artikli arutelulehel, näiteks |talk=Teema
  • |talk=LEHEKÜLJE TÄISNIMI - link viib osutatud arutelulehe peale (mis võib sisaldada alajaotuse ankrut), näiteks |talk=Arutelu:Karlsson#Hei hopsti. Link võib olla teise artikli aruteluleht (peab asuma samas Vikipeedia nimeruumis).

Märkused:

  • Kui mall antud parameetrit kasutab, siis tekib arutelulehe link ka malli enda lehele (selleks, et omadust demonstreerida), kuid artiklite puhul tekib arutelulehe link vaid siis, kui parameeter pole tühi.
  • Kui soovid, et alati oleks link arutelulehele, siis kasuta |talk={{{talk|#}}}.
  • Kui arutelulehte pole olemas, siis ei teki ka linki, ükskõik mis väärtus parameetrile on antud.

date

Parameetri date mallist läbi laskmisel võib malli lisaja määrata teatekastile selle artiklile lisamise kuupäeva. Kuupäeva näidatakse kasti sees ülejäänud teksti järel väikses kirjas.

Antud parameetri läbi laskmine võimaldab antud malliga artikleid kuude kaupa kategoriseerida, juhul kui parameeter cat on ka väärtustatud.

cat

Antud parameeter määratleb kuupõhise kategooria nime. Kui on antud |cat=KATEGOORIANIMI, siis:

  • pannakse artiklid kategooriasse Kategooria:KATEGOORIANIMI (KUUPÄEV), juhul kui on antud |date=KUUPÄEV.
  • pannakse artiklid kategooriasse Kategooria:KATEGOORIANIMI, juhul kui kuupäeva pole antud.

Parameeter cat ei tohi olla vikilink, samuti ei ei tohi kasutada eesliidet Kategooria:

all

Parameeter all määratleb kategooria, kuhu asetatakse kõik artiklid.

Parameeter all ei tohi olla vikilink, samuti ei ei tohi kasutada eesliidet Kategooria:

Muud parameetrid

Paremal servas olevas kastis on ära toodud kõik malli parameetrid. Kuna kõiki parameetreid samaaegselt ei kasutata, siis pole soovitatav selle kasti kopeerimine uue malli aluseks.

Kõik parameetrid
{{Ambox
| name        = 
| subst       = <includeonly>{{subst:substcheck}}</includeonly>
| small       = {{{small|}}}
| type        = 
| image       = 
| imageright  = 
| smallimage  = 
| smallimageright = 
| class       = 
| style       = 
| textstyle   = 
| sect        = {{{1|}}}
| issue       = 
| talk        = {{{talk|}}}
| fix         = 
| date        = {{{date|}}}
| text        = 
| smalltext   = 
| cat         = 
| all         = 
| cat2        = 
| all2        = 
| cat3        = 
| all3        = 
}}<noinclude>
{{dokumentatsioon}}
</noinclude>

imageright (piltparemal)

Selle parameetriga saab anda teatekasti paremas servas asuva pildi. Süntaks on sama mis parameetril image, välja arvatud see, et vaikimisi pilt puudub.

smallimage (väikepilt) ja smallimageright (väikepiltparemal)

Nende parameetritega saab anda väikeses teatekastis kasutatavad pildid. Parameetrid töötavad vaid siis, kui on antud |small=left.

class

Teatekastile saab selle parameetriga lisada omaenda CSS-klassi nime.

style (stiil) ja textstyle (tekstistiil)

Need parameetrid võimaldavad lisada kohandatud CSS-koodi; kood ei tohi olla jutumärkide vahel (" "), kuid see peab lõppema semikooloniga (;).

  • style'i sees saab anda kogu teatekasti ruudu kohta kasutatava stiili.
  • textstyle'i sees olevat väärtust kasutatakse tekstikasti tekstiosa kohta.

text (tekst) ja smalltext (väiketekst)

Selle asemel, et kasutada parameetreid issue ja fix, saab kasutada ühte parameetrit text.

Kompaktse teatekasti teksti saab määrata parameetris smalltext.

Lisaparameetrid kategoriseerimise jaoks

  • Parameetritega cat2 ja cat3 saab anda kuupõhised lisakategooriad (sarnaselt parameetrile cat).
  • Parameetritega all2 ja all3 saab anda lisakategooriad, kuhu pannakse kõik kategooriad (sarnaselt parameetrile all).

Vaata ka

Mall {{Ombox}} – Kasutaja, Vikipeedia, MediaWiki, Malli, Portaali ja teiste nimeruumide teatekastide mall.