Welcome to the Lylat Wiki, all about the Star Fox series! If you'd like to help out, please take a look at our community portal.

Difference between revisions of "Lylat Wiki:Template Standards"

From Lylat Wiki, your source on Star Fox information. By Fans, for Fans.
Jump to navigationJump to search
Line 1: Line 1:
Templates are used  
Templates are used to make it easier on a page to store infromation, 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 ==
== Names ==


== Content ==
== Content ==
when a template is placed into another page, through a process called "transclusion", it should have one of two results:
# it looks natural  where it was place on the article; enhancing, rather than detracting from the receiving pages quality.
# it brings the user of a page to the attention of something, such as someone believing that a article is inaccurate.


=== Sections ===
=== Sections ===
If a template generates a section breaker (through <nowiki>===</nowiki>
Section headers </nowiki>), 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 ===
=== Tables ===
Line 46: Line 56:
== Actions ==
== Actions ==
== Discussions ==
== Discussions ==
== Typical Types of Templates ==
=== Infoboxes ===
=== Navigation ===
=== Shortcuts ===
=== Maintenance ===

Revision as of 23:25, 15 April 2010

Templates are used to make it easier on a page to store infromation, 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 </nowiki>), 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

Documentation

Documetiaon Shell

{{documentation shell
| name = Documentation shell
| info = The shell for all documentation pages. 
| see also = taken from [http://www.grifkuba.org/main/wiki/index.php?title=Template:Documentation_shell/doc source] on Februrary 27th, 2010. 
}}

Sections

==Purpose==
==Usage==
=== Parameters ===
{| class="wikitable" width=100%
|+
|-
! Name 
! Description 
! Values-Related Stuff <!-- for if anything happens becuase a specific value related is not entered
|-
| <!-- one row per paramter --> 
| 
| 
|-
{{parameters-table-bottom}}
|} 

==Example==
<includeonly>
<!-- cats -->
</includeonly>
<noinclude>[[Category:Documentation]]</noinclude>

Maintenance

Actions

Discussions

Typical Types of Templates

Infoboxes

Navigation

Shortcuts

Maintenance