Sjabloon:Dokumentasietoets/doc

Hierdie blad is die {{Dokumentasie}}sjabloon.

Vir meeste van die instruksies oor hoe om die sjabloon te gebruik, sien sjabloondokumentasie.

Hierdie sjabloon vertoon 'n groen dokumentasiekas nes die een wat jy nou sien, en laai outomaties vanaf 'n /doc-subblad. Dit kan ook die inhoud vanaf ander plekke laai indien dit so beveel word.

Die sjabloon in is geoormerk vir die dokumentering van sjablone en ander blaaie wat deurgetrek word na ander blaaie. Dit kan gebruik word in die sjabloonnaamruimte en meeste ander naamruimtes.

Gebruik van die sjabloon laat sjablone toe om beskerm te word waar nodig, terwyl enigeen toegelaat kan word om die dokumentasie en kategorieë te wysig.

Gebruik

Normaalweg word hierdie sjabloon gebruik sonder enige parameters, geplaas onderaan die sjabloon of blad wat gedokumenteer word, binne 'n <noinclude>...</noinclude> houer:

<!--Laaste reël van jou sjabloonkode--><noinclude>
{{Dockumentasie}}
<!-- Voeg kategorieë by tot die /doc subblad en interwiki's in Wikidata, nie hier nie! -->
</noinclude>

Dan laai hierdie sjabloon outomaties die inhoud vanaf die /doc subblad of die sjabloon waarin dit gebruik word.

Die sjabloon kan ook die inhoud vanaf enige ander blad laai, soos hieronder:

<!--Laaste reël van jou sjabloonkode--><noinclude>
{{Dokumentasie|Sjabloon:Ander blad/doc}}
</noinclude>

Neem kennis dat met die laai van die dokumentasie vanaf 'n verskillende blad as die plaaslike /doc blad dit moeilik raak om die kategorieë te bewerk.

Die inhoud kan ook direk ingevoer word as teks, soos hieronder:

<!--Laaste reël van jou sjabloonkode--><noinclude>
{{Dokumentasie
 | inhoud =
(dokumentasie)
}}</noinclude>

Met gebruik van die |inhoud=parameter, vertoon die doc-kas normaalweg nie die [wysig] en [skrap]-skakels links in die boonste regterhoek nie. Neem kennis dat indien die /doc-blad bestaan, 'n skakel steeds vertoon sal word in die kas onderaan die doc-kas.

Parameter |1= en die |inhoud= parameter kan ook gekombineer word, soos hieronder:

<!--Laaste reël van jou sjabloonkode--><noinclude>
{{Dokumentasie|1=Sjabloon:Enige blad/doc
| inhoud =
{{Sjabloon:Enige blad/doc |parameters}}
}}</noinclude>

Dan word die bladnaam wat as parameter 1 gevoer word gebruik vir die [wysig]- en [skrap]-skakels en vir die /doc-skakel in die skakelkas onder die doc-kas. Maar die inhoud parameter word gebruik vir die inhoud wat in die doc kas vertoon word. Die boonste kode beteken dat die inhoud ingetrek word as {{parameters|Sjabloon:Enige blad/doc|parameters}}. In hierdie voorbeeld word 'n parameter ook die /doc-blad gevoer wat hier gelaai word.

Beste praktyk

Die dokumentasiekode moet onderaan die sjabloonkode gevoeg word, met geen spasie voor <noinclude> nie - dit sal ekstra spasies tot gevolg hê in die blaaie waar die sjabloon gebruik word.

Kategorieë wat van toepassing is op die sjabloon self moet aan die onderkant van die /doc-sublad gevoeg word, binne <includeonly>...</includeonly> merkers. Interwiki-skakels wat op die sjabloon van toepassing is moet gelys word by d:|Wikidata]] (meer by wp:Wikidata). Vir meer ingewikkelde gevalle sien Wikipedia:Sjabloondokumentasie#Kategorieeë en interwiki-skakels.

Indien die dokumentasieblad <includeonly>- of <noinclude>-merkers bevat as deel van die sigbare dokumentasieteks, vervang die "<" met "<".

Opskrif

Indien binne die sjabloonnaamruimte, sal die sjabloon die volgende opskrif wys:

Sjabloondokumentasie

In meeste ander naamruimtes, soos "Wikipedia:", sal dit die volgende opskrif wys:

Dokumentasie

Maar indien op Lêerblaaie (afbeelding) sal dit die volgende wys:

Opsomming

Die opskrif-parameter kan gebruik word om die opskrif te verander. Byvoorbeeld:

{{Dokumentasie|opskrif=Inligtingkasdokumentasie}}

Indien die opskrif-parameter leeg gelos word maar gedefinieer word, sal geen opskrif vertoon word nie asook geen [wysig] [skrap]-skakels nie. Byvoorbeeld:

{{Dokumentasie |opskrif=}}

Die opskrifstyl-parameter kan opsionele CSS-waardes gevoer word. Sonder aanhalingstekens " " maar met kommapunte ; aan die einde van elke stelling. Byvoorbeeld:

heading-style=font-size:150%;color:red;

