User:Magill/Sandbox-Template Notes

Template documentation project

• User:Magill/Sandbox-Template_scratch

Goals

• Develop consistent formats for /doc pages

• Probably one for short/simple templates and another for big honkin' ones

• Ensure every parameter is specified on the /docs

• I ended up creating a very basic (so far) Template:Documentation.
  • Takes care of intro text, linking, and categorization to Category:Template Documentation
  • Borrows the green box from Wikipedia
  • Has a couple of limitations
    • Raw equals sign (use nowiki or Template:=)
    • MediaWiki table syntax breaks the template, too

Tentative doc page layout:

{{Documentation|
== Usage ==
Describe the purpose and function of the template, when to use it, when a different template might be indicated, and any considerations/gotchas to be aware of.

(preformatted template syntax box here - one liner for short templates/positional parameters, big box for the larger ones)
<pre>{{Template | <positional parameter> | [positional parameter=]<with optional keyword> | keyword=parameter }}<\pre>

=== Parameters ===
Definition-list itemization of all parameters, identifying each as optional or required and describing the range and effects each has.

== Examples ==
Minimal working example code for most-common uses for the template, followed by output if applicable.

|[[Template Categorization]]}}

• Note template's category on the doc page
• To consider: A blank copy is nice to have, especially for the larger "main" templates.

Progress tracking

First pass: Update tables to capture all templates currently.

Second pass: Fill in all the /doc pages based on current template functionality,

• parameterize categories instead of includeonlies
• add "nocat=y" functionality

Item Templates

Item Templates (2)
Template	Doc'ed	Template page layout	Doc page layout
1. Template:Icon	✓	✓
2. Template:Reputation Item	✓	✓

Monster Play Templates

MP Templates (11)
Template	Doc'ed	Template page layout	Doc page layout
1. Template:Freep Commendation Traders	✓	✓
2. Template:Infobox Keeps	✓	✓
3. Template:Infobox MP Mob	✓	✓
4. Template:Infobox MP Quest	✓	✓
5. Template:Infobox MP Titles	✓	✓
6. Template:Infobox MP-NPC	✓	✓
7. Template:MP-Delving-Bosses	✓	✓
8. Template:MP-Keep	✓	✓
9. Template:MP-Keep-Bosses	✓	✓
10. Template:WBMDetail	✓	✓
11. Template:WBMHeader	✓	✓
:Category:MP Support Templates|MP Support Templates (2)
12. Template:MP TitlesDetails	✓	✓
13. Template:MP TitlesRequirements	✓	✓

Support Templates

Support Templates (22)
Template	Doc'ed	Template page layout	Doc page layout
1. Template:!	✓	✓	✓
2. Template:!!	✓	✓	✓
3. Template:!)	✓	✓	✓
4. Template:!-	✓	✓	✓
5. Template:(!	✓	✓	✓
6. Template:=	✓	✓	✓
7. Template:Ambox	✓	✓
8. Template:Analysis-quality	✓	✓
9. Template:Iconbox	✓	✓	✓
10. Template:Legacy/10 Types Table	✓	✓
11. Template:Legacy/All Types Table	✓	✓
12. Template:Legacy/Cost Table	✓	✓
13. Template:Lootbox/Missing	✓	✓
14. Template:Lootbox/Blank	✓	✓
15. Template:Lootbox/Row	✓	✓
16. Template:LS	✓	✓
17. Template:ObjectInfo	✓	✓
18. Template:Q	✓	✓
19. Template:Questbox	✓	✓
20. Template:Splitter	✓	✓
21. Template:TitlesDetails	✓	✓
22. Template:TitlesRequirements	✓	✓

Article Management Tags

Article Management Tags (34)
Template	Doc'ed	Template page layout	Doc page layout
1. Template:Accuracy	✓	✓	✓
2. Template:Beta	✓	✓	✓
3. Template:Category Stub	✓	✓	✓
4. Template:Construction	✓	✓	✓
5. Template:Crafting Stub	✓	✓	✓
6. Template:Creature Stub	✓	✓	✓
7. Template:Deed Stub	✓	✓	✓
8. Template:Delete Page	✓	✓	✓
9. Template:Duplicate	✓	✓	✓
10. Template:Effect Stub	✓	✓	✓
11. Template:Expansion	✓	✓	✓
12. Template:External	✓	✓	✓
13. Template:Image Stub	✓	✓	✓
14. Template:IN	✓	✓	✓
15. Template:Item Stub	✓	✓	✓
16. Template:Kinship	✓	✓	✓
17. Template:Legacy Stub	✓	✓	✓
18. Template:Location Stub	✓	✓	✓
19. Template:Lore Stub	✓	✓	✓
20. Template:Merge	✓	✓	✓
21. Template:Mob Stub	✓	✓	✓
22. Template:Move	✓	✓	✓
23. Template:NPC Stub	✓	✓	✓
24. Template:Obsolete	✓	✓	✓
24. Template:Only Beta	✓	✓	✓
25. Template:Outdated	✓	✓	✓
26. Template:PC	✓	✓	✓
27. Template:Quest Stub	✓	✓	✓
28. Template:Source needed	✓	✓	✓
29. Template:Skill Stub	✓	✓	✓
30. Template:Stub	✓	✓	✓
31. Template:Title Stub	✓	✓	✓
32. Template:Trait Stub	✓	✓	✓
33. Template:Warning	✓	✓	✓
35. Template:Wikify	✓	✓	✓