Hjálp:Upplýsingaskjölun

Upplýsingaskjölun er mikilvæg á Wikipedia, þar sem það gefur mikilvægar upplýsingar um tilgang og notkun sniða sem auðveldar öðrum notendum að notfæra sér sniðin á réttan hátt. Allar upplýsingar sem birtast með skjölunarsniðinu eru innleiddar úr meðfylgjandi /doc undirsíðu til þess að aðskilja það frá sjálfum sniðkóðanum.

Þetta kemur í veg fyrir slys þar sem sniðkóðinn brotnar auk þess að gefa notendum auðvelda leið til að uppfæra upplýsingarnar eða skapa sandkassa og prufudæmi.

Skjölun á ekki eingöngu við um snið, heldur er það einnig notað á t.d. skriftum (modules) og síðum sem innihalda efni sem á að innleiða á öðrum síðum.

Hvernig bætir maður við skjölunarsniði?

Almennt

Það eina sem þarf er að lauma inn {{Documentation}} inn í <noinclude>...</noinclude> merkingar neðst í sniðið. Allir flokkar sem sniðið á að fara í verður síðan bætt við á /doc undirsíðunni eftirá.

<!---

Sniðkóðinn / Efni til innleiðingar

-----><noinclude>{{Documentation}}</noinclude>

Fyrir skriftur (module)

Skriftur eru öðruvísi en hefðbundnar síður á Wikipedia; þær eru sjálfkrafa með tengda /doc undirsíðu. Hér þarf að nota aðra aðferð til að fá skjölunarkassann utan um upplýsingarnar.

<includeonly>{{Doucmentation/start}}</includeonly>{{Documentation subpage}}
<!---

Upplýsingarnar

--->
<includeonly>{{Documentation/end}}</includeonly>

Notkun á <includeonly> lætur það einungis birtast þegar skriftan sjálf er skoðuð, en ekki á skjölunarundirsíðunni.

Hvað fer í skjölunar undirsíður?

Upplýsingar `/doc`

Það er ekkert að því að vísa bara í sniðupplýsingar á upprunalegu ensku Wikipedia ef sniðið kemur þaðan, sérstaklega ef það er flókið snið; bara muna að gera tungumálatengingu á milli sniða í þeim tilfellum.

{{Documentation subpage}} efst, það flokkar undirsíðuna og vísa í síðuna sem upplýsingarnar tengjast.
Lýsing á tilgangi (t.d. hvar á að nota sniðið)
Notkunarleiðbeiningar
Upplýsingar um breytur (ef á við, einnig hægt að nota eingöngu snimátsgögn til að birta upplýsingar um breytur)
Sýnidæmi
Sniðmátsgögn (e. TemplateData)
Tengt efni (t.d. sambærileg snið eða tenglar í hjálparsíður sem sniðið tengist)
Flokkar (setjið þá inn í <includeonly>...</includeonly> merkingar)

Sandkassi

Ef það á að breyta sniði sem er nú þegar í notkun á öðrum síðum, þá skal nota sandkassann til að gera breytingar á sniðkóða eða til að sýna tillögur að breytingum sem hægt er að spjalla um áður en núverandi sniðið er uppfært. Þá er hægt að kalla á sandkassa útgáfu sniðs með {{Nafnsniðs/sandkassi}} til að prófa það. Ráðlagt er að setja upp prufudæma undirsíðuna ef verið er að fikta í flóknum sniðum.

Prufudæmi

Tilgangur prufudæma er helst að bera saman núverandi snið við sandkassa útgáfu þess til að vera viss um að breytingar séu ekki að fara brjóta núverandi notkun sniðs. {{Prufudæmi}} er snið sem setur upp slík dæmi sem hægt er að nota á pufudæma síðunni.