Stilguide
För att få enhetligt utseende och underlätta för dem som skriver, läser i eller söker efter sidor i Sockipedia så finns några konventioner om hur sidor om platser och andra sidor namnges och hur de utformas. Man måste inte följa alla konventioner, men gör man det underlättar det för både bidragare och tittare.
Varför ska jag följa stilguiden ?
Stilguiden är en guide som utvecklats över tid. Det har varit svårt att se alla konsekvenser på funktionalitet, alla skillnader mellan olika socknars behov och alltid hålla fokus på våra tittare, de som läser och tar till sig det vi publicerar. Som ny användare kan det verka onödigt att styra upp alla små detaljer, men de har visat sig få större konsekvenser senare i arbetet. En sidas avvikelse kan verka obetydlig, men 500 avvikande sidor är inte roligt att ändra i efterskott för hand.
För att få en bättre förståelse för konsekvenserna att följa eller inte följa stilguiden kan man se några positiva effekter och några risker.
Positiva effekter
Om man följer stilguiden när man skapar eller redigerar en sida så leder det till följande bra effekter:
- det blir lättare för läsare att hitta och förstå materialet
- det blir lättare för kommande bidragare att lägga till nytt material
- med automatik kommer man in i funktionalitet som kartor, översikter, listor m m
- nya funktioner (typ kartor, listor m m) kan byggas på de standardiserade sidorna
Risker om man inte följer
Inget tvingar någon att följa stilguiden, men om man inte gör det finns en del risker:
- det kan bli svårare för en tittare att hitta materialet, Google med flera kanske inte indexerar sidan
- platsen, bilden eller sidan kanske inte syns i översikter och kartor
- framtida större automatiska ändringar/uppdateringar kan hindras av sidor/bilder som inte följer standard
- fel i namnsättning m m skapar sidor som skräpar ner, aldrig hittas och måste tas bort vid städning
- det skapar arbete får andra som kanske måste flytta/ändra text, bilder eller sidor du gjort
Tänk på
- 50 % av Sockipedia besökare använder mobil vilket medför att deras skärm är liten.
- 90% av besökarna är vanliga tittare nyfikna på lokalhistoria och inte forskare eller kunniga i lokalhistoria.
Har du förslag på något som bör ändras eller läggas till i stilguiden, var med på Öppet Möte eller skriv till support@sockipedia.se.
Organisation av sidor
En sida bör avhandla ett ämne t ex en person, en släkt, en plats, ett fenomen, en gård eller en händelse. Undantaget är sidor för socknar kan innehålla förteckningar, översikter och beskrivningar av vad som finns i socknen, samt verksamhetstyper (t ex handelsbodarna, skolor, träindustrin, järnvägen, gruvorna) inom socknen.
Sidnamn
Varje sida ska ha ett namn, som inte behöver vara samma som titeln på sidan. Namnet används i länkar till sidan och när man hämtar sidan.
Prefix
Många socknar kommer att finnas i Sockipedia, därför är det viktigt att skilja de olika socknarnas sidor åt. Det finns t ex 281 platser med namnet "Hult" i Sverige enligt ortnamnsregistret. Varje sidnamn inom en socken ska därför inledas med ett prefix bestående av landskap och socken. Så för platsen "Gyltungebyn" så ska sidan heta "Dalsland/Ånimskog/Gyltungebyn". Detta återspeglas även på bilder (se nedan), där bilder för Gyltungebyn inleds med "Dalsland-Ånimskog", t ex "Dalsland-Ånimskog-AnderssonsFamiljFramförStugan.jpg" Lägg märke till att plats ska ha / (snedstreck) mellan namnen i prefixet, medan fotografier använder - (bindestreck) mellan namnen i prefixet.
Ej tillåtna tecken i sidnamn
Det är inte tillåtet att använda nummertecken (#), större/mindre än (><), hakparentes ([]) eller klammerparentes ({}) i sidnamn. Undvik också bakåtstreck (\) och procenttecken (%) som kan misstolkas av program eller programtillägg.
Välja namn
Välj ett namn som är lätt att hitta, inte historisk korrekt eller lokalt korrekt uttalat. Tänk på att många tittare inte bor i just din lokala socken, och att Sockipedia inte har ambitionen att fungera som en rikslikare för geografiska namn. Lokalt uttal som skrivs med speciella tecken, t ex "Bråtekôl" kan också vara svåra att mata in, och fungerar inte i alla sökningar. Ge sidan namnet "Bråtekullen" och ange sedan alternativa namn enligt nedan.
Särskilja platser med samma namn
Samma namn används ofta på flera ställen inom en socken. Kvalificera i så fall sidnamnet med hemman eller gården inom parentes efter namnet. T ex finns tre "Kasa" inom Ånimskog och de blir då "Kasa (Slobol)", "Kasa (Stora Mossen)" och "Kasa (Vingnäs)".
Flera namn, stavningar och/eller lokalt uttal
Välj ett namn som sidnamn och ange det i mallen "NyPlats" elller i sidtitel (se DISPLAYTITLE nedan) och skriv sedan alternativa namn/stavningar först på en rad i den löpande texten på sidan. T ex "Alternativa namn/stavningar: Bråtekôl"
Saknade namn och namn saknas
Ibland är en plats känd eller torpruiner hittade utan att man kan fastställa vad namnet var. Kanske den aldrig hade något namn. Då kan sidnamnet vara ett område och ett nummer, t ex "Kerstan I", "Kerstan II", "Kerstan III" och "Kerstan IV" (romerska siffror helst).
Geografiska tillägg
I fler platsnamn finns geografiska bestämningar eller tillägg, t ex Nedre/Övre, Östra/Norra/Västra/Södra, Lilla/Stora, Gamla/Nya osv. I en del litteratur skrivs detta efter för att underlätta sortering "Kilane, Nedre". I Sockipedia kan sorteringsnamn anges separat och därför är konventionen att alltid placera tillägget först, såsom "Nedre Kilane", "Östra Berg" och "Stora Bräcke" i både sidnamn, mallen NyPlats och eventuell sidtitel. Använd inte heller förkortningar utan skriv ut hela tillägget. Skriv inte "L:a Bräcke" utan "Lilla Bräcke", inte "S. Molndy" utan "Södra Molndy". Ibland kan tillägget kännas språkligt konstigt före namnet, skriv då som det som känns bäst, t ex "Kilane Mellom" kan kännas bättre än "Mellom Kilane".
Geografiska tillägg som blivit egennamn
Några geografiska tillägg har blivit en integrerad del av egennamnet, skriv då såsom platsen kallas. Tex "Väst i Stuga", "Yttre Bodane", "Västergården". "Yttre Bodane" har dock sorteringsnamnet "Bodane Yttre" och hamnar efter "Östra Berg" (som sorteras på "Berg Östra").
Mallar och "magiska ord" att använda
För att få ett enhetligt utseende så används "mallar", definierade i Sockipedia och s k "magiska ord" som ersätts eller trollas med av programvaran MediaWiki när sidan visas. Exempel på mall som gjorts i Sockipedia är "NyPlats" nedan, och exempel på "magiska ord" är "DISPLAYTITLE" nedan. Båda påverkar på ett givet sätt sidan utseende när den lagras/visas. "Magiska ord" finns det många av dokumenterade hos programvaran MediaWiki (som Sockipedia använder).
DISPLAYTITLE
Sidans rubrik kan sättas med det "magiska ordet" DISPLAYTITLE, detta sätts dock automatiskt om man använder mallen NyPlats, se nedan. Om man inte anger DISPLAYTITLE blir rubriken samma som sidnamnet, men för Sockipedias sidor kan det vara lite svårt att läsa, eftersom vi använder prefix, se ovan. Med DISPLAYTITLE kan "Dalsland/Ånimskog/Potskontoret" få sidrubriken "Postkontoret" eller "Postkontoret i Lilla Mossen". Det verkar inte finnas ett sätt att infoga "magiska ord" med den visuella redigeraren, så man får använda "Redigera wikitext". Skriv in texten "{{DISPLAYTITLE:Min-titel-här}}" (OBS kolon!) ensamt på den första raden i wikitexten och spara. Tips: Titta på en befintlig sidas wikitext med "Redigera wikitext", det går alltid att "Avbryta" eller byta till den visuella redigeraren.
NyPlats
NyPlats är en mall för att skapa en inforuta om en Plats. Det är stark rekommenderat att använda den, då den sätter ett antal egenskaper som är användbara i förteckningar, kartor m m.
Konventioner för uppladdade bilder och andra filer
Namnkonvention
När man laddar upp en bild eller annat dokument/fil till Sockipedia kan man välja att ange ett nytt namn. För att alla bilder ska kunna hittas och för att särskilja olika socknars bilder så ska namnet ha ett prefix, ungefär som sidorna ovan. Ett snedstreck fungerar dock inte i filnamn så man får använda bindestreck. Så en bild med familjen Andersson framför sin stuga bör namnges "Dalsland-Ånimskog-AnderssonsFamiljFramförStugan.jpg" eller "Dalsland-Ånimskog-Anderssons familj framför stugan.jpg" och med prefix för landskap och socken.
GeoJson-filer är en speciell typ av fil som används i kombination med kartor på sidor, till exempel för att visa en socken eller ett hemans geografiska utbredning. Dessa filer/sidor ska namnges på samma sätt som övriga filer med prefixet Landskap-Socken- som prefix, till exempel Östergötland-Åsbo-Strålsnäs.
Bildbeskrivning
Skriv om möjligt vad fotot visar, vem fotografen var, vem som är innehavare av kortet eller källa och vilket år då fotot är taget. Skriv inte någon personligt, t ex "Min farfar Gustaf" eller "här står jag framför..."
Noter, referenser, källor och mera information
Det finns många sätt att förtydliga text och hjälpa läsaren med var texten kommer ifrån. Här är ett förslag på hur man kan skilja olika förbättringar åt. Det är bara ett förslag, man behöver inte följa det. Ett exempel (om än lite krystat) finns här. Observera nya rubriker för varje del.
Noter
Noter avser en ytterligare förklaring, förtydligande eller tillägg till en specifik plats i en text. Använd "<ref>" och "<references/>"-taggarna (i WikiText) eller Ange källa (i Visuella redigeraren), se mer dokumentation.
Referenser
För att peka ut från Sockipedia och in i en annan webbplats, webbsida eller bok/text kan man använda referenser. Var gärna så tydlig som möjligt och ge länkar om möjligt. Använd "<ref>" och "<references/>"-taggarna (i WikiText) eller mallarna (i Visuella redigeraren), se mer dokumentation.
Källor
Källor gäller övergripande för en sida, där text inte används ordagrant eller är citat. Använda gärna punktform och länkar.
Mera information
Mera information (med eventuella länkar) handlar om var läsaren kan hitta mer information om ämnet som sidan handlar om. Använda gärna punktform och länkar.
