Hjelp: maler

fra Wikipedia, den frie encyklopedi
Hopp til navigasjon Hopp til søk

En mal er en side som, basert på prinsippet om overføring, letter integrering av ofte brukte elementer i andre sider. Maler er en del av byggesteinene . I det enkleste tilfellet er dette forhåndsformulerte tekstmoduler som kan settes inn på en annen side. I prinsippet kan sider fra alle navneområder brukes (transcluderes) som en mal. Imidlertid er bruken av malenavnområdet generelt å foretrekke for maler som skal brukes i artikler.

Ofte inneholder maler også muligheten til å sette inn variable data, inkorporere grafiske elementer og bruke mer eller mindre kompleks programmering. På denne måten implementeres for eksempel integrering av personopplysninger , infobokser , georeferering og navigasjonslinjer .

Bruk maler

Involvering
Krøllete regulering

Det er tre måter å bruke en enkel mal i en artikkel:

  1. I hovedprogrammet setter du inn en mal med {{Titel}} . Når siden vises, erstatter MediaWiki -programvaren dette med innholdet i "Tittel" -malen. Hvis noen endrer malen, endres displayet også.
  2. {{subst:Titel}} (for itution substantiv ) eller {{ers:Titel}} (Etzen for Ers) setter også inn innholdet i dokumentet, men erstatter tittelen på malen i redigeringsmiljøet (visningen som en hvis du har klikket på fanen "Rediger side" ovenfor) gjennom selve teksten til malen. På denne måten blir for eksempel nye brukere ønsket velkommen , som da bør finne teksten til hilsenen på siden sin når de redigerer, og ikke en forvirrende {{ Hello }} . Andre maler er konstruert på en slik måte at de kan inkluderes i {{subst:Titel}} , f.eks. B. forespørsel om sletting . Mer om {{subst}} under malprogrammering .
  3. {{msgnw:Titel}} viser kildekoden til malen i artikkelen. Denne funksjonen brukes sjelden - faktisk bare for å forklare maler.

Sider som ikke er i malenavnområdet kan fortsatt brukes som maler hvis også navneområdet er spesifisert. For eksempel vil {{Wikipedia: Spørsmål om Wikipedia}} inneholde siden Wikipedia: Spørsmål om Wikipedia som mal. Hvis du vil inkludere en side fra artikkelnavnområdet, må du sette et kolon foran navnet: For eksempel vil {{: Test}} inkludere artikkelen Test som en mal.

Lag maler

Maler opprettes og redigeres som alle andre sider: velg et passende navn, gå til den siden og klikk på kategorien Opprett eller kategorien Rediger. Som allerede nevnt opprettes maler som standard i malenavnområdet eller flyttes dit etter tester. Maler kan også opprettes i brukernavnområdet som en underside for forfatterens eget bruk eller til testformål, men disse bør ikke da brukes i artikkelenavnområdet. Alle funksjoner som andre sider kan inneholde, kan også inneholde maler. I prinsippet skal encyklopedisk innhold og uttalelser presenteres i artiklene, med unntak av metadata for å forenkle vedlikeholdet av det samme for brukerne. Dette betyr også eksplisitt outsourcing av funksjoner som ofte er integrert i delmaler eller flere maler. Maler bruker programmerbare egenskaper som parametere, parserfunksjoner og andre variabler , noe som gjør at det integrerte innholdet i maler kan variere sterkt. Det er også koder som kan kontrollere den betingede integreringen av innholdet i en mal.

Før du oppretter en mal, se etter eksisterende maler (f.eks. Ved å se i kategorien: Mal :) for å unngå duplisering. Hvis en lignende mal allerede finnes, kan du legge til den du ønsker. Noen ganger er det også mulig å bruke to lignende maler parallelt, forutsatt at de samme eller lignende malene enten slås sammen eller endres for å skille seg tydeligere fra hverandre. Se også etter lignende maler eller maler for maler ( Kategori: Mal: ​​for maler ), hvis innhold du kan kopiere og tilpasse om nødvendig.

Det er ingen presise regler for valg av et malnavn, men det bør være tilstrekkelig beskrivende for alle andre forfattere; så kort som mulig. Forkortelser med færre enn fire bokstaver bør forbeholdes utvalgte applikasjoner. Hvis lignende maler allerede finnes, bruker du konsekvent navn. Maler kan gi nytt navn (eller flyttes) uten å miste eksisterende integrasjoner, så lenge den resulterende videresendelsen forblir på plass eller integrasjonen er korrigert. For infobokser, posisjonskart, navigasjonslinjer og mange andre, er det et standardskjema der maltypen plasseres foran den som et prefiks; dette etterfølges av store bokstaver og, hvor det er hensiktsmessig, etter entallregelen, betegnelsen, som også kan tjene som en overskrift.

