Help:Sjablonen

This page is a translated version of the page Help:Templates and the translation is 100% complete.
PD Let op: Als u deze pagina bewerkt, gaat u akkoord met het vrijgeven van uw bijdragen onder de CC0. Zie Helppagina’s Publiek Domein voor meer informatie. PD

Als u standaardtekst heeft die u in verschillende pagina's wilt opnemen, kunt u daarvoor functie sjablonen gebruiken. Anders dan bij extensies en mediabestanden is er voor sjablonen geen centrale bewaarplaats.

Sjablonen kunnen nieuw worden geschreven of, om dubbel werk te voorkomen, worden geëxporteerd uit een andere wiki, bijvoorbeeld Wikipedia, en dan in de bestemde wiki worden geïmporteerd.

Basisgebruik

Sjablonen zijn standaard wiki-pagina's waarvan de inhoud ontworpen is om te worden transcluded (ingebed) in andere pagina's. Sjablonen volgen de conventie dat de naam wordt voorafgegaan door "Template:", wat het aan die namespace toewijst. U kunt ze als iedere andere wiki-pagina aanmaken.

Om een sjabloon te transcluderen, gebruikt u dubbele open & sluit accolades {{sjabloonnaam}}.

Het meest eenvoudige gebruik van sjablonen gaat als volgt. Maak een pagina aan met de naam Template:Welcome met de volgende inhoud:

Hallo! Welkom bij de wiki.

U heeft uw eerste sjabloon gemaakt! Voeg nu de volgende code in een nieuwe pagina toe:

{{Welcome}}

Als de nieuwe pagina wordt getoond, dan wordt "Hallo! Welkom bij de wiki." getoond in plaats van {{Welcome}}. De inhoud van het sjabloon is ingebed in de getoonde pagina.

U kunt {{Welcome}} op elk punt op elke pagina plaatsen waar u iemand wilt verwelkomen. Stel dat dat op 100 pagina's wordt gedaan. Als u dan de inhoud van het sjabloon wijzigt naar:

Hallo allemaal! Welkom op onze mooie wiki.

en dan al die 100 pagina's opnieuw bezoekt waar het sjabloon gebruikt wordt, dan ziet u nu de nieuwe begroeting in plaats van de vorige. U past dus de inhoud van mogelijk heel veel pagina's aan zonder ze zelf per stuk te wijzigen, dit omdat de tekst van het sjabloon wordt overgenomen (transcluded) in deze pagina's.

Dit is de basis van het werken met sjablonen. Maar er zijn natuurlijk enkele aanvullende functies beschikbaar om het nog krachtiger te maken. Meestal zal het sjabloon een Engelse naam hebben, dus bijvoorbeeld Welcome, de Nederlandse naam wordt dan Welcome/nl. De tekst is dan een vertaling van de Engelse tekst.

Manieren om een sjabloon aan te roepen

Sjablonen kunnen op andere pagina's op de volgende manieren gebruikt worden:

  • {{Name}} : als boven beschreven, deze link (ook wel sjabloonaanroep genoemd) wordt automatisch vervangen door de huidige inhoud van het sjabloon [[Template:Name]] (ook wel transclusie genoemd) op het moment dat de betreffende pagina wordt geladen (dus bij het bekijken door een lezer van de wiki). Omdat de sjabloonaanroep in de bron van de pagina blijft staan zal een volgende wijziging van Template:Name worden gezien op een pagina die de sjabloonaanroep bevat. Ook wordt de pagina getoond op het overzicht met verwijzingen naar het sjabloon.
  • {{subst:Name}} : als dit wordt gebruikt dan wordt dit type sjabloon eenmalig en blijvend vervangen in de broncode van de pagina die het sjabloon [[Template:Name]] gebruikt op het moment dat de pagina met de link wordt opgeslagen. Dat betekent, dat de inhoud van Template:Name wordt gebruikt om de sjabloonaanroep te vervangen. Er wordt geen link onderhouden tussen de pagina en het sjabloon, beide kunnen dus zonder gevolg voor de ander worden gewijzigd. In feite is er weinig verschil tussen het vervangen van de inhoud op deze manier en het eenvoudigweg "handmatig" typen in de bron van de pagina. Zie Help:Substitution voor meer informatie.
  • {{safesubst:Name}} : dit is toegevoegd om het mogelijk te maken dat er een recursieve vervanging wordt gedaan als sjablonen aanroepen naar andere sjablonen of parserfuncties bevatten. Zie Help:Substitution voor meer informatie.
  • {{msgnw:Name}} : dit toont de inhoud van het sjabloon in een vorm die de ruwe wiki syntaxis toont (zoals ‎<nowiki> dat doet) bij het weergeven van de pagina die dit sjabloon bevat. Voorbeeld: {{msgnw:Template:Thankyou}} geeft:

