Skriva mallar

From Template Wiki, a repository of MediaWiki templates.
Jump to navigation Jump to search
This page is a translated version of the page Template writing and the translation is 100% complete.
Other languages:
English • ‎svenska

Då mallar ofta kan vara ganska invecklade och bero på olika externa faktorer, beskriver den här sidan några förslag för att skriva mallar.

Kod

  • Mallar borde upprätthålla sig själva och inte kalla på andra mallar (så länge det inte behövs).
  • Mallar som innehåller CSS i sin utformning borde nämna att de gör det. Rent allmänt är det bästa att undvika det, så länge inte CSS-klasserna är förinställda.
  • För ikoner som använder vector-grafik där det är möjligt. En bra källa för dessa är Category:Icons by subject på Wikimedia Commons. Miraheze-wikier har are instant commons aktiverat, annars skulle dessa bilder behövas laddas upp lokalt.

Användning

  • Mallar bör innehålla dokumentation för hur man använder och förändrar dem. Kräver de andra mallar, ska det tydligt framgå, med länkar till de krävda mallarna.
  • Mallar bör ha som mål att vara enkla att läsa och förstå även utan instruktioner.

Inmatningar

  • Försök inte göra den bästa och mest utvecklade mallen någonsin - försök inte göra allt en variabel som användaren behöver ange. Till exempel, mallens format; välj bara ett format och hårdkoda det, eller gör formatet förinställt.

Utformning

Det har blivit standard att använda dokumentationsundersidor (Template:templatename/doc), men det är egentligen bara bättre när mallen är tillräckligt stor eller har många exempel. För mindre, enklare mallar kan man bara lägga dokumentationen direkt på sidan. En /doc-undersida behöver oftast mallen {{Documentation}} som automatiskt lägger till en besittning på en annan mall.

Mallar som inte är färdiga borde läggas i :Category:Underconstruction templates via

  1. REDIRECT Template:Template link.

Externa länkar