User:Sethladan/Template Notes

From Lotro-Wiki.com
Jump to: navigation, search

Scratchpad for template project (also coordinate on Project:System Tools and Project:Documentation).

Goals

Documentation

1. Ensure every template has a /doc

  • This is overkill for some of them, but setting a strict standard reduces ambiguity and encourages conformity down the road
  • Use {{Documentation}}

2. Develop consistent formats for /doc pages

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

3. Ensure every parameter is specified on the /docs

Bug fixing/features

1. Review the talk pages for each template to see what's been requested/reported and see if it's still an issue

2. Clean up article management tags to develop a more uniform look

3. Add nocat to templates where it's not yet implemented

Refactoring/code cleanup

1. Update all antiquated code/HTML/stylings

2. Develop a consistent formatting style and possibly write up a template style guide

3. Break out repetitive styles into CSS classes

Organization

1. Review categorization

2. Eliminate/consolidate duplicate templates

Work Plan

Done

1. Check that each template has a documentation page

2. Standardize template page layout as below

<includeonly>Template wiki-code here...
...
...</includeonly><noinclude>{{/doc}}</noinclude>

3. Parameterize documentation page categories

Next Steps

4. Review and streamline template categorization

5. Identify and phase out obsolete/duplicate/WIP templates

Future Plans

?. Fill in documentation according to layout below (layout still subject to revision)

{{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]] }}

Progress

(see also Category:Templates for some stuff not yet listed here.)