Hulp: sjablonen

Van Wikipedia, de gratis encyclopedie
Spring naar navigatie Spring naar zoeken

Een sjabloon is een pagina die, gebaseerd op het principe van transclusie, de integratie van veelgebruikte elementen in andere pagina's vergemakkelijkt. Sjablonen maken deel uit van de bouwstenen . In het eenvoudigste geval zijn dit voorgeformuleerde tekstmodules die op een andere pagina kunnen worden ingevoegd. In principe kunnen pagina's uit alle namespaces als template gebruikt (getranscludeerd) worden . Het gebruik van de sjabloonnaamruimte heeft echter over het algemeen de voorkeur voor sjablonen die in artikelen worden gebruikt.

Vaak bevatten templates ook de mogelijkheid om variabele data in te voegen, grafische elementen in te bouwen en gebruik te maken van min of meer complexe programmering. Op deze manier wordt bijvoorbeeld de integratie van persoonsgegevens , infoboxen , georeferentie en navigatiebalken gerealiseerd .

Sjablonen gebruiken

Betrokkenheid
accolades

Er zijn drie manieren om een ​​eenvoudige sjabloon in een artikel te gebruiken:

  1. In de hoofdtoepassing voegt u een sjabloon in met {{Titel}} . Wanneer de pagina wordt weergegeven, vervangt de MediaWiki-software deze door de inhoud van de "Titel"-sjabloon. Als iemand de sjabloon wijzigt, verandert ook de weergave.
  2. {{subst:Titel}} (voor zelfstandig naamwoord ) of {{ers:Titel}} (Etzen voor Ers) voegt ook de inhoud van het document in, maar vervangt de titel van de sjabloon in de bewerkingsomgeving (de weergave die als u hebt geklikt op het tabblad "Pagina bewerken" hierboven) door de eigenlijke tekst van de sjabloon. Op deze manier worden bijvoorbeeld nieuwe gebruikers verwelkomd , die dan de tekst van de begroeting op hun pagina zouden moeten vinden bij het bewerken, en geen verwarrende {{ Hallo }} . Andere sjablonen zijn zo geconstrueerd dat ze kunnen worden opgenomen in {{subst:Titel}} , b.v. B. het verzoek tot verwijdering . Meer over {{subst}} onder sjabloonprogrammering .
  3. {{msgnw:Titel}} toont de broncode van de sjabloon in het artikel. Deze functie wordt zelden gebruikt - eigenlijk alleen om sjablonen uit te leggen.

Pagina's die niet in de sjabloon namespace kan nog steeds worden gebruikt als templates als de namespace ook is opgegeven. {{Wikipedia: Vragen over Wikipedia}} zou bijvoorbeeld de pagina Wikipedia: Vragen over Wikipedia als sjabloon bevatten. Als u een pagina uit de artikelnaamruimte wilt opnemen, moet u een dubbele punt voor de naam plaatsen: {{: Test}} zou bijvoorbeeld het artikel Test opnemen als een sjabloon.

Sjablonen maken

Sjablonen worden gemaakt en bewerkt zoals elke andere pagina: kies een toepasselijke naam, ga naar die pagina en klik op het tabblad Maken of het tabblad Bewerken. Zoals eerder vermeld, worden sjablonen standaard gemaakt in de sjabloonnaamruimte of daarheen verplaatst na tests. Sjablonen kunnen ook in de gebruikersnaamruimte worden gemaakt als subpagina voor eigen gebruik van de auteur of voor testdoeleinden, maar deze mogen dan niet in de artikelnaamruimte worden gebruikt. Alle functies die andere pagina's kunnen bevatten, kunnen ook sjablonen bevatten. In principe moeten encyclopedische inhoud en verklaringen in de artikelen worden gepresenteerd, met uitzondering van metadata om het onderhoud ervan voor gebruikers te vereenvoudigen. Dit betekent ook expliciet het uitbesteden van functies die vaak geïntegreerd zijn in subtemplates of aanvullende templates. Sjablonen gebruiken programmeerbare eigenschappen zoals parameters, parserfuncties en andere variabelen , waardoor de geïntegreerde inhoud van sjablonen sterk kan variëren. Er zijn ook tags die de voorwaardelijke integratie van de inhoud van een sjabloon kunnen regelen.