Hvis en mal er å tjene bare en enkelt side eller et lite og begrenset gruppe av sider utenfor artikkelen navnerom , for eksempel en portal , så ingen maler skal opprettes i malnavnerommet, men under sider i denne sammenheng. Du kan lage maler like involvert .

Maler som utelukkende er beregnet på å fungere på en enkelt mal eller en begrenset gruppe med beslektede maler, og som vanligvis ikke skal brukes utenfra, opprettes bare som undersiden til den sentrale malen. Dette skjer oftere av tekniske årsaker; da blir navnet / kjernen ofte brukt for kjernefunksjonaliteten.

Vær forsiktig når du redigerer eksisterende maler, disse kan være svært komplekse, ofte integrerte eller begge samtidig. Derfor blokkeres mange maler på forespørsel fra et visst antall integrasjoner. Som alle andre sider kan maler også foreslås for sletting.

Mulig bruk

Maler gir bare mening hvis det bare er et håndterbart antall av dem som brukerne kan huske. Spesielt skal maler ikke opprettes to ganger eller veldig like. For å forhindre dette bør maler av generell relevans fremmes ved å skrive dem inn i en spesiell liste i alfabetisk rekkefølge: Wikipedia: tekstmoduler og / eller Wikipedia: evalueringsmoduler eller Wikipedia: tekstmaler .

I Wikipedia brukes maler for å:

  • Konsistensmaksimering: Et jevnt utseende kan oppnås med maler. Kjente eksempler inkluderer malen: disambiguation eller mal: Commons .
  • Redundansminimering: Hvis innholdet bare er definert sentralt på ett sted (dvs. i en mal), vil innholdet vises det samme i alle artikler, selv om det senere endres. Den kjedelige og feilutsatte overføringen av en endring til hver artikkel er ikke lenger nødvendig. Velkjente eksempler her er databasekoblinger og de såkalte navigasjonsmodulene . Dette inkluderer også outsourcing av metadata , som oppdateres sentralt.
  • Arbeidsflytoptimalisering: Med en mal kan en wiki -forfatter kort fortelle andre wiki -forfattere i hvilken retning en artikkel bør forbedres. Kjente eksempler er: Mal: URV (brudd på opphavsretten), Mal: revisjon eller Mal: forespørsel om sletting . Når du bruker malene, blir artikkelen automatisk lagt inn i spesielle kategorier for andre wiki -forfattere eller administratorer.
  • Kodeoptimalisering: Noen vakre presentasjoner kan bare oppnås med en stygge blanding av wiki-, HTML- eller CSS -kommandoer. Artikkelenes kildekode blir deretter raskt forvirrende og skremmer Wikian -nybegynnere fra å delta i ytterligere forbedring av en artikkel. Her kan en mal bidra til å gjøre artikkelens kildekode mer lesbar. Et velkjent eksempel er mal: muntlig versjon .
  • Evaluering : I tillegg til den ensartede presentasjonen, kan dataene (parametrene) som overføres til malen også evalueres automatisk . Spesielt Geodata kan gjenbrukes på en rekke måter.

Ingen temaringer

Som du finner under Wikipedia: topic ring , bør det ikke opprettes emneringer i den tyskspråklige Wikipedia. Bare navigasjonslinjer eller andre samlinger samt lenkebokser som inneholder en komplett liste over elementer av samme rang er tillatt (f.eks. Mal: navigasjonslinje for tyske land , lokomotiver i XY -serien).

Uønskede bruksområder

Malene skal ikke fungere som:

  1. Brukersignaturer: Ideen om å bruke maler til din egen brukersignatur kan høres bra ut: Du må bare endre malen, så blir alle signaturene du har igjen på et tidspunkt "oppdatert". Imidlertid bør man vurdere det ikke helt åpenbare faktum at hver bruk av en mal betyr en ekstra forespørsel til databasen og dermed belaster Wikipedia uten å bidra til det egentlige formålet med den. Derfor er det ikke ønskelig med signaturmaler. Bedre å holde seg til de gamle signaturene dine.
  2. Erstatning av tegnstrenger: Det er praktisk å bytte tegnstrenger med vanlige tegn (for eksempel {{BND}} stedet for [[Bundesnachrichtendienst]] der Bundesrepublik Deutschland ), men er uønsket. Slike maler har ingen plass i normal wikitext og trenger derfor ikke opprettes.

