Malldiskussion:dokumentation

Var placeras dokumentation?

Var ska vi placera dokumentation av mallar?

Alla grammatikmallar dokumenteras på en extern sida, och det gäller även många andra mallar. Jag har för mig att vi har pratat om att ha dokumentation centralt och alltså inte på var malls undersida eftersom varje mall nästan uteslutande används i ett särskilt sammanhang. På så vis slipper man redundant dokumentation för liknande mallar och kan lättare hålla koll på vilka som finns.

Om dokumentation inte placeras på undersida är den här mallen överflödig. Om vi planerar att ha det på undersidor bör mallnamnet gemeniseras (hitta bättre ord ) och "/dok" nog bytas ut mot "/Användning" (eller så bör användningsbeskrivningarna flyttas till "/dok"). //Skal 12 februari 2009 kl. 20.04 (CET)

Min tanke var att dokumentationsmallen skulle användas på andra mallar, inte grammatikmallarna. De flesta mallar finns i och för sig listade på Wiktionary:Mallar, såg jag nu, men enligt mig vore det bättre och mer användarvänligt om varje mallsida för sig hade en egen dokumentation, så som på Mall:?. Jag skulle för en tid sedan använda mallen Mall:Välkommen som tillsynes är väldigt lätt att infoga. Men även för mig, som är ganska erfaren med wikitekniken, tog det en stund att inse att mallen skulle substas. Jag kan tänka mig att nybörjaranvändare kan ha det svårt att använda dylika mallar, som kanske bara har en parameter. /Frisko 12 februari 2009 kl. 20.33 (CET)

Varje mall bör ha en länk till sida där instruktioner finns, självklart - på så vis blir det ändå lätt för nybörjare, samtidigt som man får fördelarna med centralisering. Men något system för dokumentation finns tyvärr inte organiserat än. //Skal 12 februari 2009 kl. 21.05 (CET)

Du har rätt, Frisko, att det inte är sån ordning som det borde vara vad gäller malldokumentationer. Det är bättre nu än innan, men det är en bit kvar. Vi har sagt att vi haft som mål att alla mallar som används ska finnas omnämnda på Wiktionary:Mallar, eller åtminstone länkade därifrån, som är fallet för exempelvis grammatikmallarna, som ju placerats på undersidor till stilguiden. Utöver det ska det finnas dokumentation för alla mallar, så att alla ska kunna ha en chans att använda mallarna, och inte bara de som skapat dem. Min åsikt är att det är mycket smidigare att hantera dokumentation centralt och länka dit från alla mallar, såsom görs i de uppdaterade grammatikmallarna. Platsen anser jag bör vara undersidor till Wiktionary:Mallar, om beskrivningen blir för otymplig att ha med på Wiktionary:Mallar-huvudsidan. Det kan säkert vara smidigt att ha en {{dokumentation}}-mall som ger länken till dokumentation på samma sätt som görs i grammatikmallarna, till Wiktionary:Mallar eller till aktuell undersida till Wiktionary:Mallar. ~ Dodde 13 februari 2009 kl. 14.54 (CET)

Jag har nu flyttat mallbeskrivningarna av {{ö}}/{{ö-}}, {{?}} och {{uttal}} till undersidor till Wiktionary:Mallar, och har uppdaterat mallarna och Wiktionary:Mallar så att de pekar på rätt sida för instruktionerna. Med den här strukturen känns det lite överflödigt med mallen {{dokumentation}}. Det är ett gäng mallbeskrivningar kvar att flytta, men tänkte visa upplägget med de här 3-4 mallarna till att börja med. Är detta något som kan funka? ~ Dodde 14 februari 2009 kl. 09.31 (CET)

Det bör finnas något enhetligt system så att man direkt kan avgöra vilken mall sidan hör till. Dokumentationen bör vara enhetligt beskriven. //Skal 16 februari 2009 kl. 18.22 (CET)

Utformning av dokumentation

Tänkte att vi gemensamt kan komma med förslag, så ändra gärna!

Exempel på hur Wiktionary:Mallar/ö skulle kunna se ut:

{{dokumentation|
{{mall|ö}} och {{mall|ö-}}|
Används på uppslagens översättningslistor.|
<nowiki>{{ö|<språkkod>|<översättning>|(<genus>)|(text=<visad text>)|(språk=<språknamn>)}}</nowiki>}}

...resten av malldokumentationen...

...tänkt att resultera i (kanske andra färger och layout):

Malldokumentation för {{ö}} och {{ö-}}

• Används på uppslagens översättningslistor.
• {{ö|<språkkod>|<översättning>|(<genus>)|(text=<visad text>)|(språk=<språknamn>)}}

...resten av malldokumentationen...

---

Tänkte att det vore bra om all dokumentation var enhetlig och markerades som sådan. Vad tycker ni om förslaget ovan? //Skal 16 februari 2009 kl. 19.58 (CET)

Är förstås för enhetlighet, och tycker också att det bör framgå tydligare och direkt vilken/vilka mallar sidan avser att beskriva. Det skiljer dock mycket mellan olika mallar/malltyper och behovet av dokumentation, så att...

1) ange vilka mallar sidan avser att beskriva

2) ange var mallarna avses att användas och eventuellt

3) ange vad (det huvudsakliga syftet) med mallarna är

...känns som de enda tre punkter som skulle kunna fungera gemensamt som inledning på alla undersidor till Wiktionary:Mallar (och kanske under varje rubrik på själva Wiktionary:Mallar?). Hur dessa tre punkter redovisas i inledningen på bästa sätt kan förstås diskuteras. Att gå in på mallsyntax redan i inledningen (som förslaget ovan föreslår i skrivande stund) bäddar för problem, enligt min åsikt. ~ Dodde 16 februari 2009 kl. 20.39 (CET)