Zoek voordat u een sjabloon maakt naar bestaande sjablonen (bijvoorbeeld door te kijken in de categorie: Sjabloon:) om duplicatie te voorkomen. Als er al een soortgelijk sjabloon bestaat, bent u vrij om het gewenste hieraan toe te voegen. Soms is het ook mogelijk om twee vergelijkbare sjablonen naast elkaar te gebruiken, op voorwaarde dat dezelfde of vergelijkbare sjablonen worden samengevoegd of gewijzigd om duidelijker van elkaar te onderscheiden. Zoek ook naar vergelijkbare sjablonen of sjablonen voor sjablonen ( Categorie: Sjabloon: voor sjablonen ), waarvan u de inhoud kunt kopiëren en eventueel aanpassen.

Er zijn geen precieze regels voor het kiezen van een sjabloonnaam, maar deze moet voldoende beschrijvend zijn voor alle andere auteurs; dan zo kort mogelijk. Afkortingen met minder dan vier letters moeten worden gereserveerd voor geselecteerde toepassingen. Als er al vergelijkbare sjablonen bestaan, gebruik dan consistente naamgeving. Sjablonen kunnen worden hernoemd (of verplaatst) zonder bestaande integraties te verliezen, zolang de resulterende forwarding op zijn plaats blijft of de integratie wordt gecorrigeerd. Voor infoboxen, positiekaarten, navigatiebalken en vele andere is er een standaardformulier waarin het sjabloontype als een voorvoegsel ervoor wordt geplaatst; dit wordt gevolgd door hoofdletters en, indien van toepassing, na de enkelvoudsregel, de aanduiding, die ook als kop zou kunnen dienen.

Als een sjabloon is slechts een enkele pagina of een kleine en beperkte groep pagina's buiten het artikel dienen namespace , bijvoorbeeld een portal , dan is er geen templates moeten worden gecreëerd in de sjabloon namespace, maar sub- pagina's in deze context. U kunt sjablonen maken net zo betrokken zijn.

Sjablonen die uitsluitend bedoeld zijn om op een enkele sjabloon of een zeer beperkte groep gerelateerde sjablonen te werken en die over het algemeen niet van buitenaf mogen worden gebruikt, worden alleen gemaakt als de subpagina van de centrale sjabloon. Dit gebeurt vaker om technische redenen; dan wordt de naam / core vaak gebruikt voor de core functionaliteit.

Wees voorzichtig bij het bewerken van bestaande sjablonen, deze kunnen erg complex zijn, vaak geïntegreerd of beide tegelijk. Om deze reden worden veel sjablonen op verzoek van een bepaald aantal integraties geblokkeerd. Net als alle andere pagina's kunnen ook sjablonen worden voorgesteld om te verwijderen.

Mogelijke toepassingen

Sjablonen hebben alleen zin als er slechts een beheersbaar aantal is dat gebruikers kunnen onthouden. In het bijzonder mogen sjablonen niet twee keer of zeer vergelijkbaar worden gemaakt. Om dit te voorkomen, moeten sjablonen van algemeen belang worden gepromoot door ze in een speciale lijst in alfabetische volgorde in te voeren: Wikipedia: tekstmodules en/of Wikipedia: evaluatiemodules of Wikipedia: tekstsjablonen .

Sjablonen worden in Wikipedia gebruikt om:

  • Consistentiemaximalisatie: Met sjablonen kan een uniforme uitstraling worden bereikt. Bekende voorbeelden zijn de template: disambiguation of template: Commons .
  • Redundantieminimalisatie: Als de inhoud slechts op één plaats centraal is gedefinieerd (bijvoorbeeld in een sjabloon), dan ziet de inhoud er in alle artikelen hetzelfde uit, ook als er een wijziging is. Het omslachtige en foutgevoelige overzetten van een wijziging naar elk artikel is niet meer nodig. Bekende voorbeelden hiervan zijn databasekoppelingen en de zogenaamde navigatiemodules . Hieronder valt ook het uitbesteden van metadata , die centraal wordt bijgehouden.
  • Workflow optimalisatie : Met een sjabloon kan een wiki-auteur andere wiki-auteurs beknopt vertellen in welke richting een artikel moet worden verbeterd. Bekende voorbeelden zijn: Sjabloon: URV (auteursrechtschending), Sjabloon: herzien of Sjabloon: verzoek tot verwijdering . Bij gebruik van de sjablonen wordt het artikel automatisch in speciale categorieën geplaatst voor andere wiki-auteurs of -beheerders.
  • Code-optimalisatie: sommige mooie presentaties kunnen alleen worden bereikt met een lelijke mix van wiki-, HTML- of CSS-commando's. De broncode van het artikel wordt dan snel verwarrend en maakt Wikian-beginners bang om deel te nemen aan de verdere verbetering van een artikel. Hier kan een sjabloon helpen om de broncode van het artikel leesbaarder te maken. Een bekend voorbeeld is sjabloon: gesproken versie .
  • Evaluatie : Naast de uniforme presentatie kunnen de gegevens (parameters) die naar de sjabloon worden overgebracht, ook automatisch worden geëvalueerd . Met name geodata kan op verschillende manieren worden hergebruikt .