Skakelkas

Onder die groot doc-kas is 'n klein skakelkas wat metadata oor die dokumentasie vertoon. Die skakelkas vertoon verskillende items afhangend van wat aan die parameters vir die sjabloon gevoer word en watter naamruimte gebruik word. In sekere gevalle word die skakelkas glad nie vertoon nie.

Om die skakelkas te verberg, voeg die parameter |skakelkas=af by.

Jou kan ook pasgemaakte teks in die skakelkas plaas, deur die |skakelkas=-parameter te definieer. Byvoorbeeld: |skakelkas=Hierdie dokumentasie word outomaties gegenereer deur [[Sjabloon:Inligtingskas]]

Outomatiese funksies

Indien die dokumentasieblad nog nie bestaan nie, sluit die [skep]-skakel 'n vooraflaaiblad in, sodat as daarop geklik word 'n voorafingevulde dokumentasieblad met die basiese dokumentasiebladformaat in die redigeerder oopgemaak word. Vooraflaaiteks word ook gebruik vir die /sandput en /toetsgevalle se [skep]-skakels.

Wanneer hierdie sjabloon op 'n beveilgde sjabloonblad voorkom, sal dit outomaties {{pp-template}} byvoeg, wat die grys of rooi hangslot in die regter boonste hoek vertoon. dit is dus nie nodig om self die Sjabloon:Tld-sjabloon by te voeg met die gebruik van {{Dokumentasie}} nie.

Wanneer die sjabloon in 'n /sandput-subblad gebruik word sal dit outomaties die {{Template sandbox notice}} byvoeg.

Onderwerpnaamruimtes vs. bespreeknaamruimtes

Terminologie: Onderwerpnaamruimtes is die teenoorgestelde van bespreeknaamruimtes. Byvoorbeeld "Sjabloon:" is die onderwerpruimte van "Sjabloonbespreking:".

Hierdie sjabloon word normaalweg in 'n onderwerpnaamruimte geplaas, binne <noinclude>-merkers. In sommige gevalle is die sjabloon nodig op die besprekingsblad:

• Binne die Mediawiki-naamruimte, sedert <noinclude> gereeld nie werk in stelselboodskappe nie, en sedert die Mediawiki-naamruimte skoon gehou moet word vir goeie werkverrigting.

Indien op besprekingsblaaie geplaas word, word die sjabloon normaalweg naby aan die bokant van die blad geplaas en sonder <noinclude>...</noinclude>-merkers.

Die /doc-, /sandput- en /toetsgevalle-blaaie sal normaalweg in die onderwerpnaamspasie voorkom, behalwe by naamspasies wat nie die MediaWiki subbladkenmerk ingeskakel het nie: Hoof, Lêer, Mediawiki en Kategorie. (Tans word slegs die /sandput- en /toetsgevalle-skakels vertoon vir Gebruiker-, Gebruikerbesprekings-, Sjabloon- en Sjabloonbesprekingsnaamruimtes.) Daar is ook 'n hele aantal ander tegniese redes hoekom die /doc-blad onder die besprekingsblad gestoor moet word vir daardie (en slegs daardie) naamruimtes.

Die sjabloon wys outomaties sy [skep]-skakel vir die /doc, /sandput en /toetsgevalle na die korrekte naamruimte.

Toets

Jy kan die uitset vir 'n gegewe blad simuleer deur die |blad=-parameter te gebruik. Byvoorbeeld, indien jy die kode |blad=Sjabloon:Inligtingskas gebruik, sal die sjabloon optree asof dit op die blad Sjabloon:Inligtingskas is, met die vertoon van die dokumentasie vanaf Sjabloon:Inligtingskas/doc daarby ingesluit en ook onder andere die skakel na Sjabloon:Inligtingskas/sandput. Die parameter is handig vir toetsdoeleindes en word intensief gebruik op die moduletoetsgevalleblad.

Tegniese besonderhede

Die vooraflaaiblad vir die /doc se [skep]-skakel is Sjabloon:Dokumentasie/vooraflaai. Die vooraflaaiblaaie vir die /sandput en /toetsgevalle se [skep]-skakels is Sjabloon:Dokumentasie/vooraflaai-sandput en Sjabloon:Dokumentasie/vooraflaai-toetsgevalle.

Vir verder inligting, sien die besprekingsblad.

Volledige sintaks

{{Dokumentasie}}

{{Dokumentasie
 | inhoud =
}}

{{Dokumentasie
| [roete na dokumentasieblad]
| opskrifstyl = 
| opskrif = 
| skakelkas = 
}}

Sien ook

• {{Dokumentasie subblad}}, 'n kennisgewing wat boaan 'n /doc-subblad geplaas word om sy rol te verduidelik asook om 'n skakel te verskaf na die blad wat gedokumenteer word.
• Wikipedia:Sjabloondokumentasie is 'n selfhelpgids tot sjabloondokumentasie.
• Wikipedia:Sjabloonsandputte en -toetsgevalle verduidelik die gebruik van die /sandput- en /toetsgevalle-subblaaie en sluit meer inligting in oor die toets van sjablone.