MozillaZine

Rules/Templates

From MozillaZine Knowledge Base

(Difference between revisions)
Revision as of 11:26, 29 March 2005
Asqueella (Talk | contribs)
("Applies to" templates)
<-- Previous diff
Revision as of 11:40, 31 March 2005
Asqueella (Talk | contribs)
(new templates)
Next diff -->
Line 6: Line 6:
: ''These templates are not created yet. They will be created once we actually start using categories.'' : ''These templates are not created yet. They will be created once we actually start using categories.''
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: 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]].''+: ''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. 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 '''Usage:''' <code><nowiki>{{appliesto2|Application1|Application2|Subcategory}}</nowiki></code> becomes
-<pre><nowiki>: ''This article applies to [[Firefox]] and [[Thunderbird]].''+<pre><nowiki>: ''This article applies to {{Firefox}} and {{Thunderbird}}.''
[[Category:Subcategory (Application1)]] [[Category:Subcategory (Application2)]]</nowiki></pre> [[Category:Subcategory (Application1)]] [[Category:Subcategory (Application2)]]</nowiki></pre>
Line 25: Line 25:
Usage: put <nowiki>{{org}}</nowiki> at the top of the page. Don't put on talk pages. Usage: put <nowiki>{{org}}</nowiki> at the top of the page. Don't put on talk pages.
 +
 +==Linking to application's category==
 +You can use <code><nowiki>{{Application name}}</nowiki></code> to link to that application's category. For example: <code><nowiki>{{Firefox}}</nowiki></code> expands to <code><nowiki>[[:Category:Firefox|Firefox]]</nowiki></code> and looks like this: {{Firefox}}.
 +
 +Implemented templates: [[Template:Firefox|<nowiki>{{Firefox}}</nowiki>]], [[Template:Thunderbird|<nowiki>{{Thunderbird}}</nowiki>]], [[Template:Mozilla Suite|<nowiki>{{Mozilla Suite}}</nowiki>]].

Revision as of 11:40, 31 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.

Contents

"Applies to" templates

These templates are not created yet. They will be created once we actually start using categories.

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.

"up to" template

Use the up to template to specify that given category is a subcategory of another category.

For example putting {{up to|Development}} on a category page means that that category in a subcategory of Category:Development. This template should be placed at the beginning of the category page.

"org" template

Use org template to put a page in Category:MozillaZine Knowledge Base organization. It's a shortcut and we'll also be able to put some text on all organizational pages when/if we need this.

Usage: put {{org}} at the top of the page. Don't put on talk pages.

Linking to application's category

You can use {{Application name}} to link to that application's category. For example: {{Firefox}} expands to [[:Category:Firefox|Firefox]] and looks like this: Firefox.

Implemented templates: {{Firefox}}, {{Thunderbird}}, {{Mozilla Suite}}.