Geen themaringen

Zoals te vinden is onder Wikipedia: topic ring , mogen er geen topic rings worden aangemaakt in de Duitstalige Wikipedia. Alleen navigatiebalken of andere combinaties en linkboxen die een volledige lijst van elementen van gelijke rang bevatten, zijn toegestaan ​​(bijv. sjabloon: navigatiebalk voor Duitse landen , locomotieven van de XY-serie).

Ongewenst gebruik

Sjablonen mogen niet dienen als:

  1. Gebruikershandtekeningen: Het idee om sjablonen te gebruiken voor uw eigen gebruikershandtekening klinkt misschien goed: u hoeft alleen maar de sjabloon te wijzigen en alle handtekeningen die u op een bepaald moment nog hebt, worden "bijgewerkt". Men moet echter rekening houden met het niet geheel voor de hand liggende feit dat elk gebruik van een sjabloon een extra zoekopdracht naar de database betekent en dus Wikipedia belast zonder bij te dragen aan het werkelijke doel ervan. Daarom zijn handtekeningsjablonen niet gewenst. Het is beter om bij uw oude handtekeningen te blijven.
  2. Vervanging van tekenreeksen: Het vervangen van regelmatig voorkomende tekenreeksen door sjablonen kan praktisch zijn (bijvoorbeeld {{BND}} plaats van [[Bundesnachrichtendienst]] der Bundesrepublik Deutschland ), maar is onwenselijk. Dergelijke sjablonen horen niet thuis in de normale wikitekst en hoeven daarom niet te worden aangemaakt.

Voorwaardelijke integratie van broncodeblokken

De volgende tags mogen alleen worden gebruikt binnen pagina's die een sjabloon hebben en hoe betrokken zijn:

<onlyinclude>
Wanneer de sjabloon direct wordt bekeken, hebben <onlyinclude> en </onlyinclude> geen effect op iets daartussenin. Als de sjabloon echter op een andere pagina is geïntegreerd, wordt alleen wat tussen <onlyinclude> en </onlyinclude> staat weergegeven. Buiten dit gebied gespecificeerd met <onlyinclude> , kunnen documentatie , categorieën en interwiki-links in sjablonen worden ingevoegd zonder dat ze in de artikelen verschijnen. Er kunnen ook meerdere niet-geneste <onlyinclude> -blokken in een sjabloon zijn.
Dit is ook gebruikelijk voor artikelen; Bijvoorbeeld in het geval van persoonsnamen (BKS) in de bijbehorende familienaam: De centrale inhoud van artikel Hans Meier moet worden opgenomen in het doelartikel, hier Meier (familienaam) .
<includeonly>
Alles in een sjabloon tussen <includeonly> en </includeonly> wordt alleen weergegeven als de sjabloon op een andere pagina is geïntegreerd. Met <includeonly> kunnen bijvoorbeeld alle pagina's die een bepaald sjabloon bevatten automatisch aan een categorie worden toegevoegd. <includeonly> kan ook in <onlyinclude> blokken staan.
<noinclude>
Alles wat in een sjabloon tussen <noinclude> en </noinclude> , wordt alleen weergegeven als de sjabloon zelf wordt bekeken. Het gebruik in de sjablooncode houdt het risico in dat wanneer de sjabloon wordt geïntegreerd, ongewenste spaties of zelfs regeleinden ongemerkt en onbedoeld optreden, daarom moet <onlyinclude> bij voorkeur worden gebruikt om de eigenlijke sjabloontekst te scheiden van de documentatie, categorieën en interwikilinks. <noinclude> kan ook in <onlyinclude> blokken staan.
Dag combinatie Zichtbaar op de sjabloonpagina? Betrokkenheid? annotatie
Nee Ja Ja Alleen als er geen onlyin in de sjabloon staat.
<includeonly>… </includeonly> Nee Ja Alleen als er geen onlyin in de sjabloon staat.
<noinclude>… </noinclude> Ja Nee Ook mogelijk binnen alleen omvatten.
<onlyinclude>… </onlyinclude> Ja Ja Tekst buiten is niet inbegrepen.
<alleeninclusief> <inclusiefalleen> ...
</includeonly> </onlyinclude>
Nee Ja Tekst buiten is niet inbegrepen.
<onlyinclude> Tekst 1 </onlyinclude> ... Tekst 1: Ja Tekst 1: Ja Tekst 2 is geen verstandige combinatie.
<includeonly> Tekst 2 </includeonly> Tekst 2: Nee. Tekst 2: Nee.

