MozillaZine

Rules/Templates

From MozillaZine Knowledge Base

(Difference between revisions)
Revision as of 10:54, 28 February 2005
Asqueella (Talk | contribs)

<-- Previous diff
Revision as of 23:11, 5 March 2005
Asqueella (Talk | contribs)
(start adding real content)
Next diff -->
Line 1: Line 1:
-This will detail the use of various templates. For now, see the [[Talk:Rules/Use templates|talk page]].+It's a good idea to keep KB content uniform. We try to do that by making a list of [[In-House Style|style rules]] each contributor to the KB should follow. Another thing that helps keep KB uniform is templates (read [http://meta.wikimedia.org/wiki/Help:Template metawiki help]; [http://meta.wikimedia.org/wiki/Help:Category#A_category_tag_in_a_template.3B_caching_problem A category tag in a template; caching problem]).
-These links are useful: [http://meta.wikimedia.org/wiki/Help:Templates Help:Templates]+This is work in progress. Discuss these conventions on the [[Talk:Rules/Templates|talk page]].
-[http://meta.wikimedia.org/wiki/Help:Category#A_category_tag_in_a_template.3B_caching_problem A category tag in a template; caching problem]+ 
 +=="Applies to" templates==
 +Some concepts apply to more than one application. To simplify maintenance, editors sometimes create articles that apply to two or more apps. Such articles do not have an application name in their titles, so in order to make it clear what application(s) a given article applies to, editors should put a blurb like this in the beginning of the article:
 +: ''This article applies to [[Firefox]] and [[Thunderbird]].''
 + 
 +You can achieve this (and also have your article - partially - categorized) by using a template. Due to technical limitations of WikiMedia, we actually have a few different templates, for different number of params each.
 + 
 +'''Usage:''' <code><nowiki>{{appliesto2|Application1|Application2|Subcategory}}</nowiki></code> becomes
 +<pre><nowiki>: ''This article applies to [[Firefox]] and [[Thunderbird]].''
 +[[Category:Subcategory (Application1)]] [[Category:Subcategory (Application2)]]</nowiki></pre>
 + 
 +Remember to add additional categories manually.

Revision as of 23:11, 5 March 2005

It's a good idea to keep KB content uniform. We try to do that by making a list of style rules each contributor to the KB should follow. Another thing that helps keep KB uniform is templates (read metawiki help; A category tag in a template; caching problem).

This is work in progress. Discuss these conventions on the talk page.

"Applies to" templates

Some concepts apply to more than one application. To simplify maintenance, editors sometimes create articles that apply to two or more apps. Such articles do not have an application name in their titles, so in order to make it clear what application(s) a given article applies to, editors should put a blurb like this in the beginning of the article:

This article applies to Firefox and Thunderbird.

You can achieve this (and also have your article - partially - categorized) by using a template. Due to technical limitations of WikiMedia, we actually have a few different templates, for different number of params each.

Usage: {{appliesto2|Application1|Application2|Subcategory}} becomes

: ''This article applies to [[Firefox]] and [[Thunderbird]].''
[[Category:Subcategory (Application1)]] [[Category:Subcategory (Application2)]]

Remember to add additional categories manually.