LIMSpec Wiki
Innehåll
Manual | |
---|---|
För läsare
| |
För skribenter
| |
För administratörer
| |
Se även
| |
En mall är ett hjälpmedel för att infoga samma sak på många sidor, till exempel ett meddelande eller en navigationsruta, ofta (men inte alltid) utformad i en ruta. Infogandet av en mall kallas ofta transkludering.
En mall är i praktiken en Wikipedia-sida som är avsedd att inkluderas inuti en annan Wikipedia-sida. De flesta mallar återfinns i namnrymden "Mall:" och under kategorin Mallar.
Rätt använda kan mallar underlätta redigerandet för såväl en själv som för andra användare, men att skapa eller ändra mallar är komplicerat och förknippat med vissa risker.
Att använda mallar
Anrop
När man ska använda en mall i en artikel skriver man mallens namn (utan förledet för namnrymden "Mall:") inom dubbla klammerparenteser:
{{Mallens namn}}
Om mallen har parametrar fyller man även i dessa:
{{Mallens namn |En parameter = Ett värde |En parameter till = Ännu ett värde |Värdet på en namnlös parameter (nummer 1) |Värdet på en annan namnlös parameter (nummer 2) }}
En mall kan placeras var som helst i en artikel, men ofta har mallen en förutbestämd plats i artikelns disposition där det är rekommenderat att placera den. Mallar kan i sin tur anropa andra mallar.
Man kan även inkludera andra sidor på samma sätt som med mallar. Då lägger man in rätt namnrymd:
{{Namnrymd:Sidnamn}}
Namnrymden för vanliga artiklar är bara ett kolon:
{{:Artikelnamn}}
Mallen "testmall" på en undersida till en användarsida:
{{Användare:Användarnamn/testmall|para|metrar}}
Substitution
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 i samband med anropet:
{{subst:Mallens 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 då, 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 Wikipedia:Substitution.
Om man vill kopiera in innehållet i en mall utan att dess wiki-kod utförs så skriver man
{{msgnw:Mallens 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 skapa och ändra mallar
Att tänka på
- Mallar har oftast en avancerad syntax (programspråk), vilket gör att vissa förkunskaper krävs.
- 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.
- Kom ihåg att ge nya mallar en lämplig underkategori till Kategori:Mallar (innanför noinclude-taggar och med lämplig sortering, <noinclude>[[Kategori:Kategorinamn]]</noinclude>, så att mallen hamnar i kategorin men inte sidorna den används i), då du konstaterat att mallen fungerar. Så slipper andra att uppfinna "ditt" hjul igen.
- Rekursion är inte tillåtet, dvs en mall kan inte direkt eller indirekt anropa sig själv eller en överordnad mall
- 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.[1]
Namngivning
Mallar är normalt sidor i namnrymden "Mall:". En sådan mall är alltså en sida med namngivning enligt formen:
- Mall:mallensnamn
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 ( _ ).
Mallars namn får gärna vara beskrivande och behöver inte vara så korta som möjligt. Förkortningar (speciellt egenpåhittade) kan orsaka förvirring eftersom de kan ha flera betydelser eller inte är allmänt kända. Till exempel står språkkoderna sv och en i Mall:Sv och Mall:En för svenska och engelska, men Mall:No är inte språkkoden no för norska utan det engelska ordet "no".
Grafisk utformning
Bilder
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 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. Använd sådana bara i deras egentliga betydelse, inte till exempel nationalflaggor för att representera språk.
- Bilden måste vara fri, enligt riktlinjerna på Wikimedia Commons. Om du skall ladda upp en ny bild måste du ange licens, upphovsman och källa. Till exempel kan de flesta företagslogotyper inte användas.
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 mallanrop med ett extra par klammerparenteser runtom:
{{{Variabelnamn}}}
En parameter kan även vara styrd av vilken plats den ligger på i mallanropet. En mall med anropssyntaxen:
{{Mallens namn|x=blabla|a|b|c}}
har följande variabler i sin kod:
{{{x}}}=blabla {{{1}}}=a {{{2}}}=b {{{3}}}=c
Man kan se vilken parameter som hamnar var 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.
Dokumentation
För att andra ska veta hur mallen är tänkt att användas och som stöd för ditt eget minne bör alla nya mallar dokumenteras. Det görs numera med mallen {{Dokumentation}}
. För att enklast lägga till dokumentation till den färdiga mallen avslutar du den nya mallens wikikod med
Mallens wikikod<noinclude> {{Dokumentation}}</noinclude>
När du sedan förhandsgranskar eller sparat mallen klickar du på länken [skapa] i det gröna fältet, för att skapa mallens dokumentation utifrån ett förslag till disposition. Dokumentationen sparas sedan som en undersida till mallen och inkluderas i mallsidan, men tack vare noinclude-taggarna kommer den inte med när mallen används.
I malldokumentationen finns även anvisat utrymme där du kan lägga kategorierna. Dessa kommer också att inkluderas, och ska alltså inte finnas på själva mallsidan.
Då en dokumentationssida är skapad kommer mallsidan att ha en länk [redigera] för vidare redigering av dokumentationssidan.
Typer av mallar
Meddelandemallar
Meddelandemall avser på Wikipedia en mall vars syfte är att till användare framföra någon form av metainformation relaterad till en artikel.
Meddelandemallen placeras i regel på artikelns huvudsida, men ibland istället på dess diskussionssida.
Åtgärdsmallar
Den vanligaste typen av meddelandemall är åtgärdsmallar. En typ av åtgärdsmall är stubmallar, som används för att markera ut stubbar. Även ursprungsmallar (se nedan) kan ses som en form av åtgärdsmallar.
Pågåendemallar
Pågåendemallar informerar läsaren om att artikeln (delvis) behandlar ett pågående skeende, och att informationen därför kan komma att förändras snabbt, allteftersom ny information blir känd och läggs in i artikeln, ibland (som vid katastrofer och andra nyhetshändelser) under medverkan av många användare. När händelsen är över och redigeringsaktiviteten avtagit så avlägsnas mallen.
Pågåendemallar har tidigare föreslagits för radering, med resultatet behåll.
Framtidsmallar
Framtidsmallar informerar läsaren om att artikeln (helt eller delvis) behandlar ett framtida skeende, och att informationen därför kan komma att förändras, allteftersom ny information blir känd och planer förändras. Mallen avlägsnas när händelsen är över och artikeln beskriver nu- eller dåtid snarare än framtid.
Det råder delade meningar om framtidsmallar bör användas på svenskspråkiga Wikipedia. På engelskspråkiga Wikipedia har man slutat använda dem, och istället övergått till mallen Crystal för att endast malla spekulativt material om framtida händelser (Vad Wikipedia inte är: Ingen kristallkula).
Användarmallar
Användarmallar är meddelandemallar avsedda för användares diskussionssidor (ej att förväxla med användarrutor, som är avsedda att läggas in på användarsidor). 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.
Projektmallar
Projektmallar är en form av meddelandemallar som 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.
Faktamallar
Faktamallar skapar en faktaruta med basala uppgifter om uppslagsordet, och placeras i det övre högra hörnet i inledningen av en artikel. Djur, växter, filmer, orter, kommuner och församlingar är några kategorier av artiklar som ofta utnyttjar faktarutor.
Navigationsmallar
Navigationsrutor eller navigationsmallar (även kallade navigeringsmallar) syftar till att skapa korsreferenser och underlätta navigering mellan grupper av relaterade artiklar.
De flesta navigationsmallar har ett liggande format och placeras underst i artikelns disposition. Många av dessa är baserade på metamallen Navbox.
Det finns dessutom ett fåtal navigationsmallar som har ett stående format, med avsedd placering överst i artikeln. Dessa mallar är kontroversiella i artikelnamnrymden. Till nackdelarna brukar räknas att de riskerar att begränsa andra layoutmässiga möjligheter i artikelns inledning, så som framför allt inledningsbilder och faktarutor, att bristande grafisk standard gör svenska Wikipedia mer svårläst, samt att de överst placerade navigationsrutorna ger en otillbörlig vikt åt navigationen på bekostnad av artikelns innehåll. Till fördelarna brukar räknas bland annat att de tack vare sin position är lättare att upptäcka för läsaren, samt att de vid behov kan placeras direkt i relevanta avsnitt utan att bryta textflödet.
OBS! För närvarande (april 2021) tillhör navbox-baserade navigationsmallar det sidinnehåll som inte visas i Wikipedias mobila läge (kan nås via länken "Mobil vy" längst ner när du surfar från en dator).
Källmallar
Källmallar avser att underlätta Källhänvisningar, som är viktiga för Wikipedia.
Vanliga källmallar är tex {{Bokref}}
och {{Webbref}}
, som underlättar att skapa en tydlig källhänvisning för en viss typ av källa. Det finns även källmallar som underlättar referenser inom en artikel, så som {{harvnb}}
och {{fotnot}}
.
|
Ursprungsmallar
En ursprungsmall kan ses som en kombination av en källmall och en åtgärdsmall, med syfte att informera läsaren om dels en ursprunglig källa till artikeln (exempelvis "Ugglan" eller en annan språkversion), och dels de eventuella brister i artikeln som denna källa kan vara upphov till (liksom vid åtgärdsmallar som varning såväl som uppmaning att bidra till en bättre artikel). Till skillnad mot egentliga källmallar handlar dock ursprungsmallar om textens ursprung snarare än informationens ursprung. Ursprungsmallar placeras längst ner i en artikel, i anslutning till eventuella navigationsrutor. Ursprungsmallarnas formgivning är snarlik de tidigare stubbmallarnas, då de skrivs med kursiv stil, och ofta inleds med en liten symbolbild, men ingen "list-punkt". Många ursprungsmallar baseras på {{Artikelursprung}}
.
Ursprungsmallar har ibland kritiserats för att ha spelat ut sitt syfte då många artiklar med dessa mallar sedan länge har befriats från respektive ursprungskällas brister, och ursprungskällan är ofta inte den dominerande källan. Vissa ursprungsmallar har på dessa grunder börjat ersättas den rena källmallen {{Runeberg.org}}
.
Kategorisering av sidor via mallar
Kategorier som läggs in i en mall utan att omges med <noinclude>-taggar kommer också att placera alla sidor som använder den mallen i kategorin. Lämpligheten av detta varierar mellan olika typer av mallar, och ibland har olika Wikipediaanvändare olika åsikter om huruvida det är lämpligt att kategorisera via mall.
Mallar som används för kvalitetskontroll, och därmed inte är avsedda att ligga i artiklarna permanent, lägger ofta artikeln i motsvarande kvalitetskontrollkategori. Fördelar med detta är bland annat att man bara behöver redigera på ett ställe i artikeln när problemet åtgärdats, och att kategorierna underlättar systematiskt arbete med att åtgärda problem.
Om ursprungsmallar ses som kvalitetskontrollmallar gäller samma resonemang för dem. Kategorisering via ursprungsmallar har kritiserats för att inte fylla någon egentlig funktion, i samband med synen att mallarnas funktion enbart är att tala om var texten kommer ifrån.
Källmallar och användarmallar kategoriserar normalt inte sidorna de läggs in på.
Faktamallar och navigeringsmallar kategoriserade ofta artiklar i Wikipedias barndom. Detta har mer och mer avvecklats, av flera skäl:
- Det är svårt att veta vilken mall som placerar en sida i en kategori utan att gå igenom alla mallarna som används på en sida.
- När en mall skapas kan det vara svårt att förutse i vilka artiklar den kan användas. Om mallen kommer till användning i en bredare samling artiklar än det ursprungligen var tänkt kan kategorin vara olämplig för de nya artiklarna.
- Om förhållanden ändras kan kategorin bli olämplig för vissa artiklar, trots att mallen fortfarande är lämplig.
- Om det finns en lämplig underkategori till den kategori som läggs in av mallen kan inte artiklar som passar i underkategorin läggas in där utan att artiklarna hamnar i både över- och underkategorin, vilket brukar avrådas från.
Trots detta används kategorisering via mallar fortfarande i vissa sammanhang, så någon klar konsensus om när mallkategorisering är lämpligt finns kanske inte.
Se även
Namnrymder | |||
---|---|---|---|
Aktuell lista (API-anrop) | |||
Innehållsnamnrymder | Diskussionsnamnrymder | ||
0 | (Artikel) | Diskussion | 1 |
2 | Användare | Användardiskussion | 3 |
4 | Wikipedia | Wikipediadiskussion | 5 |
6 | Fil | Fildiskussion | 7 |
8 | MediaWiki | MediaWiki-diskussion | 9 |
10 | Mall | Malldiskussion | 11 |
12 | Hjälp | Hjälpdiskussion | 13 |
14 | Kategori | Kategoridiskussion | 15 |
100 | Portal | Portaldiskussion | 101 |
828 | Modul | Moduldiskussion | 829 |
2600 | Ämne | — | |
Virtuella namnrymder | |||
-1 | Special | — | |
-2 | Media | — | |
- Wikipedia:Meddelandemall
- Wikipedia:Åtgärdsmall
- Användarrutor
- Wikipedia:Projekt mallstandardisering
{{Mallhjälp}}
Referenser
Noter
Vidare läsning
- m:Help:A quick guide to templates (engelska)
- m:Help:Template (engelska)
Externa länkar
- mw:Help:Templates Hjälpsida på MediaWiki (engelska)
- meta:Help:Template Hjälpsida på Meta (engelska)