voorbeeld

De volgende sjabloonbroncode:

 Tekst documenteren...

<alleen opnemen> {| class = "wikitable float-right"
| [[Bestand: {{{1 <noinclude> | Bilderwunsch.svg </noinclude> }}} | mini | {{{3}}}]]
| {{{2}}} | {{{3}}}
|}
<includeonly> [[Categorie:! Hoofdcategorie]] </includeonly> </onlyinclude>

[[Categorie: Sjabloon: Linkbox]]
  • creëert de volgende weergave bij het bekijken van de sjabloonpagina (sjabloonnaamruimte):

Tekst documenteren...

{{{3}}}
{{{3}}}

Categorie: Sjabloon: Linkbox

  • creëert de volgende weergave wanneer geïntegreerd in Wikipedia (artikelnaamruimte) met behulp van {{Vorlagenname|Bilderwunsch.svg|class="hintergrundfarbe5"|← Beispiel}} :
← Voorbeeld
← Voorbeeld

Categorie: Hoofdcategorie

Parameters invoegen en gebruiken

Vaak zou inhoud in een sjabloon moeten verschijnen, maar deze verandert van pagina tot pagina, bijvoorbeeld een handtekening of de individuele naam van de afbeelding op de commons in de sjabloon: NowCommons . Dat doe je met parameters.

In de brontekst van een sjabloon geven drie accolades plaatsen aan als tijdelijke aanduidingen; deze kunnen ofwel opeenvolgend worden genummerd of worden aangeduid met vrij gekozen namen. Een tijdelijke aanduiding kan ook als wikilink fungeren als deze zelf tussen twee vierkante haken staat, bijvoorbeeld in [[{{{1}}}]] . Een dergelijk sjabloon met parameters wordt gebruikt door de momenteel gewenste waarden op te geven achter de naam van het sjabloon, hiervan en van elkaar gescheiden door een verticale lijn.

Parameters zijn ofwel genummerd of benoemd, een combinatie van genummerde en benoemde parameters is ook mogelijk.

Een sjabloon met genummerde parameters ziet er als volgt uit:

 Volgens Wikipedianer {{{1}}} is deze pagina gekopieerd van {{{2}}}