Betinget integrering av kildekodeblokker

Følgende tagger bør bare brukes på sider som en mal og hvor involvert er:

<onlyinclude>
Når malen vises direkte, har <onlyinclude> og </onlyinclude> ingen effekt på noe i mellom. Men hvis malen er integrert på en annen side, vises bare det som er mellom <onlyinclude> og </onlyinclude> . Utenfor dette området som er spesifisert med <onlyinclude> , kan dokumentasjon , kategorier og interwiki <onlyinclude> settes inn i maler uten at de vises i artiklene. Det kan også være flere ikke-nestede <onlyinclude> blokker i en mal.
Dette er også vanlig for artikler; For eksempel når det gjelder personnavn (BKS) i det tilhørende slektsnavnet: Det sentrale innholdet i artikkelen Hans Meier bør inkluderes i målartikkelen, her Meier (slektsnavn) .
<includeonly>
Alt som er mellom <includeonly> og </includeonly> i en mal vises bare hvis malen er integrert på en annen side. Med <includeonly> , for eksempel, kan alle sider som inneholder en bestemt mal, automatisk legges til i en kategori. <includeonly> kan også være i <onlyinclude> -blokker.
<noinclude>
Alt som er mellom <noinclude> og </noinclude> i en mal, vises bare når selve malen vises. Bruken i malkoden har en risiko for at uønskede mellomrom eller til og med linjeskift når malen er integrert, derfor bør <onlyinclude> fortrinnsvis brukes til å skille selve <onlyinclude> fra dokumentasjonen, kategoriene og interwikilinkene. <noinclude> kan også være i <onlyinclude> -blokker.
Dagskombinasjon Synlig på malsiden? Involvering? merknad
Nei Ja Ja Bare hvis det ikke bare er inkludert i malen.
<includeonly> ... </includeonly> Nei Ja Bare hvis det ikke bare er inkludert i malen.
<noinclude> ... </noinclude> Ja Nei Også mulig innen bare inkludere.
<onlyinclude> ... </onlyinclude> Ja Ja Tekst utenfor er ikke inkludert.
<onlyinclude> <includeonly> ...
</includeonly> </onlyinclude>
Nei Ja Tekst utenfor er ikke inkludert.
<onlyinclude> Tekst 1 </onlyinclude> ... Tekst 1: Ja Tekst 1: Ja Tekst 2 er ikke en fornuftig kombinasjon.
<includeonly> Tekst 2 </includeonly> Tekst 2: Nei. Tekst 2: Nei.

eksempel

Følgende malkildekode:

 Dokumenterer tekst ...

<bare inkluder> {| class = "wikitable float-right"
| [[Fil: {{{1 <noinclude> | Bilderwunsch.svg </noinclude> }}} | mini | {{{3}}}]]
| {{{2}}} | {{{3}}}
|}
<includeonly> [[Category :! Main Category]] </includeonly> </onlyinclude>

[[Kategori: Mal: ​​Linkbox]]
  • oppretter følgende visning når du viser malsiden (malenavn):

Dokumenterer tekst ...

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

Kategori: Mal: ​​Linkbox

  • Når den er integrert i Wikipedia (artikkelenavn) med {{Vorlagenname|Bilderwunsch.svg|class="hintergrundfarbe5"|← Beispiel}} oppretter du følgende visning:
← Eksempel
← Eksempel

Kategori:! Hovedkategori

Sett inn og bruk parametere

Ofte skal innhold vises i en mal, men det endres fra side til side, for eksempel en signatur eller det individuelle navnet på bildet på allmenningen i malen: NowCommons . Du kan gjøre det med parametere.

I kildeteksten til en mal angir tre krøllete parenteser steder som plassholdere; disse kan enten nummereres fortløpende eller angis med fritt valgte navn. En plassholder kan også fungere som en wikilink hvis den i seg selv er omgitt av to firkantede parenteser, for eksempel i [[{{{1}}}]] . En slik mal med parametere brukes ved å spesifisere gjeldende ønskede verdier etter malenavnet, atskilt fra den og fra hverandre med en vertikal linje.

Parametere er enten nummerert eller navngitt, en blanding av nummererte og navngitte parametere er også mulig.

En mal med nummererte parametere ser slik ut:

 I følge Wikipedianer {{{1}}} er denne siden kopiert fra {{{2}}}

