Difference between revisions of "Cantr II Wiki:Format Guide"

From Cantr II Wiki
Jump to: navigation, search
m
 
m
 
Line 1: Line 1:
−
==Use of templates==
+
==Design principles==
−
The Cantr wiki uses a number of templates to make editing easier.
+
*Consolidate information. One piece of information should be stored in exactly one place. If it needs to be visible in more than one place, transclusion (generally in the form of templates) should be used.
−
 
+
*Layout should be standardized using templates to minimize the need for moderators to reformat articles.
−
===Infoboxes===
+
*Templates should be easy to use. Sacrifice readability of templates in favor of readability of articles.
−
Infoboxes are small tables that allow you to take all the information about an item and display it in a single chunk. Categories will be generated automatically - please do not add category tags to an article that uses infoboxes. Use infoboxes whenever possible - copy the format of another page of the same type as the page you are writing.
+
*Information in the wiki should transparently reflect the in-game systems described. Use in-game numbers directly with a minimum of processing. If in-game numbers are manipulated to make them more readable or illustrate a point, document this.
−
 
 
−
===Choice templates===
 
−
Cantr has many cases where several tools, machines or semi-finished products are used in the same way - for example, if the manufacturing menu says a hammer is required to make something, the [[stone hammer]] will substitute. For these cases, "choice templates" exist that will generate the full list of interchangeable objects. For example, use <nowiki>{{hammer}}</nowiki> instead of <nowiki>[[hammer]]</nowiki> to generate the text {{hammer}}.
 
−
 
 
−
===Tags===
 
−
Pages missing important information, pages in need of reformatting, pages under major reformatting, and certain other types of pages should be marked using tags, such as <nowiki>{{rewrite}}</nowiki> or <nowiki>{{construction}}</nowiki>.
 

Latest revision as of 19:31, 3 February 2007

Design principles

  • Consolidate information. One piece of information should be stored in exactly one place. If it needs to be visible in more than one place, transclusion (generally in the form of templates) should be used.
  • Layout should be standardized using templates to minimize the need for moderators to reformat articles.
  • Templates should be easy to use. Sacrifice readability of templates in favor of readability of articles.
  • Information in the wiki should transparently reflect the in-game systems described. Use in-game numbers directly with a minimum of processing. If in-game numbers are manipulated to make them more readable or illustrate a point, document this.
Retrieved from "http://wiki.cantr.net/index.php?title=Cantr_II_Wiki:Format_Guide&oldid=21784"