Template:Category Header/Documentation: Difference between revisions

From Zelda Wiki, the Zelda encyclopedia
Jump to navigation Jump to search
(Created page with "==Purpose== This template serves to provide a standardized header for mass categories separated by game. These include maintenance categories which separate categories by media and general search categories like Category:Characters in Breath of the Wild or Category:Dungeons in Twilight Princess. ==Usage== This template should be placed at the top of the category and be formatted as such: {{Tabs |tab1= Syntax |content1=...")
 
(Updates (will add output when the wiki starts working again lol))
 
(5 intermediate revisions by 3 users not shown)
Line 1: Line 1:
==Purpose==
==Purpose==
This template serves to provide a standardized header for mass categories separated by game. These include [[:Category:Articles Needing Attention|maintenance categories]] which separate categories by media and general search categories like [[:Category:Characters in Breath of the Wild]] or [[:Category:Dungeons in Twilight Princess]].
This template serves to provide a standardized header for mass categories separated by medium. These include [[:Category:Maintenance categories|maintenance categories]] which separate categories by medium and general search categories like [[:Category:Characters in Breath of the Wild]] or [[:Category:Dungeons in Twilight Princess]].


==Usage==
==Usage==
Line 6: Line 6:
{{Tabs
{{Tabs
|tab1= Syntax
|tab1= Syntax
|content1= <pre>{{Category Header|<categoryType>|<gameCode>}}</pre>
|content1= <pre>{{Category Header|<gameCode>|page= }}</pre>
|tab2= Blank Code
|tab2= Blank Code
|content2= <pre>{{Category Header||}}</pre>
|content2= <pre>{{Category Header|}}</pre>
}}
}}


The following table lists all acceptable values for the <code><nowiki><categoryType></nowiki></code> parameter. For <code><nowiki><gameCode></nowiki></code>, see the {{[[Template:Zelda|Zelda]]}} for a list of all accepted values. For these examples, {{BotW}} will be used as an example but can be interchanged with any game.
For <code><nowiki><gameCode></nowiki></code>, see the "code" column on [[Data:Franchise]] for a list of all accepted values.
 
The <code>page</code> parameter is optional and should only be used if the name of the page the template is being used on is different from what the desired output is. If the <code>page</code> parameter is left blank, it defaults to <code><nowiki>{{PAGENAME}}</nowiki></code>, so it shouldn't be used when the pagename matches the desired output.
 
===Examples===
{|class="wikitable"
{|class="wikitable"
!<code><nowiki><categoryType></nowiki></code>
!Category
!Used On
!Input
!Output
!Output
|-
|-
|+Accepted Values
|+Accepted Values
|-
|-
|Lacking Sources
|style="text-align:center"|[[:Category:Breath of the Wild articles lacking sources]]
|[[:Category:Articles Lacking Sources]]
|style="text-align:center"|<pre>{{Category Header|BotW}}</pre>
|{{Category Header|Lacking Sources|BotW}}
|<!--{{Category Header|BotW|page= Breath of the Wild articles lacking sources}}-->
|-
|-
|Needing Improvement
|style="text-align:center"|[[:Category:Spirit Tracks articles needing improvement]]
|[[:Category:Articles Needing Improvement]]
|style="text-align:center"|<pre>{{Category Header|ST}}</pre>
|{{Category Header|Needing Improvement|BotW}}
|<!--{{Category Header|ST|page= Spirit Tracks articles lacking sources}}-->
|}
|}
{{Documentation Footer}}
{{Documentation Footer}}

Latest revision as of 17:18, 14 June 2023

Purpose

This template serves to provide a standardized header for mass categories separated by medium. These include maintenance categories which separate categories by medium and general search categories like Category:Characters in Breath of the Wild or Category:Dungeons in Twilight Princess.

Usage

This template should be placed at the top of the category and be formatted as such:

SyntaxBlank Code
{{Category Header|<gameCode>|page= }}
{{Category Header|}}

For <gameCode>, see the "code" column on Data:Franchise for a list of all accepted values.

The page parameter is optional and should only be used if the name of the page the template is being used on is different from what the desired output is. If the page parameter is left blank, it defaults to {{PAGENAME}}, so it shouldn't be used when the pagename matches the desired output.

Examples

Category Input Output
Accepted Values
Category:Breath of the Wild articles lacking sources
{{Category Header|BotW}}
Category:Spirit Tracks articles needing improvement
{{Category Header|ST}}
This is the documentation page, it should be transcluded into the main template page. See here for more information.