<noinclude> <languages/> </noinclude> '''Een klein bedankje...''' voor {{{reason|{{{1}}}}}}. knuffel van {{{signature|{{{2}}}}}} <noinclude> [[Category:Template examples{{#translation:}}|{{PAGENAME}}]] </noinclude>

Een gewone wiki-pagina kan ook als sjabloon gebruikt worden, eenvoudig door de betreffende namespace aan te geven:

  • {{Template:Pagename}} transclude de pagina van sjabloon, gelijkwaardig aan [[Template:Pagename]]
  • {{Talk:Pagename}} transclude de pagina Talk:Pagename
  • {{:Pagename}} transclude de pagina Pagename in de main namespace.
    • {{subst::Pagename}} vervangt zichzelf met de inhoud van de pagina Pagename

Als de aangegeven namespace niet bestaat, dan wordt aangenomen dat de hele titel een sjabloon is:

  • {{Foo:Bar}} transclude Template:Foo:Bar

Ongeacht de syntaxis die wordt gebruikt, kan de naam van het sjabloon relatief zijn tot de huidige pagina Als bijvoorbeeld {{/bar}} op pagina foo wordt genoemd, wordt de pagina foo/bar ingevoegd.

Het kan ook dynamisch worden gegenereerd. Bijvoorbeeld, {{ {{foo}} }} roept Template:foo aan en interpreteert het resultaat als de naam van een ander sjabloon dat aangeroepen moet worden.


Parameters

Om het mechanisme van transclusion nog meer te versterken, staat MediaWiki parameters toe bij de aanroep van een sjabloon. Hiermee kan het sjabloon door de schrijver van het artikel worden aangestuurd afhankelijk van de context.

Neem aan dat u een klein bedankje wilt plaatsen in de overlegpagina van andere gebruikers, zoals:


Een klein bedankje... voor al uw inzet. knuffel van Frank Alberts


Het bedankje heeft dan een reden (voor al uw inzet) en een afzender (Frank Alberts). Het doel is dat iedereen, iedereen om een reden moet kunnen bedanken.

Een voordeel is dat een bedankje er overal (waar dan dit sjabloon wordt gebruikt) hetzelfde uitziet. U kunt bijvoorbeeld een sjabloon Sjabloon:Bedankt aanmaken. Het bedankje ziet er hetzelfde uit, maar de reden en degene die bedankt verschillen omdat het parameters zijn. Geef ze dan ook door als parameters. Als we de overige elementen even overslaan en het veld formatteren en de afbeelding plaatsen, dan is de inhoud van het (vertaalde) sjabloon ongeveer zo:

'''Een klein bedankje...'''
voor {{{1}}}.
knuffel van {{{2}}}

Let op het gebruik van {{{1}}} en {{{2}}}. Dat is hoe de parameters in het sjabloon bekend zijn. Opvallend is dat elke parameter tussen drie accolades {{{ }}} staat. Dit is anders dan het normale gebruik van de sjabloonnaam.

Als het sjabloon op een pagina wordt gebruikt, dan vult u de waarden van de parameters in, gescheiden door een verticale streep (|). In de MediaWiki kunt u parameters op drie manieren doorgeven: Anoniem, Nummer en Naam.

Anonieme parameters

Om de parameters anoniem door te geven vult u ze in volgorde in:

{{Thankyou/nl|al uw inspanningen|Frank Alberts}}

In dit geval ontvangt het {{Thankyou/nl}} sjabloon parameters {{{1}}}=al uw inspanningen en {{{2}}}=Frank Alberts, resultaat:


Een klein bedankje... voor al uw inspanningen. knuffel van Frank Alberts


De volgorde is zeer belangrijk voor de werking van het sjabloon. Als u ze in deze volgorde doorgeeft:

{{Thankyou/nl|Frank Alberts|al uw inspanningen}}

dan is het resultaat:


Een klein bedankje... voor Frank Alberts. knuffel van al uw inspanningen


Het identificeren van parameters op volgorde (met {{{1}}}, enz.) werkt alleen voor anonieme parameters. Parameters die met een naam worden doorgegeven, zoals hieronder, zijn in het sjabloon niet benaderbaar met een nummer.
Met een gelijk-teken in het argument van een anonieme parameter kan het worden aangezien als een parameter op naam (zie hieronder) de tekst ervoor is dan de parameter en de tekst erna de waarde. Dit kan voorkomen als u een externe link toevoegt of een HTML-element met attributen (zie taak T16235). De oplossing is dan om parameters op naam te gebruiken of genummerde parameters, zoals in de volgende sectie wordt uitgelegd.

Genummerde parameters

Om de parameter op nummer door te geven, identificeer elke parameter bij het doorgeven:

{{Thankyou/nl|2=Frans Alberts|1=uw vriendschap}}

Het sjabloon {{Thankyou/nl}} krijgt nu de parameters {{{1}}}=uw vriendschap en {{{2}}}=Frank Alberts, ze staan in de verkeerde volgorde maar worden op nummer doorgegeven, dus het resultaat is:


Een klein bedankje... voor uw vriendschap. knuffel van Frank Alberts


Dit kan ook nuttig zijn als een genummerde parameter een "=" teken bevat.
Voorbeelden
{{Thankyou/nl|1=adding “=”|2=Frank Alberts}}

Resultaat:


Een klein bedankje... voor adding “=”. knuffel van Frank Alberts

  Waarschuwing: Hierdoor moet elke parameter genummerd worden doorgegeven.

Parameters met een naam

de derde manier om parameter door te geven is doorgeven op naam. De inhoud van het sjabloon wordt dan:

'''Een klein bedankje...'''
voor {{{reason}}}.
knuffel van {{{signature}}}

In het sjabloon gebruiken we {{{reason}}} en {{{signature}}} om de paramter te identificeren, in plaats van een nummer. Om deze parameters door te geven op naam, wordt het:

{{Thankyou/nl|signature=Frank Alberts|reason=zijn wie u bent}}

In dit geval krijgt het sjabloon {{Thankyou/nl}} de parameters {{{reason}}}=zijn wie u bent en {{{signature}}}=Frank Alberts, het resultaat:


Een klein bedankje... voor zijn wie u bent. knuffel van Frank Alberts


Parameters op naam zijn hoofdlettergevoelig, dus:

{{Thankyou/nl|signature=Frank Alberts|Reason=zijn wie u bent|reason=zijn case-sensitive}}

Resultaat:


Een klein bedankje... voor zijn case-sensitive. knuffel van Frank Alberts


Het voordeel van het gebruik van een naam in uw sjabloon, naast dat het flexibel is bij de volgorde van doorgeven, is dat het uw sjabloon beter leesbaar maakt als er veel parameters zijn.

Spaties en nieuwe regels worden automatisch verwijderd aan het begin en einde van benoemde parameternamen en -waarden, maar blijven behouden in naamloze parameters.

Mengen van benoemde en onbenoemde parameters

Als het sjabloon dit ondersteunt, kunnen beide soorten parameters in één aanroep worden gebruikt.

For example, {{Thankyou|supporting both parameter types|signature=Me}} results in:


Een klein bedankje... voor supporting both parameter types. knuffel van Me


Be careful when doing this, because it can result in conterintuitive results as unnamed parameter counts are based only on the unnamed parameters, not the named parameters. For example, {{Thankyou|Me|reason=supporting both parameter types}} results in:


Een klein bedankje... voor supporting both parameter types. knuffel van {{{2}}}


The template is coded to prefer the named parameter for the reason over the unnamed parameter, resulting in the "Me" being lost and no signature being given. This results in a default value of {{{2}}} being shown, as explained below.

Standaardwaarden

Als u een sjabloon gebruikt maar u geeft niet de benodigde parameters mee, zoals hier:

{{Thankyou/nl}}

in het voorbeeld met genummerde parameters krijgt u het volgende:


Een klein bedankje... voor {{{1}}}. knuffel van {{{2}}}


Omdat er geen argumenten zijn meegegeven, gebruikt het sjabloon de parameters zelf, in plaats van de waarde. U kunt ook standaardwaarden voor een parameter aangeven, die worden dan gebruikt als de parameter niet wordt meegegeven.Voorbeeld met als inhoud van het sjabloon:

'''Een klein bedankje...'''
voor {{{reason|alles}}}.
knuffel van, {{{signature|Frank Alberts}}}

dan geeft de {{{reason|alles}}} aan dat als de parameter {{{reason}}} niet wordt meegegeven, dat dan de waarde alles wordt gebruikt. Bij de andere parameter gaat het op dezelfde manier. Met dit sjabloon krijgen we bij een aanroep van het sjabloon zonder meegegeven parameters:


Een klein bedankje... voor alles. knuffel van Frank Alberts


De waarde van een parameter kan een lege tekst zijn. Voorbeeld: in {{foo|bar=}} en {{foo|bar=|baz=qux}}, neemt het sjabloon 'foo' aan dat parameter bar de waarde "" heeft. Dit is iets anders dan de parameter weglaten, dan is het niet definieert en krijgt het de standaardwaarde zoals hierboven in beschreven.
If you need to treat an empty string the same way as a missing parameter, you can use a conditional operator through an extension like ParserFunctions. For instance, {{#if:{{{1|}}}|{{{1|}}}|undefined}} returns undefined if the parameter is either undefined or empty, while {{{1|undefined}}} does so only if the parameter is undefined.

Vaak wordt een standaardwaarde gebruikt om een alternatieve naam van de parameter te noemen. Voorbeeld, bij {{{a|{{{b|}}} }}}, het sjabloon zoekt eerst naar een parameter met de naam "a". Als die ontbreekt dan wordt de parameter met de naam "b" gebruikt. Als zowel "a" als "b" ontbreken, dan is er geen uitvoer.

Passing parameters to other templates

If raw parameter syntax is generated by the above template call, and then passed through to another template, it is not interpreted as a parameter. This means that {{Thankyou2 }}, which just calls {{Bedankt }} with no parameters, does not work: {{thankyou2|everything|me}} -> Een klein bedankje... voor {{{1}}}. knuffel van {{{2}}} .

You instead need to explicitly pass the parameter to the other template, i.e if {{Thankyou3 }} contains

{{thankyou|{{{1}}}|{{{2}}}}}}

then {{thankyou3|everything|me}} -> Een klein bedankje... voor everything. knuffel van me } works properly.

This example does not preserve emptiness vs. undefinedness in parameter values - you would need more complicated syntax if you wanted to do that.


Lege versus ongedefinieerde parameters

De {{t2demo|| a }} (zie {{T2demo }}), met een dubbele verticale lijn, stelt de eerste parameter in op een lege string in plaats van deze ongedefinieerd te laten. Het geeft de uitvoer start--middle- a -end, vergelijkbaar met hoe {{t2demo|1=|2= a }} resulteert in start--middle- a -end. Aan de andere kant, het expliciet instellen van de parameter "2" op "a", resulteert in het ongedefinieerd laten van de eerste naamloze parameter:

{{t2demo|2= a }} resulteert in start-{{{1}}}-middle- a -end

Indien de tweede parameter niet moet worden getrimd, moet deze niet worden genoemd.

Daarom kunt u een lege string aan de eerste parameter toewijzen, maar u kunt deze niet ongedefinieerd laten.

Het gelijkwaardig maken van Leeg en Ongedefinieerd

Een goede aanpak bij sjablooncodering is dat het doorgeven van een lege tekenreeks aan een parameter hetzelfde werkt als het niet toewijzen van een waarde. Dit maakt het gemakkelijker en consistenter.

Als u bijvoorbeeld p= gebruikt, kunt u laten zien dat een sjabloon een parameter "p" heeft die nog geen waarde heeft.

Als u een lege tekenreeks en een niet-gedefinieerde waarde hetzelfde wilt gebruiken, gebruikt u de volgende benaderingen:

  • Gebruik uitsluitend {{{p|}}} in plaats van {{{p}}} of q waarbij "q" een niet-lege waarde is.
  • Gebruik voorwaardelijke cheques zoals {{#if:{{{p|}}}|..{{{p}}}..|..}} om ervoor te zorgen dat {{{p}}} alleen wordt gebruikt als het een waarde heeft.

If for some reason you want to treat undefined parameters differently from empty parameters or any other possible value you can compare the same parameter twice with different defaults, i.e {{#ifeq:{{{foo|bar}}}|{{{foo|baz}}}|parameter is defined|parameter is undefined}}.

Gelijktekens gebruiken in parameters zonder naam

Naamloze parameters kunnen gelijktekens bevatten, maar dit moet indirect gebeuren. Hier zijn enkele methoden met gebruik van template:T1demo:

Een standaardwaarde voor een ongedefinieerde parameter

Een standaardwaarde toewijzen aan een ongedefinieerde parameter:

{{T1demo|{{{1| a=b }}}}}

Resultaat: start a=b end.

Met gebruik van de parserfunctie {{=}}

Gebruik een parserfunctie die veilig een gelijkteken bevat:

{{T1demo| a{{=}}b }}

Resultaat: start a=b end.

HTML-entiteiten

Vervang het gelijkteken met een HTML-entiteit voor weergave:

{{T1demo| a=b }}

Resultaat: start a=b end.

Dit geeft een correcte weergave zonder dat de andere parameters worden beïnvloed.

Omgaan met niet-overeenkomende accolades en vierkante haken

Niet-overeenkomende accolades ({{, }}) of vierkante haken ([[, ]]) moeten in nowiki-tags staan of HTML-entiteiten gebruiken:

  • Voor het renderen van accolades zijn er twee opties:
    • Gebruik <nowiki>{{</nowiki> of &#123; voor {
    • Gebruik <nowiki>}}</nowiki> of &#125; voor }.
  • Gebruik &#91; voor [ en &#93; voor ].

Hieronder volgen enkele voorbeelden:

Niet-overeenkomende accolades
{{T1demo| <nowiki>{{</nowiki>content<nowiki>}}</nowiki> }}

Hierdoor worden de accolades correct weergegeven zonder het sjabloon te breken.

Niet-overeenkomende vierkante haken
{{T1demo| text [link] more text }}

Hierdoor worden de accolades correct weergegeven zonder het sjabloon te breken.

Resultaat: start text [link] more text end

Niet-overeenkomende paren die niet in nowiki-tags zijn geplaatst, voorkomen sjabloonuitbreiding of worden gebruikt als accolades voor de sjabloonaanroep.

Hieronder volgen enkele voorbeelden:

{{T1demo|abc]]def[[ghi}}

Dit zal niet correct uitbreiden vanwege niet-overeenkomende accolades.

Het juiste gebruik:

{{T1demo|abc<nowiki>]]</nowiki>def<nowiki>[[</nowiki>ghi}}

Resultaat: startabc]]def[[ghiend

Template-generated brackets

An alternate technique for passing arguments with unmatched brackets is to wrap them in another template. In that situation, (which exists with {{(( }} and {{)) }}) on this wiki), the unmatched brackets will be rendered literally, and not decoded as another template call. For example:

{{t1demo|{{((}}t1demo{{))}}}}

results in: start{{t1demo}}end

When substituting a template, template inclusions are parsed once when the subst happens (with the same caveats explained above) and then a second time when rendering the resulting wikitext. For example:

{{subst:((}}t1demo|foo}}

will expand on save to:

{{((}}t1demo|foo}}

which will then render as:

startfooend

If the wikitext generated via the first subst itself includes "subst:" syntax it will not be processed on the same save, but may be on the next save. This technique may be used to implement recursive substitutions that take multiple saves to evaluate.

Using pipes in parameter values

A parameter value cannot contain a pipe character (|), because it would be interpreted as the end of that parameter and the start of the next parameter. This can be worked around by using the parser function {{!}}, or the HTML entity &124;. The two methods of doing this have slightly different behavior, which can be relevant in some corner cases like when a template is producing wikitable syntax.

Example: {{T1demo|abc|def}} produces: startabcend

The "def" doesn't display because it is treated as part of another unnamed parameter, which the template does not use.

{{T1demo|abc{{!}}def}} produces: startabc|defend

The "def" displays properly.

{{T1demo|abc|def}} produces: startabc|defend

The "def" displays properly again.

Formatting template calls using extra parameters

Since templates ignore parameters they are passed but do not handle specifically, they can be used as a way of a adding extra whitespace or unused content to the template call.

For example:

{{template name|foo|bar|baz|mumble|quux}}

is equivalent to, assuming the template doesn't recognize SPACEN as a parameter name:

{{template name|SPACE1=
|foo|SPACE1=
|bar|SPACE2=Random stuff
|baz|SPACE3=
   |mumble|SPACE4=
  quux
}}

It is also possible to use the same name for each spacer (often the empty string), but this will populate Category:Pages using duplicate arguments in template calls, which many wikis prefer to keep empty to catch instances of user error.

This can be used to make the template render in a way similar to its output, like showing each row of w:Template:Chess position on its own like to make the wikitext also look like a chessboard.

Tracking parameter usage


It may be wise for a template to add a link or category to a page if a certain parameter or combination of parameters is used, to make if possible to easily determine what pages are using a given parameter, and thus what the impacts of changing that parameter in the template would be.

Evaluatie proces

Dit wordt een wat geavanceerd gedeelte dat u kunt overslaan als u het niet echt nodig heeft.

In het algemeen worden de parameters van een sjabloon vervangen in sjabloon als de tokens worden uitgewerkt. Ze worden pas geëvalueerd bij het gebruik.

Dit heeft gevolgen.

  1. Als u een Template:Start heeft, die {{mytemplate bevat, en een Template:End die |foo=bar}} bevat, en {{start}}{{end}} op een pagina zet, wordt mytemplate niet transcluded, omdat tokens als "|" niet toegevoegd kunnen worden door een sjabloon en de speciale betekenis kunnen behouden in een sjabloon. U kunt sjablonen gebruiken om de naam van de parameter of sjabloon te sturen, maar u kunt geen aanroep van een sjabloon splitsen tussen verschillende sjablonen.
  2. Eliminatie van dode code. (Code die nooit wordt uitgevoerd.) Als u een sjabloon aanroep doet als {{foo|{{DISPLAYTITLE:Bar}} }} en Template:Foo bevat niet {{{1}}}, dan wordt de DISPLAYTITLE niet gebruikt, omdat het alleen wordt bekeken als het nodig is, er is geen parameter om er in te zetten. dus wordt het niet geëvalueerd. Dit speelt voornamelijk bij het gebruik van Extension:ParserFunctions, het kan vooral worden opgemerkt in combinatie met het magische woord int:, dat per taal verschilt. Dit is niet perfect, en in sommige gevallen, zelfs als het resultaat van het uitbreiden van een sjabloon niet wordt gebruikt (omdat het deel uitmaakt van een if-voorwaarde, bijvoorbeeld), kan het proces van het evalueren ervan nog steeds neveneffecten hebben. Bijvoorbeeld, alle links die worden geproduceerd of andere sjablonen die worden gebruikt, worden nog steeds toegevoegd aan Special:WhatLinksHere, zelfs als ze niet worden weergegeven.


Template parameters are pass by value, which means a template cannot modify its arguments. Parameters are treated as associative array, and parameter names are evaluated before parameter values. If the same parameter name is given more than once (either as named or unnamed), only the last instace is used, and the page is added to Category:Pages using duplicate arguments in template calls.

Aanroepen van een sjabloon die starten met het magisch woord subst: of met safesubst: worden geëvalueerd in een afzonderlijke eerste verwerking die alleen wordt gedaan bij het opslaan, samen met ~~~~ en links met de verticale streep (pipe) truc. Als ze dan niet kunnen worden geëvalueerd, dan wordt de subst: genegeerd en worden de safesubst: behandeld alsof het een normaal sjabloon is.

Veel parser-functies, tags en transcluded speciale pagina's worden niet direct ingevoegd zoals sjablonen maar worden vervangen door een "strip marker". Dit betekent dat u de resultaten niet kunt manipuleren met parser-functies als padleft: en vergelijkbare functies in extensies, die zien de 'strip marker' in plaats van het resultaat van de parser-functie.

Recursie in sjablonen

Het gebruiken van een sjabloon in het sjabloon zelf zorgt er niet voor dat de MediaWiki in een oneindige lus terecht komt. MediaWiki stopt met een recursie als de naam van het sjabloon vet is. Voorbeeld, als de inhoud van Template:Aaaa is a {{Aaaa}} z, dan toont het "a a Template loop detected: Template:Aaaa z z".

Deze beveiliging sluit het mogelijk handig gebruik van sjabloon uit waar het sjabloon zelf de eigen aanroep argumenten normaliseert. In dit verboden voorbeeld kan template:d worden aangeroepen als {{d|20200311}} en als {{d|y=2020|m=3|d=11}}. Op de eerste manier, roept het zichzelf aan met de structuur van het tweede argument (verkregen met parserfuncties), die daarna een verenigd pad van verwerking volgen.

{{#if:{{{1|}}}|{{d|y={{#sub:{{{1}}}|0|4}}|m={{#sub:{{{1}}}|4|2}}|d={{#sub:{{{1}}}|6|2}}}}|<!-- processing path with arguments y,m,d regardless of original call pattern -->}}

Als template:d aangepast is voor recursie in template:d/2 en template:d/2 is een identieke handmatige kopie van template:d dan werkt deze manier goed als de beveiliging van de recursie dynamisch werkt en niet statisch.

Een manier voor de MediaWiki software om deze regel wat losser te maken zou het eisen zijn dat elke recursieve aanroep een verschillend aantal argumenten heeft en er maximaal een recursieve aanroep is met een gelijk aantal argumenten. Dat zou een sterke beveiliging zijn tegen een oneindige reeks aanroepen waardoor bruikbare manieren als hier beschreven toch gebruikt kunnen worden.

Als het verwerkingspad eenvoudig is, dan is een simpele oplossing alleen een sjabloon te gebruiken voor elke aanroepconventie op een gescheiden if/else tak, waarbij de logica dubbel in het verwerkingspad zit. Als het meer complex is, kan elke aanroepstructuur in een implementatie sjabloon worden gezet met een standaard aanroepstructuur die het uiteindelijke sjabloongedrag geeft.

Parameters met een tabel

Aangezien het pipe-teken (|) en het gelijkheidsteken (=) verschillende betekenissen hebben in sjabloonaanroepen en wikitabellen, moet men, om tabelopmaak te gebruiken in de waarde van een sjabloonparameter, over het algemeen die tekens escapen (d.w.z. ze beschermen tegen interpretatie als sjabloonopmaak) met behulp van speciale reeksen:

  • het ingebouwde magische woord {{!}} biedt sinds MediaWiki 1.24 een "escaped" versie van |
  • het ingebouwde magische woord {{=}} biedt sinds MediaWiki 1.39 een "escaped" versie van =

Voor de introductie van deze magische woorden gebruikten veel wiki's sjablonen om dezelfde dingen te bereiken. Op een wiki hebben de magische woorden voorrang op de gelijknamige sjablonen.

Voorbeeld tabel

A B C
A1 B1 C1
A2 B2 C1

Tabelcodeː

{| class=wikitable
!A!!B!!C
|-
|A1||B1||C1
|-
|A2||B2||C1
|}

Escaped tabelcodeː

{{{!}} class{{=}}wikitable
!A!!B!!C
{{!}}-
{{!}}A1{{!}}{{!}}B1{{!}}{{!}}C1
{{!}}-
{{!}}A2{{!}}{{!}}B2{{!}}{{!}}C2
{{!}}}

Merk op dat het eerste linker accolade ({) wordt geïnterpreteerd als een letterlijk linker accolade omdat het onmiddellijk wordt gevolgd door het magische woord van {{!}}. Op dezelfde manier wordt de laatste rechter accolade (}) geïnterpreteerd als een letterlijk rechter accolade omdat het onmiddellijk wordt voorafgegaan door hetzelfde toverwoord. In sommige gevallen veroorzaken deze accoladetekens echter problemen, dus sommige wiki's bieden ook sjablonen om aan deze tekens te escapen:

  • De sjabloonoproep {{(}} kan een "escaped" versie van { bieden
  • De sjabloonoproep {{)}} kan een "escaped" versie van } bieden

Sommige wiki's gaan nog verder en bieden andere sjablonen voor het gemak zoals {{(!}}, {{!)}}, {{!!}}. Op zo'n wiki kan de code een beetje vereenvoudigd worden tot deze vorm:

{{(!}} class{{=}}wikitable
!A!!B!!C
{{!}}-
{{!}}A1{{!!}}B1{{!!}}C1
{{!}}-
{{!}}A2{{!!}}B2{{!!}}C2
{{!)}}

Sjabloon inclusie beheren

Standaard wordt de gehele inhoud van het sjabloon getoond, zowel als het sjabloon wordt getoond als wanneer het via een pagina waarin dat sjabloon wordt gebruikt, gaat. De pagina van het sjabloon, wanneer deze rechtstreeks wordt bekeken, ziet er precies zo uit als het sjabloon zou worden weergegeven, zonder enige parameters. Als de template parameters vereist om goed te functioneren, zal dit leiden tot fouten in de syntaxis of van de ruwe wikitext. Bijvoorbeeld:

  • Als een parameter geen standaardwaarde heeft, wordt deze als de letterlijke tekst {{{1}}} weergegeven, wat aangeeft dat het sjabloon een parameter nodig heeft.
  • Als een parameter een lege standaardwaarde heeft (het wordt geschreven als {{{1|}}}), wordt er niets weergegeven, wat het beoogde effect bereikt, maar geen duidelijkheid voor zelfdocumentatie heeft. Het gebruik van een niet-lege standaardwaarde zoals {{{1|afbeelding}}} kan de rol van een parameter verduidelijken, vooral voor sjablonen met afbeeldingen.
  • Als een parameter zonder standaardwaarde wordt doorgestuurd naar de #expr parserfunctie, resulteert het in een foutmelding: "Expressiefout: niet-herkend punctuatie karakter '{'."
  • Als een sjabloon een tabel creëert, is het nuttig voor de sjabloonpagina om de structuur van de tabel te tonen in plaats van de wikitext die werd gebruikt om deze te maken.Om dit te doen, is de tabel syntaxis niet in tags ingesloten, en elk tabel element bevat zowel de delen ‎<noinclude>...‎</noinclude> en ‎<includeonly>...‎</includeonly> waar nodig.

U kunt echter bepalen welke delen van een sjabloon worden gezien en opgenomen door het gebruik van de tags ‎<noinclude>, ‎<includeonly> en ‎<onlyinclude>.

Alles tussen ‎<noinclude> en ‎</noinclude> wordt alleen getoond als de pagina van het sjabloon wordt getoond, dus niet als het sjabloon in een pagina is gebruikt. Dit is handig als u tekst of code wilt toevoegen in een sjabloon die u alleen in de sjabloon pagina wilt tonen, zoals:

  • Categorieën links bij het categoriseren van het sjabloon zelf
  • interlanguage links naar vergelijkbare sjablonen in een andere taal
  • Uitleg over hoe een sjabloon te gebruiken Het is een veelvoorkomend patroon op sommige wiki's om een sjabloon als {{Documentation/nl }} te gebruiken om de documentatie van een subpagina van het sjabloon te transcluderen. Bijvoorbeeld, Template:Void is gedocumenteerd als Template:Void/doc.

Op een vergelijkbare manier wordt alles tussen ‎<includeonly> en ‎</includeonly> verwerkt en getoond alleen als het sjabloon op een pagina wordt gebruikt en niet op de sjabloon-pagina zelf, dat kan nuttig zijn als:

  • Categoriseer pagina's die het sjabloon includen. NB: bij het wijzigen van de categorieën die aan een sjabloon zijn toegekend op deze manier kan het wijzigen wat later plaatsvinden: dit wordt afgehandeld in via de wachtrij . Om het herindelen direct te forceren voor een bepaalde pagina, open die pagina voor wijzigen en sla de pagina zonder wijziging op.
  • Het er zeker van zijn dat de sjablooncode niet uitgevoerd wordt bij het bekijken van de sjabloon-pagina zelf. Dit is omdat het parameters verwacht en uitvoering zonder parameters geen goed resultaat zal geven.

Alles buiten ‎<noinclude> en ‎<includeonly> wordt verwerkt en normaal getoond; zowel als de sjabloon-pagina wordt getoond als een pagina wordt getoond waarin dat sjabloon wordt gebruikt. De aandacht gaat naar wat er binnen die tags staat.

Alles buiten de ‎<onlyinclude> tags wordt weggelaten bij de transclusie. Ook secties binnen includeonly worden overgeslagen bij de transclusie als ze tenminste niet ook de tags onlyinclude gebruiken. De aandacht gaat naar wat er binnen die tag staat.

For example, if a page like Help:Templates/onlyinclude demo has the wikitext:

abc<onlyinclude>def</onlyinclude>ghi<includeonly>jkl</includeonly>

The result of transcluding it is def.

Deze tags kunnen ook genest worden.

De drie gedeeltelijke transclusie tags maken elke combinatie mogelijk wat er verwerkt en opgebouwd wordt voor weergave. Ook commentaar vervult een rol. Inclusie-tags worden gerespecteerd bij het gebruik van {{subst:templatename}}, maar ze worden niet gerespecteerd bij het gebruik van {{msgnw:templatename}} omdat dat de ruwe wikitekst weergeeft zonder enige verwerking.

Section transclusion

To transclude different sections of a template on different pages, you can wrap the content in onlyinclude tags and use an if statement on parameters to select which section.

Consider "Template:Example" with this wikitext:

== Section 1 ==
{{#ifeq:{{{1|1}}}|1|
Content of section one.
}}
{{#ifeq:{{{1|1}}}|1|
== Section 2 ==
Content of section two.
}}

This will render both sections on the example page itself, and allow other pages to transclude the first section with {{example|1}} and the second section with {{example|2}}.

Another approach is to use literal parameter syntax instead:

{{{section1|
== Section 1 ==
Content of section one.
}}}
{{{section2|
== Section 2 ==
Content of section two.
}}}

Transclude the first section with {{example|section2=}} and the second section with {{example|section1=}}. If neither parameter is used, then both sections will display.

A third approach is to use Labeled Section Transclusion.

Sjablonen organiseren

Om een sjabloon nuttig te maken moet een schrijver van een artikel het sjabloon kunnen vinden en kunnen opzoeken hoe het gebruikt kan worden.

Om te zoeken kan een schrijver:

  1. Klik op Speciale pagina's > Alle pagina's
  2. In de lijst Naamruimte:, kies Template en klik op OK.

Om informatie te geven over het gebruik, voeg op de sjabloon-pagina een voorbeeld toe zoals deze:

<noinclude>
== Gebruik ==
Welkom gebruikers:
{{Thankyou/nl|reason=uw reden|signature=uw naam}}
</noinclude>

Een schrijver kan de aanroep van het sjabloon dan simpel kopiëren en in het eigen artikel gebruiken.

Tijdens het bewerken van een pagina is er een lijst met alle gebruikte sjablonen beschikbaar onder het bewerkingsformulier, in een inklapbare sectie met de titel "Op deze pagina gebruikte sjablonen:" (ook wel "In deze voorvertoning gebruikte sjablonen:" of "In deze sectie gebruikte sjablonen:" genoemd, afhankelijk van de context). Deze lijst bevat een handige koppeling naar de pagina van de sjabloon en informatie over de beveiligingsstatus. Doorverwezen sjablonen worden cursief weergegeven, waarbij het omleidingsdoel als een afzonderlijk lijstitem wordt toegevoegd.

Linken naar een sjabloon

Een sjabloon-pagina kan naar elke wiki-pagina linken, dit gaat op dezelfde manier. Voorbeeld, de link Template:Navbar wordt gegenereerd door de wikicode [[Template:Navbar]] te gebruiken.

Op veel wiki's kan Template:Tl worden gebruikt voor een link naar een sjabloon geformatteerd op een manier die de "dubbele accolades" wikicode toont die nodig is om het sjabloon te transcluden zonder dat dan ook te doen. Voorbeeld, de code {{tl|Navbar}} kan worden gebruikt om de link {{Navbar/nl }} te maken.

Deze constructie wordt meestal gebruikt bij het refereren aan sjablonen in de sjabloondocumentatie, help-pagina's en overleg-pagina's. Dit effect kan ook worden bereikt met gebruik van {{[[Template:Navbar|Navbar]]}}, maar bij manier {{Tl }} is minder tikwerk nodig. Op elke wiki met het sjabloon Tl, kan het wel/geen uitvoer opleveren van tekst in een "code-element" of als monospace-type. Indien niet (zoals op deze wiki), kan een ander sjabloon met een vergelijkbare naam dat doen. Een voorbeeld staat in de "See also" section of our Template:Tl documentation.

Template naming

The name of a template is case-sensitive excluding the first character.

You make redirects for alternate capitalizations. For example, if a template is named "AdminAbbr", you can create a redirect named "Adminabbr". This way, the template can be called with either {{AdminAbbr}} or {{adminabbr}}. If an editor prefers a mix of upper and lower case for clarity, they can use functions like lc or uc. For instance, instead of {{CURRENTINTERNETTIME}}, they could use {{ {{uc:CurrentInternetTime}} }}

Because template names are interpreted in the same way to the names of other pages, underscores are replaced with spaces, and any text after a number sign (what would be a anchor in a standard link) is ignored.

An underscore _ can be alternative to a blank space.

Possible uses of templates

Templates can be used for any situation in which one wants two or more pages to contain identical or similar content that is edited together rather than independently. They can be used to:

  • Provide structured elements on many pages, like infoboxes, maintenance templates, navigational boxes, etc.
  • Perform calculations used as a programming tool on various pages, like w:Template:Sum.
  • Build composite pages that display the content of multiple existing pages together, like w:WP:Village pump (all) which includes content from each section of the village pump. The content of these pages can either be shown individually, or together, but the revision history, watchlist, etc. will only pick up changes to the transcluded pages and the raw wikitext of the composite page itself, not implicit changes to the composite page.
  • Share some content between a few related pages. For example, the list at Help:Preferences#Beta features is duplicated at Beta Features#Current Beta Features. While on MediaWiki.org that is built using Extension:LabeledSectionTransclusion instead, it could have been done using a template.
  • Store content referenced multiple times on the same page, so it only has to be written and calculated once. For example w:Template:Cite Monumentenregister/URL is called twice by w:Template:Cite Monumentenregister in two different places, and using another template means the URL pattern only has to be written once in the base template.
  • Use templates as a programming element to generate a loop: if Template:A calls Template:B 10 times with different parameters, then that crudely simulates a for loop. If Template:B calls Template:C 10 times, then you have a nested loop of 100 calls of Template:C. But keep in mind that it is easy to run into the template limits when using templates as advanced programming constructs, and using Scribunto is generally clearer and easier to follow.

Van een wiki naar een andere wiki kopiëren

It is possible, if allowed by the wiki configuration to transclude templates from other wikis. This configuration setting is disabled on Wikimedia wikis. Otherwise, you need to manually copy the template and its dependencies from the source wiki to the destination wiki to use it.

Bij een sjabloon is vaak CSS of een ander sjabloon verplicht, zodat gebruikers vaak moeilijkheden hebben bij het kopiëren van sjablonen van de ene wiki naar een andere wiki. Hieronder een uitleg die voor de meeste sjablonen wel zal werken.

MediaWiki code

Als u mag importeren (u heeft het recht importupload) op de nieuwe wiki:

  1. Ga naar Special:Export op de originele wiki en download een xml-bestand met de complete geschiedenis van alle benodigde sjablonen, dit gaat als volgt:
    • Vul de naam van het sjabloon in het grote tekstveld, bijvoorbeeld "Template:Welcome". Let goed op het gebruik van hoofdletters en speciale tekens. Het exporteren kan lukken met een niet helemaal goede naam maar het xml-bestand bevat dan niet de gegevens die het moet bevatten.
    • Selecteer het veld "Sjablonen toevoegen".
    • Selecteer het veld "Alleen de laatste versie, niet de volledige geschiedenis".
    • Klik op "Exporteren".
  2. Ga naar Special:Import op de nieuwe wiki en upload het xml-bestand.

Als u op de nieuwe wiki niet mag importeren:

  1. Ga in de originele wiki naar het sjabloon wat u wilt kopiëren. Ga naar de pagina om het te bewerken en kopieer alle wikitext.
  2. Op de nieuwe wiki, ga naar de pagina met dezelfde naam als het gekopieerde sjabloon. Kies aanmaken/bewerken plak de tekst. In de wijziging samenvatting van het sjabloon link naar de originele pagina voor de toeschrijving.
  3. Terug naar de originele wiki op het bewerkscherm, onder het wijzigveld, kijk naar de lijst "Sjablonen op deze pagina gebruikt". Voer voor elk genoemd sjabloon deze instructies uit, als die sjablonen nog niet bekend zijn op de nieuwe wiki. Kijk ook of er in de overgezette sjablonen nog gebruikte sjablonen zijn die nog onbekend zijn op de nieuwe wiki. Dit gaat door totdat u geen op de nieuwe wiki onbekende sjablonen meer vindt in deze sjablonen.

Zo kopieert u alle nodige code, het zal genoeg zijn voor enkele sjablonen. Merk op dat alleen pagina-elementen verwerkt bij het opbouwen van de pagina worden geëxporteerd, dat betekent dus dat bijvoorbeeld documentatie subpagina's niet worden geëxporteerd. Indien het niet werkt, controleer dan of er rode links genoemd worden bij "Pagina's opgenomen in de huidige versie van deze pagina", onderaan het wijzigingsveld. Als die er zijn herhaal dan de eerder genoemde stappen voor deze pagina's en kopieer de code in de modules.

Naar het succesvol importeren van het sjabloon en alle gelinkte sjablonen van de andere wiki, kunt u het aanpassen als het nodig is voor uw eigen wiki. Dat zou kunnen zijn, een eigen logo, het snoeien van onnodige categorieën en het bekijken van rode links.

Extensies

Een extensie die vaak in sjablonen wordt gebruikt is ParserFunctions. Bezoek pagina Help extension ParserFunctions en kijk of een van de genoemde functies wordt gebruikt in de sjablonen die u heeft gekopieerd. Als dat zo is, installeer dan de extensie ParserFunctions als die nog niet is geïnstalleerd. U heeft voor het installeren de rechten van een systeembeheerder nodig op de server van uw MediaWiki installatie.

Er kan ook afhankelijkheid zijn in de sjablonen, vooral op Wikipedia, door Lua. Als er {{#invoke: }} in de code van het sjabloon zit, dam lijkt dat waarschijnlijk. Als het wordt gebruikt, installeer dan (als die er nog niet is) de extensie Scribunto , hiervoor zijn weer de rechten van een sysbeheerder nodig. Bekijk die pagina voor meer instructies over het installeren en het gebruik.

CSS en JavaScript code

Naast MediaWiki code maken veel sjablonen ook veel gebruik van CSS en sommige vertrouwen op het werken van JavaScript. Als de overgezette sjablonen niet zoals verwacht werken, controleer dan deze punten. Om de benodigde CSS en JavaScript over te zetten zult u wel weer beheerdersrechten nodig hebben, want u wijzigt systeemberichten in de "MediaWiki:" namespace.

  1. Kijk naar het gebruik van CSS classes (teksten als class="foobar") in de tekst van het sjabloon. Indien die classes in "MediaWiki:Common.css" of "MediaWiki:Monobook.css" staan op de originele wiki, kopieer die classes naar "MediaWiki:Common.css" in de nieuwe wiki en controleer of het sjabloon nu goed werkt.
  2. als het gekopieerde sjabloon nog altijd niet op de gewenste manier werkt, controleer dan of er code in "MediaWiki:Common.js" of "MediaWiki:Monobook.js" is op de originele wiki. Als die er is, probeer dan die te kopiëren naar "MediaWiki:Common.js" op de nieuwe wiki. Normaal is het een goed idee om allen code te kopiëren uit code die u vertrouwd en die code eerst te bekijken om te zien welk deel relevant is. Let op het aanwezige commentaar dat mogelijk aanwijzingen geeft over de functionaliteit van dat deel van de code.

Doorverwijzing

If a page uses a redirect as a template, the redirect is resolved before processing the template and the target is used instead. This won't work if the target doesn't exist (a broken redirect), or is itself a redirect (a double redirect).

A page that just includes another page as a template might look like a redirect, but there are several differences between them:

  • The header of the result displays the title of the page it came from.
  • No "Redirected from" message is shown.
  • Buttons like edit, watch, talk, history, "what links here," and "last modified" point to the referring page. To access the target page, use a section edit link and navigate from there.
  • Unless includeonly and/or noinclude tags are used, the referring page shares the same categories as the target page.
  • "Double redirects" work when one or both are this type of pseudo-redirect.
Embedding works on pages that support redirects and doesn't work on pages without it.

Parser functions

Belangrijkste pagina: Help:Parser functions

MediaWiki also supports parser functions, which function similarly to templates but follow slightly different syntax:

  • Parser functions utilize a ":" instead of the initial "|".
  • An edit page does not display parser functions used on that page.
  • There is no "What links here" feature for parser functions to identify the pages where they are utilized.
  • Parser functions templates do not generally accept named parameters, so equal signs generally have no special significance. For example:
{{ #if: not blank | x=abc }} gives x=abc

Zie ook

Gebruik sjablonen in het algemeen


Speciale constructies in sjablonen


Overige informatie