Lylat Wiki:Template Standards

From Lylat Wiki, your source on Star Fox information. By Fans, for Fans.
(Redirected from LW:TS)
Jump to: navigation, search
Shortcut(s) to this Usage Page or Section
LW:TS
General Pepper.png

General Pepper:

Peppy, When you have a chance, please look at this policy. I would like your opinion on it.

Peppy Hare:

Right, I will place my feedback on the talk page.
Peppy Hare.png

This is a Draft policy being recommend by a member in accordance with LW:Draft. You are free to make small changes, so long as the original purpose of the policy is preserved. Please also provide any feedback on this talk page.
This page was marked April 2010

Templates are used to make it easier on a page to store information, as some of the information is stored elsewhere. Templates are used to make it easier on the editors, as to provide a common content and save time instead of placing the exact same content in different locations. Templates are also used as tools to help direct community involvement for the maintenance of an article. But what makes a "Good Template"?

While there will never be an absolute way to say "this is a good template", there are certain things we should expect from each template and there respective pages (such as documentation and usage information). Due to the nature and infinitely diverse uses of templates, having a common expectation for each page does help standardize the pages.

But please note:The following are not absolute rules. They are not binding in anyway. They instead should be interpreted on a case by case basis, where each each template's page should be best catered to explaining how the template works and how to use it.

Names

Content

when a template is placed into another page, through a process called "transclusion", it should have one of two results:

  1. it looks natural where it was place on the article; enhancing, rather than detracting from the receiving pages quality.
  2. it brings the user of a page to the attention of something, such as someone believing that a article is inaccurate.

Sections

If a template generates a section breaker (through === Section headers ===), then that section header is not only subject to these guidelines, but also to the guidelines that the receiving page(s) are under.

For more, please see: Lylat Wiki:Section Standards.

Tables

Categories

Which category does this template belong to? Will it play well with similar templates, sorting itself into place?

Typically, one template will be a member of two template; both of which are an area of the wiki. To help decide what the template should be sorted under, we've come up with the template: {{auto-cat2}}. With this template, a page automatically becomes a member of two templates with each one serving as the others sortkey. For more on this, See Help:Categories & LW:CS.

Here are some Example of Template Categories you may consider putting your template under:


Documentation

Each template should have some kind of documentation telling you how to use it.

In order to generate a documentation page, place <noinclude>{{doc}}{{user-take-a-look|tacopill}}</noinclude> at the very bottom of the template, and a /doc red link will show up when you save. Click this link to go to the documentation subpage.

On the actual documentation page, we recommend you put the following:

  • a Documentation Shell, which is intended to provide easier access to the template page, the name of the template, and related templates.
  • The two sections: Purpose and Usage.

Documentation Shell

Title sample usage See #doc_1
documentation shell
{{documentation shell
| name = 
| info = 
| see also = 
}}
Use this template for all characters.

Notes:

  1. Required Parameters are in bold, followed by explanation of usage. Italics parameters have a related behavior change, when you insert a certain value. Please Click the link to the template for more information

Sections

==Purpose==
==Usage==
===Example===
<pre>
{{Template Name
| param 1 =
| param 2 = 
| param 3 = 
}}
</pre> <!-- note: use an actual less than sign than the html equailavent &lt; -->

=== Parameters ===
{{Parameters-table-top}}
|-
| <!-- one row per parameter --> 
| 
| 
|-
| colspan=3 | none <!-- for no parameters -->
|-
{{parameters-table-bottom}}
|} 
<noinclude>[[Category:Documentation|{{PAGENAME}}]]</noinclude>

Maintenance

Type of Maintenance Specific Standards - Related Template Related Character
Style & Content Guide
  1. needs to be more Start Fox like - {{more-star-foxy}}
  2. template needs improved documentation - {{Documentation-improvement}}
Usage
  1. template usage needs parameter filled - {{paramater-missing}}

Actions

Type of Maintenance Specific Standards - Related Template Related Character
Actions
  1. copied from another wiki - {{template-copied-from-another-wiki}}
  2. page too small (stub) - {{template-too-small}}
  3. page too big, needs splitting - {{template-too-big}}
  4. General
Discussions
  1. unresolved talk pages - {{unresolved-discussion}}
  2. off topic discussion - {{OT}}
100px
Redirects
  1. "redirect to the corresponding main article on the topic it names, in order to preserve the page's edit history after its content was merged into the other article's content " - See [1], but we need original text. - {{redir-from-merge}}
  2. Redirect to a section - {{redir-to-sec}}
  3. Redirect to a list entry - {{redir-to-list}}
  4. Redirect to anchor - {{redir-to-anchor}}
  5. Merge
  6. split
  7. move

Discussions

Typical Types of Templates

Infoboxes

Navigation

Shortcuts

Maintenance