Hvis du skulle lagre den på siden [[Mal: Tittel1]], kan du bruke den slik:

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

Resultatet blir teksten

 Ifølge informasjon fra Wikipedianer wikiwichtel, er denne siden kopiert fra http://www.irgendwo.de/

Den samme malen ser slik ut med navngitte parametere :

 Ifølge Wikipedianer {{{wikipedianer}}} er denne siden kopiert fra {{{source}}}

Når du bruker malen, må du skrive inn navnene:

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

Utgangen vil være den samme som ovenfor.

For nummererte parametere er det også den spesielle egenskapen ved å bruke nummeret som et navn. Dette er nyttig hvis du ikke vil angi alle nummererte parametere foran det eller hvis parametrene inneholder like tegn. Ellers bør den ikke brukes av klarhetshensyn.

 {{Title1 | 2 = http: //www.irgendwo.de/}}
Ifølge informasjon fra Wikipedianer {{{1}}} er denne siden kopiert fra http://www.irgendwo.de/

Hvis det ikke sendes noen verdi for en parameter, vises den med navnet.

Hvis en parameter senere settes inn i en eksisterende malprogrammering, må artiklene som brukes må endres tilsvarende. Hvis dette ikke er gjort, brukes enten standardverdien til parameteren eller endringen har ingen effekt på artikkelen.

Det er også noen forhåndsdefinerte variabler i MediaWiki som er nyttige som parameterverdier, for eksempel tittelen på gjeldende side ( {{PAGENAME}} ).

OBS: Parametere i MediaWiki -navneområdet brukes annerledes ($ 1, $ 2 ...).

Definer standard parameterverdi

Du kan definere en parameter på en slik måte at det ikke må spesifiseres noen verdi for den når du bruker malen. Uten denne informasjonen settes det inn en verdi som er angitt i malen. I tilfelle av en konstruksjon som {{{Titel|Vorgabe}}} , verdien av tittel-parameteren er utgang, hvis angitt, ellers standardverdien, som også kan være parseren funksjon {{PAGENAME}} , f.eks.

Viktig:

Hvis parameteren er angitt, men verdien er tom,

 {{Malnavn | tittel =}}

så sendes den tomme teksten ut for {{{Titel|Vorgabe}}} ! Standardverdien brukes bare uten parametere:

 {{Malnavn}}

Separat atferd når verdien er tom er aldri ønskelig; alle forurensede steder er eliminert. Hvis en malintegrasjon redigeres ved hjelp av VisualEditor , har brukerne ingen kontroll over den resulterende kildeteksten; spesielt hvis parametere har blitt erklært som "anbefalt".

Skal standardverdien også brukes til

 {{Malnavn | tittel =}}

må brukes i malen i stedet

 {{#if: {{{Tittel |}}} | {{{Tittel}}} | Standard}}

eller

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

å stå.

Tekstformatering

Hovedformålet med maler er ensartet fremstilling av visse elementer og tekster på tvers av alle artikler. Spesielt bør tekstformatering utføres med malen så langt som mulig. For eksempel bør kursiv, fet skrift eller skriftstørrelse endres ved å programmere malen.

Tilsvarende, ved integrering av maler når du angir parametere som også brukes som utdatatekst, bør ikke formatering brukes, da dette ville undergrave den angitte formateringen og resultere i inkonsekvent visning. Dette gjelder også hvis en formatering ikke er i konflikt med gjeldende spesifikasjoner. Maler kan også brukes til å gjøre en påfølgende endring av alle forekomster i artiklene. Individuell formatering kan også bli et problem etterpå.

Det kan være grunner til at parametertekster også kan gi formatering, for eksempel hvis parameterkomponentene skal vises annerledes og programmering vil være for tidkrevende. I dette tilfellet bør dette imidlertid gjøres jevnt og dokumenteres deretter. I prinsippet bør imidlertid denne prosedyren unngås fordi det ofte krever mye innsats å sjekke og programmererne er avhengige av riktig bruk når de endrer maler.

Problemer med bruk av maler

Problem: kuler

  • Hvis du vil bruke kuler ( * eller # ), som det er i begynnelsen av denne linjen, som en parameterverdi, bør en ny linje startes i malen foran parameteren. B. i malen: Infobox Film for parameteren {{{{Cast}}} er tilfelle for skuespillere.

Problem: Likepåmelding i parameterverdier

Hvis tekst som inneholder et likhetstegn blir overført til en mal som verdien av en ikke navngitt ("nummerert") parameter, antar MediaWiki -programvaren at navnet på en parameter vises foran det første likhetstegnet, og resten av teksten etter at det første likhetstegnet er brukt som verdi bør tildeles. Alle parameterspesifikasjoner med likhetstegn blir tolket som navn-verdi-par og delt opp ved det første likhetstegnet.

Dette problemet oppstår for eksempel hvis du vil overføre en URL som parameterverdi til en mal som inneholder et likhetstegn (f.eks. Https://de.wikipedia.org/w/index.php?title=Hilfe: Maler og action = edit & section = 3), eller en tekst med inkluderte HTML -attributtilordninger, for eksempel style= i en dekorasjon.

Midlet for denne uønskede tolkningen er å sette parameterverdien foran parameterets numeriske indeks og et annet likhetstegn. Det blir deretter tolket som ønsket at parameterverdien først begynner etter (lagt til) det første likhetstegnet, og indeksen foran dette identifiserer målparameteren for verdien umiskjennelig. Tellingen av parametrene starter med 1 for den første parameteren etter malnavnet.

I stedet for: {{Vorlagenname|http://…/index.php?title=…&action=edit&section=3}}
Ikke sant: {{Vorlagenname| 1= http://…/index.php?title=…&action=edit&section=3}}
I stedet for: {{Vorlagenname|erster Wert|xx<span style="font-style:italic;">kursiv</span>zz}}
Ikke sant: {{Vorlagenname|erster Wert| 2= xx<span style="font-style:italic;">kursiv</span>zz}}

Følgende ikke navngitte parametere må også nummereres, da den automatiske tellingen ikke tar hensyn til den eksplisitte nummereringen, dvs. med {{Vorlagenname|erster Wert|2=zweiter Wert|dritter Wert}} zweiter Wert bli erstattet av den dritter Wert .

I vanlig løpende tekst, der likhetstegnet ikke har noen syntaktisk betydning, kan likhetstegnet erstattes av & # 61; maskert.

Problem: Spesialtegn i parameterverdier

Hvis spesialtegn i wikisyntaksen og spesielt malsyntaksen må brukes i parameterverdier, kan det oppstå problemer.

Hvis tegnet bare skal vises i den viste teksten eller i en URL , er det enkleste alternativet å erstatte det med en HTML -enhet . URL -koding kan også brukes i URL -er om nødvendig.

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

Mellomrom i begynnelsen og på slutten av verdier av navngitte parametere "svelges"; * og # i begynnelsen av en parameterverdi tolkes som wikisyntaks for kuler hvis det er angitt et linjeskift i malen. Hvis det er flere tegn, er en mer lesbar variant å <nowiki> ved teksten i <nowiki> ... </nowiki> hvis ingenting i den skal tolkes som wikisyntaks.

Vertikal linje

Enten en vertikal linje | ("Pipe") tolkes av parseren som wikisyntaks, avhenger av brukstype (se tabell). Innenfor en lukket enhet, for eksempel en tittel med wikilink, har den ikke en ekstern effekt; heller ikke innenfor en lukket indre dokumentbinding. Noen ganger er det derfor nødvendig å sende deler av en wikisyntakskonstruksjon, for eksempel wikilinks eller tabeller, som parameterverdier som det komplette elementet til slutt skal settes sammen. I dette tilfellet anbefaler vi malene beskrevet nedenfor, som setter inn spesialtegnene og tillater senere tolkning som wikisyntaks. De skal bare brukes i parameterverdier.

Syntakseffekt av den vertikale linjen
| {{!}} & # 124;
Separasjon av malparametere Ja Nei Nei
Separasjon av parametere i Wikilinks Ja Ja Nei
Tabellen syntaks Ja Ja Nei
Bordelementer

Siden skiltet | tjener til å skille parametere, må den ikke vises i selve parameterverdiene. Parserfunksjonen {{!}} brukes for å fremdeles få en funksjonell tabell.

nødvendig kode | |- |+ || {| |} |-
|
Kildekode med variabel! {{!}} {{!}}- {{!}}+ {{!}}{{!}} {{{!}} {{!}}} {{!}}-
{{!}}

Større deler av tabellen kan også flyttes til en underside av malen og integreres derfra. Hvis dette heller ikke er praktisk mulig, kan HTML ( <td> etc.) brukes om nødvendig.

Wikilink

Komplette wikilinks som parameterverdier må spesifiseres som vanlig, dvs. uten spesielle tiltak, hvis en lenketittel følger en vertikal linje. Hvis det derimot bare er en del av en wikilink eller en filintegrasjon som ennå ikke er satt sammen, så {{!}} I stedet for | å bruke:
Ikke {{Linkvorlage|Inhalt=Lemma|Linktext}} , men {{Linkvorlage|Inhalt=Lemma{{!}}Linktext}} .

Firkantede parenteser

Representasjon av enkelt firkantede parenteser som &#91; for [og &#93; for] eller surround i nowiki -tagger eller sett inn <noinclude /> .

Krøllete regulering

Representasjon av enkeltkrøllete seler som &#123; for {og &#125; for} eller vedlegge den i nowiki -tagger eller sette inn <noinclude /> .

Problem: Tildeling av tomme parameterverdier

Malesyntaks oppfører seg annerledes hvis en parameter ikke er spesifisert i det hele tatt, eller hvis den er spesifisert, men en tom verdi er tildelt.

Mange maler, spesielt mer moderne, adressert til generelle forfattere, fanger imidlertid oppførselen ved hjelp av separat programmering og behandler tomme parameterverdier og parametere som ikke er spesifisert på samme måte.

Tildelingen av en tom verdi skyldes at to rørledninger umiddelbart følger hverandre. Den tilsvarende parameteren i mellom mottar en verditildeling og anses som spesifisert.

Problem: mellomrom rundt parameterverdier

Når det gjelder unavngitte ("nummererte") parametere, blir det alltid tatt i betraktning hvis blanke eller til og med linjeskift legges til før eller etter at verdien er spesifisert når verdien angis.

Dette fører imidlertid ofte til uønskede resultater, for eksempel hvis en URL ikke lenger er riktig satt sammen i ett stykke.

Mange, fremfor alt, mer moderne maler adressert til generelle forfattere, fanger imidlertid opp denne oppførselen gjennom separat programmering og reduserer verdien til det nyttige innholdet hvis det er fornuftig for denne applikasjonen. Mange eldre maler er imidlertid ikke forberedt på denne situasjonen.

Det er derfor bedre å ikke angi ekstra mellomrom for ikke navngitte parametere hvis programmeringen ikke er akkurat kjent.

Problemet eksisterer ikke med navngitte parametere; disse blir alltid “trimmet”, dvs. hentet fra omkringliggende mellomrom og linjeskift.

Problem: Generisk maskulin

Det generiske maskulin trenger ikke å brukes konsekvent for stillingsbetegnelser. I stedet kan to parametere for den mannlige og kvinnelige formen opprettes og evalueres sammen. For mer informasjon, se Hjelp: Infobokser / Kjønn .

Dokumentmaler

Se detaljert: Hjelp: maldokumentasjon

Maler som brukes i vanlige artikler bør utformes så enkelt at formålet og applikasjonen umiddelbart er forståelig. Uansett er en beskrivelse av deres funksjon nødvendig . Dette kan gjøres utenfor inkluderingsområdet på malsiden. Når det gjelder ofte integrerte maler, bør den funksjonelle beskrivelsen imidlertid bedre være på en egen side; disse kan deretter refereres til ved bruk av malen: dokumentasjon utenfor inkluderingsområdet på malsiden. En endring i selve malsiden har den effekten at alle avhengige sider må regenereres når de blir ringt opp igjen, i stedet for å kunne laste dem fra hurtigbufferen. Denne serverbelastningen bør unngås. Hensynet ovenfor er imidlertid bare relevant hvis revisjoner av dokumentasjonen kan forventes med uendrede funksjoner; outsourcing av dokumentasjonen forbedrer klarheten uansett.

Detaljert dokumentasjon på én underside

En underside av malen er egnet for detaljert dokumentasjon. Systemet til malen: Dokumentasjon bør brukes til dette. Dette forutsetter at malens funksjon er beskrevet på en underside /Doku malsiden. Innholdet på undersiden vises deretter når du ser på malsiden. Malen: Dokumentasjon er inkludert av <noinclude>{{Dokumentation}}</noinclude> på slutten av malen. For mer informasjon, se dokumentasjonen for malen: Documentation .

Kategorisering

Hver mal skal sorteres i en tilsvarende underkategori av kategorien: Mal:. Når du sorterer, må du finne en eller flere tematisk passende kategorier. Det er ikke tillatt å sortere maler i artikkelkategorier. Vedlikeholdskategorier er et unntak, der malen noen ganger også er inkludert i kategorien. 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