Forum:Template Documentation Policy

From the RuneScape Wiki, the wiki for all things RuneScape
Jump to: navigation, search
Forums: Yew Grove > Template Documentation Policy
Archive
This page or section is an archive.
Please do not edit the contents of this page.
This thread was archived on 12 November 2012 by A proofreader.


I've recently come across a problem with the Wiki templates. Some of them, such as any of the Infobox templates, have some really good documentation on how to use them. However, others, such as Template:Coins small, Template:Topright, Template:Topleft, Template:!!, Template:!(, Template:(, and Template:(( all have some very poor documentation, and I know there are definitely others that have little to no documentation. Now, I know what these do, as do most people who use them, however, if a new user comes across these, they won't know how to use them.

Two things are being proposed here.

  1. Add a section to RuneScape:Templates, or if not there, a policy page, stating that all new templates must have proper documentation.
    1. If there are any exceptions to what should have documentation, please say what should not have it, and why. An obvious example would be any of the signatures.
  2. Create a project to provide all current templates with documentation.


Discussion

Support - As nominator. Blaze_fire.png12.png 00:54, November 3, 2012 (UTC)

Support - Sure, no harm in this is there? I remember sometimes not knowing how to use a template. HaidroH rune.pngEagle feather 3.pngCandle (blood red).png 1XqyDNM.png Crystal triskelion fragment 3.pngHazelmere's signet ring.png 02:47, November 3, 2012 (UTC)

Support - Yes please. Not all editors know how to look into templates to see how one is meant to be used. Infobox ones have way too much stuff in it, and without the doc it would be a nightmare, but even things like {{FloorNumber}} can be confusing.

 a proofreader ▸ 

06:26, November 3, 2012 (UTC)

Support - Templates without documentation is just too horrible Explore and enjoy the world! TIMMMO Work it with all my heart!++Discuss Sign 07:56, November 3, 2012 (UTC)

Support - Aye, definitely. User_talk:Fswe1 Fswe1 Brassica Prime symbol.png 10:56, November 3, 2012 (UTC)

Support - Documentation is always nice. Hair 15:25, November 4, 2012 (UTC)

Support - A confused Ferg is never a good thing. sssSp7p.pngIjLCqFF.png 16:01, November 4, 2012 (UTC)

But I confuse you all the time! D: svco4bY.png3Gf5N2F.png 22:10, November 8, 2012 (UTC)
confüs* MolMan 22:12, November 8, 2012 (UTC)

Support - Per proof. — Jr Mime (talk) 16:03, November 4, 2012 (UTC)

Closed - This thread creates the template policy for the RuneScape Wiki and adds a requirement to document templates. There is now also enough substance to create a project to document existing templates. The criteria that determine which templates need to be documented need to be fleshed out a bit further, such as for the obscure templates !( and ((, and I've added a section about template preloads which needs more information.

 a proofreader ▸ 

10:04, November 12, 2012 (UTC)