Als je het zou opslaan op de pagina [[Template: Title1]], zou je het als volgt kunnen gebruiken:

 {{Title1 | wikiwichtel | http://www.irgendwo.de/}}

Het resultaat zou de tekst zijn

 Volgens informatie van Wikipedianer wikiwichtel is deze pagina gekopieerd van http://www.irgendwo.de/

Dezelfde sjabloon ziet er als volgt uit met benoemde parameters :

 Volgens Wikipedianer {{{wikipedianer}}} is deze pagina gekopieerd van {{{source}}}

Bij gebruik van de sjabloon moet u nu ook de namen opgeven:

 {{Titel 2 | wikipedianer = wikiwichtel | source = http: //www.irgendwo.de/}}

De output zou hetzelfde zijn als hierboven.

Voor genummerde parameters is er ook de speciale functie om het nummer als een naam te gebruiken. Dit is handig als u niet alle genummerde parameters ervoor wilt opgeven of als de parameters gelijktekens bevatten. Anders mag het omwille van de duidelijkheid niet worden gebruikt.

 {{Titel1 | 2 = http://www.irgendwo.de/}}
Volgens informatie van Wikipedianer {{{1}}} is deze pagina gekopieerd van http://www.irgendwo.de/

Als er geen waarde wordt doorgegeven voor een parameter, wordt deze weergegeven met zijn naam.

Als een parameter vervolgens in een bestaande sjabloonprogrammering wordt ingevoegd, moeten de gebruikte artikelen mogelijk dienovereenkomstig worden gewijzigd. Als dit niet wordt gedaan, wordt ofwel de standaardwaarde van de parameter gebruikt of heeft de wijziging geen effect op het artikel.

Er zijn ook enkele voorgedefinieerde variabelen in MediaWiki die handig zijn als parameterwaarden, bijvoorbeeld de titel van de huidige pagina ( {{PAGENAME}} ).

Let op: Parameters in de MediaWiki-naamruimte worden anders gebruikt ($ 1, $ 2 ...).

Definieer standaard parameterwaarde:

U kunt een parameter zo definiëren dat er bij gebruik van de sjabloon geen waarde voor hoeft te worden opgegeven. Zonder deze informatie wordt een in de sjabloon opgegeven waarde ingevoegd. Bij een construct zoals {{{Titel|Vorgabe}}} De waarde van de parameter titel wordt uitgevoerd, indien gespecificeerd, anders wordt de standaardwaarde, die ook kan zijn parserfuncties {{PAGENAME}} , bijvoorbeeld.

Belangrijk:

Als de parameter is opgegeven, maar de waarde is leeg gelaten,

 {{Sjabloonnaam | Titel =}}

dan wordt voor {{{Titel|Vorgabe}}} de doorgegeven lege tekst uitgevoerd! De standaardwaarde wordt alleen gebruikt zonder parameters:

 {{Sjabloonnaam}}

Afzonderlijk gedrag wanneer de waarde leeg is, is nooit wenselijk; alle verontreinigde locaties zijn geëlimineerd. Als een sjabloonintegratie wordt bewerkt met VisualEditor , hebben de gebruikers geen controle over de resulterende brontekst; vooral als parameters als "aanbevolen" zijn gedeclareerd.

Moet de standaardwaarde ook worden gebruikt voor:

 {{Sjabloonnaam | Titel =}}

moet in plaats daarvan in de sjabloon worden gebruikt

 {{#if: {{{Title |}}} | {{{Title}}} | Standaard}}

of

 {{#switch: {{{Title |}}} | = Standaard | {{{Title}}}}}

staan.

Tekstopmaak

Het belangrijkste doel van sjablonen is de uniforme weergave van bepaalde elementen en teksten in alle artikelen. In het bijzonder moet de tekstopmaak zoveel mogelijk worden uitgevoerd met behulp van de sjabloon. Cursief, vet of lettergrootte moeten bijvoorbeeld worden gewijzigd door de sjabloon te programmeren.

Dienovereenkomstig moet bij het integreren van sjablonen bij het invoeren van parameters die ook als uitvoertekst worden gebruikt, geen opmaak worden gebruikt, omdat dit de gespecificeerde opmaak zou ondermijnen en zou resulteren in een inconsistente weergave. Dit geldt ook als een opmaak niet in strijd is met de huidige specificaties. Sjablonen kunnen ook worden gebruikt om achteraf alle gebeurtenissen in de artikelen te wijzigen. Individuele opmaak kan achteraf ook een probleem worden.

Er kunnen redenen zijn waarom parameterteksten ook voor opmaak kunnen zorgen, bijvoorbeeld als de parametercomponenten anders moeten worden weergegeven en het programmeren te tijdrovend zou zijn. In dit geval moet dit echter uniform gebeuren en dienovereenkomstig worden gedocumenteerd. In principe moet deze benadering echter worden vermeden omdat het vaak veel moeite kost om te controleren en de programmeurs vertrouwen op het juiste gebruik bij het wijzigen van sjablonen.

Problemen met het gebruik van sjablonen

Probleem: kogels

  • Als u opsommingstekens ( * of # ), zoals aan het begin van deze regel, als parameterwaarde wilt gebruiken, moet een nieuwe regel worden gestart in de sjabloon voor de parameter. B. in het sjabloon: Infobox Film voor de parameter {{{Cast}}} is het geval voor acteurs.

Probleem: gelijkteken in parameterwaarden

Als tekst met een gelijkteken aan een sjabloon wordt doorgegeven als de waarde van een naamloze ("genummerde") parameter, gaat de MediaWiki-software ervan uit dat de naam van een parameter vóór het eerste gelijkteken verschijnt en de rest van de tekst nadat het eerste gelijkteken is gebruikt, moet een waarde worden toegewezen. Alle parameterspecificaties met een gelijkteken worden geïnterpreteerd als naam-waardeparen en opgesplitst bij het eerste gelijkteken.

Dit probleem doet zich bijvoorbeeld voor als u een URL als parameterwaarde wilt overbrengen naar een sjabloon die een gelijkteken bevat (bijv. https://de.wikipedia.org/w/index.php?title=Hilfe: Sjablonen & action = edit & section = 3), of een tekst met daarin opgenomen HTML-attribuuttoewijzingen, zoals style= in een decoratie.

De remedie voor deze ongewenste interpretatie is om de parameterwaarde te laten voorafgaan door de numerieke index van de parameter en een ander gelijkteken. Het wordt dan als gewenst geïnterpreteerd dat de parameterwaarde pas begint na het (toegevoegde) eerste gelijkteken, en de index die hieraan voorafgaat, identificeert ondubbelzinnig de doelparameter voor de waarde. Het tellen van de parameters begint met 1 voor de eerste parameter na de sjabloonnaam.

In plaats van: {{Vorlagenname|http://…/index.php?title=…&action=edit&section=3}}
Rechts: {{Vorlagenname| 1= http://…/index.php?title=…&action=edit&section=3}}
In plaats van: {{Vorlagenname|erster Wert|xx<span style="font-style:italic;">kursiv</span>zz}}
Rechts: {{Vorlagenname|erster Wert| 2= xx<span style="font-style:italic;">kursiv</span>zz}}

De volgende naamloze parameters moeten ook worden genummerd, omdat de automatische telling geen rekening houdt met de expliciete nummering, dwz met {{Vorlagenname|erster Wert|2=zweiter Wert|dritter Wert}} zweiter Wert worden vervangen door de dritter Wert .

In normaal lopende tekst, waarin het gelijkteken geen syntactische betekenis heeft, kan het gelijkteken worden vervangen door & # 61; gemaskerd.

Probleem: speciale tekens in parameterwaarden

Als speciale tekens van de wiki-syntaxis en vooral de sjabloonsyntaxis moeten worden gebruikt in parameterwaarden, kunnen er problemen ontstaan.

Als het teken gewoon in de weergegeven tekst of in een URL moet verschijnen , is de eenvoudigste optie om het te vervangen door een HTML-entiteit . URL-codering kan indien nodig ook in URL's worden gebruikt.

karakter { | } = [ ] * # : ; Spaties < >
Entiteit &#123; &#124; &#125; &#61; &#91; &#93; &#42; &#35; &#58; &#59; &#32; &lt; &gt;

Spaties aan het begin en aan het einde van waarden van benoemde parameters worden "slikt"; * en # aan het begin van een parameterwaarde worden geïnterpreteerd als wiki-syntaxis voor opsommingstekens als er een regeleinde in de sjabloon wordt gegeven. Als er meerdere karakters zijn, is een beter leesbare variant <nowiki> de tekst in <nowiki></nowiki> als niets erin moet worden geïnterpreteerd als wiki-syntaxis.

Verticale lijn

Of een verticale lijn | (“Pipe”) wordt door de parser geïnterpreteerd als wiki-syntaxis, afhankelijk van het type gebruik (zie tabel). Binnen een gesloten eenheid, zoals een wiki-link met een titel, heeft het geen extern effect; evenmin binnen een gesloten binnenste documentband. Soms is het daarom nodig om delen van een wiki-syntaxconstructie zoals wikilinks of tabellen door te geven als parameterwaarden waaruit uiteindelijk het volledige element moet worden samengesteld. In dit geval raden we de hieronder beschreven sjablonen aan, waarin de speciale tekens worden ingevoegd en deze later als wiki-syntaxis kunnen worden geïnterpreteerd. Ze mogen alleen worden gebruikt in parameterwaarden.

Syntaxiseffect van de verticale balk
| {{!}} & # 124;
Scheiding van sjabloonparameters Ja Nee Nee
Scheiding van parameters in Wikilinks Ja Ja Nee
Tabelsyntaxis Ja Ja Nee
Tafelelementen

Sinds het teken | dient om parameters te scheiden, het mag niet in parameterwaarden zelf voorkomen. De parserfunctie {{!}} Moet gebruikt worden om toch een functionele tabel te krijgen.

vereiste code | |- |+ || {| |} |-
|
Broncode met variabele! {{!}} {{!}}- {{!}}+ {{!}}{{!}} {{{!}} {{!}}} {{!}}-
{{!}}

Grotere delen van de tabel kunnen ook naar een subpagina van de sjabloon worden verplaatst en van daaruit worden geïntegreerd. Als dit ook niet haalbaar is, kan indien nodig HTML ( <td> enz.) worden gebruikt.

Wikilink

Volledige wikilinks als parameterwaarden moeten zoals gebruikelijk worden opgegeven, d.w.z. zonder speciale maatregelen, als een linktitel een verticale lijn volgt. Als het daarentegen slechts een deel van een wikilink of een bestandsintegratie is die nog moet worden samengesteld, dan {{!}} In plaats van | gebruiken:
Niet {{Linkvorlage|Inhalt=Lemma|Linktext}} , maar {{Linkvorlage|Inhalt=Lemma{{!}}Linktext}} .

Vierkante haakjes

Weergave van enkele vierkante haken als &#91; voor [en &#93; for] of omring in nowiki tags of voeg <noinclude /> .

accolades

Weergave van enkele accolades als &#123; voor {en &#125; for} of het insluiten in nowiki tags of het invoegen van <noinclude /> .

Probleem: Toewijzing van lege parameterwaarden

Sjabloonsyntaxis gedraagt ​​zich fundamenteel anders als een parameter helemaal niet is opgegeven, of als deze wel is opgegeven, maar een lege waarde is toegewezen.

Veel sjablonen, vooral modernere, gericht aan algemene auteurs, vangen dit gedrag echter op door middel van afzonderlijke programmering en behandelen lege parameterwaarden en parameters die niet op dezelfde manier zijn gespecificeerd.

Het toekennen van een lege waarde vloeit voort uit het feit dat twee pijpleidingen direct op elkaar volgen. De corresponderende parameter daartussen krijgt een waarde toegewezen en wordt als gespecificeerd beschouwd.

Probleem: spaties rond parameterwaarden

In het geval van naamloze ("genummerde") parameters wordt er altijd rekening mee gehouden of er spaties of zelfs regeleinden worden toegevoegd voor of nadat de waarde is opgegeven bij het specificeren van de waarde.

Dit leidt echter vaak tot ongewenste resultaten, bijvoorbeeld als een URL niet meer goed in elkaar zit.

Veel, vooral modernere sjablonen die zijn gericht aan algemene auteurs, onderscheppen dit gedrag echter door afzonderlijke programmering en verminderen de waarde tot de nuttige inhoud als dit zinvol is voor deze toepassing. Veel oudere sjablonen zijn echter niet voorbereid op deze situatie.

Het is daarom beter om geen extra spaties op te geven voor naamloze parameters als de programmering niet precies bekend is.

Het probleem bestaat niet met benoemde parameters; deze worden altijd 'getrimd', dwz geëxtraheerd uit omringende spaties en regeleinden.

Probleem: algemeen mannelijk

Het generieke mannelijke hoeft niet consequent te worden gebruikt voor functiebenamingen. In plaats daarvan kunnen twee parameters voor de mannelijke en vrouwelijke vorm samen worden gecreëerd en geëvalueerd. Voor meer informatie, zie Help: Infoboxen / Geslacht .

Documentsjablonen

Zie in detail: Help: Sjabloondocumentatie

Sjablonen die in normale artikelen worden gebruikt, moeten zo eenvoudig worden ontworpen dat het doel en de toepassing direct begrijpelijk zijn. In ieder geval is een beschrijving van hun functie noodzakelijk . Dit kan buiten het insluitgebied van de sjabloonpagina worden gedaan. Bij vaak geïntegreerde templates kan de functionele beschrijving echter beter op een aparte pagina staan; Deze kunnen dan worden verwezen met behulp van de sjabloon: documentatie buiten de include gebied van de sjabloon pagina. Een wijziging in de sjabloonpagina zelf heeft tot gevolg dat alle afhankelijke pagina's opnieuw moeten worden gegenereerd wanneer ze opnieuw worden opgeroepen, in plaats van ze uit de cache te kunnen laden. Deze serverbelasting moet worden vermeden. Bovenstaande overweging is echter alleen relevant als revisies van de documentatie te verwachten zijn met ongewijzigde functies; het uitbesteden van de documentatie verbetert sowieso de duidelijkheid.

Gedetailleerde documentatie op één subpagina

Een subpagina van de sjabloon is geschikt voor gedetailleerde documentatie. Het systeem van de sjabloon: Hiervoor dient documentatie te worden gebruikt. Dit houdt in dat de functie van de sjabloon wordt beschreven op een subpagina /Doku de sjabloonpagina. De inhoud van de subpagina verschijnt dan bij het bekijken van de sjabloonpagina. De sjabloon: Documentatie is opgenomen door <noinclude>{{Dokumentation}}</noinclude> aan het einde van de sjabloon. Voor informatie over hoe u verder moet gaan, zie de documentatie bij de sjabloon: Documentatie .

categorisatie

Elke sjabloon moet worden gesorteerd in een overeenkomstige subcategorie van de categorie: Sjabloon : . Zorg er bij het sorteren voor dat u een of meer thematisch geschikte categorieën vindt. Het sorteren van sjablonen in artikelcategorieën is niet toegestaan. Onderhoudscategorieën vormen een uitzondering, waarbij de sjabloon af en toe in de categorie wordt opgenomen. Bei einer Einsortierung ist zu beachten, dass dies innerhalb von <noinclude>…</noinclude> geschieht, damit nur die Vorlage der Kategorie zugeordnet wird und nicht alle Seiten, in denen die Vorlage verwendet wird. Das WikiProjekt Vorlagen hat eine Systematik zur Kategorisierung aller Vorlagen erarbeitet. Des Weiteren kann bei Bedarf eine vom Namen abweichendeSortierung der Vorlage innerhalb der Kategorie angegeben werden (etwa bei einer Infobox oder Navigationsleiste), dafür muss hinter den Kategorienamen ein senkrechter Strich und dann die Sortierung eingetragen werden ( [[Kategorie:Vorlage:Unterkategorie|Sortierung]] ).

Bei der Verwendung der Vorlage:Dokumentation gehören alle Metadaten, also auch die Kategorien, auf diese eine Unterseite. Nur die Programmierung und die Einbindung {{ Dokumentation }} verbleiben auf der einzubindenden Seite.

Vorlagen mit speziellen Eigenschaften werden in den passenden Zweig der Kategorie:Vorlage:nach Eigenschaft eingeordnet. Beispiele wärenVorlagen, die Artikel automatisch in eine Kategorie einsortieren , oder solche mit Koordinateneinbindung .

Vorlagen testen

Vorlagen können auf der Spezialseite „ Vorlagen expandieren “ getestet werden, siehe auch Hilfe:Vorlagenprogrammierung #Testen und Änderungen an Vorlagen mit komplexen Abhängigkeiten unter Spezial:Vorlagenspielwiese (Beschreibung unter Hilfe:Vorlagenspielwiese ).

Vorlagen weiterleiten

Auch bei Vorlagen ist eine Weiterleitung möglich und einer redundanten Kopie der Vorlage vorzuziehen. Dabei sind sowohl dem Namen der Weiterleitung als auch dem Weiterleitungsziel der Namensraum „Vorlage:“ voranzustellen.

Weil sie jedoch verwirren, eine separate Funktionalität vortäuschen und Autoren mehr unterschiedliche Namen von Vorlagen erlernen müssen, um den Quelltext zu verstehen, sollten nach Umbenennungen die Namensvarianten nach und nach auf den eigentlichen Namen umgestellt werden.

Weitere Informationen