KDU
Från Rilpedia
| Stilguide |  |
|---|---|
|
Innehåll
Formatering Struktur Länkar |
|
En mall, tidigare kallad meddelandevariabel, är ett hjälpmedel för att infoga standardiserade textavsnitt, figurer, tabeller eller annat som man vill ska se ut på ett likartat sätt på många sidor. Mallen är en stomme och i varje artikel anropas den med en enkel text. Därmed slipper man skriva in hela standardtexten på varje sida. Rätt använda kan mallar underlätta redigerandet för såväl en själv som ens medwikipedianer, men överdrivet bruk av mallar kan även ha risker.
Innehåll |
Allmänt
En mall är en speciell artikel (i Kategori:Mallar) som innehåller en stomme till en standardiserad text, ruta och liknande som del av en artikel. Mallar kan användas på många olika sätt, allt från att sätta in några ord eller en länk till utförliga "rutor". I teorin går det även att använda mallar till avancerade programfunktioner; detta är de dock inte avsedda för, och Wikimedias utvecklare brukar avråda från det.
Typer av mallar
Standardmeddelanden
Exempel på standardmeddelanden är {{ickewiki}} och {{POV}}, flera liknande finns här. Oftast används den här typen av mallar för kvalitetkontroll. Standardmeddelanden bör motiveras med ett utvecklat resonemang på artikelns diskussionssida.
Stubmallar
Stubbmallar, som {{stub}}, används för att markera ut stubbar.
För att underlätta hopp mellan en grupp av närbesläktade artiklar, skapas lätt en mall, till exempel serien om Solsystemet (använder Mall:Solsystemet).
Man försöker standardisera navigationsrutorna till att utgå från Mall:Navbox.
Projektmallar
Projektmallar placeras på artiklars diskussionssidor, för att hugade användare ska kunna hitta till projektet. De kan dessutom innehålla uppgifter om artikeln ifråga ur projektets synpunkt, såsom hur viktig den är att förbättra eller hurpass långt utvecklad den är.
Mallar för referenslitteratur
Källhänvisningar är viktiga för Wikipedia och inom ett projekt hänvisar man ofta till samma referenslitteratur. För att slippa upprepa hela källhänvisningen varje gång, med den risk detta innebär för skrivfel, kan man inrätta en mall som gör de vanligaste källorna tillgängliga med kortnamn. Ett exempel är mallen Ref orglar.
Mallar för användares diskussionssidor
Denna typ av mallar är förmodligen den mest kontroversiella, då många användare ogillar att få opersonliga mall-meddelanden istället för text som användaren formulerat själv. Mest allmänt accepterade är nog klottermallarna och mallarna för problematiska användare, eftersom det ofta inte känns meningsfullt att lägga ner tid på personligt utformade meddelanden till sådana användare. Därnäst kommer förmodligen välkommenmallarna, som ger mer eller mindre nytillkomna användare en introduktion till några nyttiga sidor att läsa.
Namnstandard för mallar
Mallar är normalt artiklar i namnrymden Mall. En sådan mall är alltså en sida med namn på formen
- Mall:mall-namn
Sidor som används som mallar kan dock i princip heta vad som helst och ligga i andra namnrymder (med vissa, små nackdelar). Ett exempel på användning av mallar utanför Mall-namnrymden är användarrutor, som med fördel läggs som undersidor i användarnamnrymden.
Precis som för andra typer av sidor skiljer mallarna på stora och små bokstäver i sidtiteln, förutom i första bokstaven, och blanksteg är ekvivalent med understeck ( _ ).
Grafisk utformning av mallar
Bilder i mallar
En mall kan innehålla en eller flera bilder, om det gör mallen lättare att förstå. Ett par riktlinjer för bilder i mallar:
- Bilden måste vara fri från upphovsrätt. Till exempel ska inte företagslogotyper användas i mallar.
- Bilden bör vara stor nog för att det ska synas vad den föreställer, men inte så stor att den stör mallens layout.
- Det är ofta en fördel att välja enkla, entydiga och etablerade piktogram, som flaggor, vägmärken, stiliserade vardagsföremål och liknande.
Exempel finns att se i Kategori:Stubbmallar.
Användning av mallar
När man ska använda en mall i en artikel så skriver man {{Mallens namn}}, om mallen har parametrar så fyller man i dessa:
{{Mallens namn
|En parameter = Ett värde
|En parameter till = Ännu ett värde
}}
Detta kan göras var som helst i en artikel, men oftast så har mallen en redan förbestämd plats i artikeln texten där det är rekommenderat att placera den.
Mallar kan i sin tur anropa andra mallar, men rekursion är inte tillåtet, dvs en mall kan inte direkt eller indirekt anropa sig själv eller en överordnad mall.
Man kan även inkludera andra sidor på samma sätt som med mallar, då skriver man {{Namnrymd:Artikelnamn}}. Namnrymden för vanliga artiklar är bara ett kolon (:)
Parametrar och variabler
Mallar som används för att strukturera upp innehållet på ett speciellt sätt innehåller ofta variabler, i mallkoden ser dessa ut som mallanropp med ett extra par hakparanteser runtom:
{{{En parameter}}}
En parameter kan även vara styrd av vilken plats den ligger på i mallanropet.
I en mall med anropssyntaxen:
{{Mallens namn|1|2|3}}
har följande variabler i sin kod:
{{{1}}}
{{{2}}}
{{{3}}}
Man kan se vilken parameter som hamnar vart i mallen i mallens dokumentation, om en sådan finns.
När man fyller i parametrarna i ett mallanrop med värden och sparar artikeln så rensar MediaWiki bort alla överflödiga mellanslag i början och slutet av alla variabler, samma gäller alla parserfunktioner.
Statisk kopia av mall
En av fördelarna med mallar är att ändringar i mallen direkt visas på alla de sidor som använder mallen. Om man inte vill ha denna effekt skriver man ordet subst (engelskans substitute=ersätt) framför mallens namn
- {{subst:mall-namn}}
Då kopieras mallens innehåll till den plats där den anropas när man sparar artikelsidan (se "Gör så här" nedan). Det blir alltså inte längre ett anrop till mallen utan en statisk ("engångs"-) kopia. Allt som mallen är gjord för visas, men förändringar i mallen som görs senare kan inte påverka artikeln. Tekniken kan även användas om man vill göra modifieringar för att passa en viss artikel utan att påverka alla andra artiklar som använder mallen. Se vidare Rilpedia:Substitution.
Om man vill kopiera in innehållet i en mall utan att dess wiki-kod utförs så skriver man
- {{msgnw:mall-namn}}
Då hämtas mallens text och omges med <nowiki>-markeringar så att mallens text visas helt utan tolkning.
Gör så här:
- Skriv in anrop enligt ovan (med sina dubbla klamrar)
- Spara artikeln (det räcker inte med förhandsvisning !)
- Starta redigering igen. Då finns hela mallens innehåll inkopierat i artikeln där anropskoden tidigare stod.
Att hitta existerande mallar
Alla mallar läggs i Kategori:Mallar eller dess underkategorier så där kan man leta. För att leta i en strukturerad lista går man till Rilpedia:Lista över mallar eller någon av dess undersidor.
Om Du själv skapar en mall så kom ihåg att ge den Kategori:Mallar och att lägga in den på lämpligt ställe i listan. Så slipper andra att uppfinna "ditt" hjul igen.
Att ändra i existerande mallar
Ett par små varningar är här på sin plats.
- Mallar har oftast en avancerad syntax (programspråk) så man måste kunna en del för att få det rätt.
- Kolla hur många sidor som använder mallen innan du ändrar något. Det kan bli mycket jobb att kolla att den nya varianten fungerar i alla dessa.
- Om det inte fungerade kan man återställa till senast fungerande version i mallens historik.
