Template:Categories/Documentation

From Zelda Wiki, the Zelda encyclopedia
Jump to navigation Jump to search

Purpose

Adding categories to pages. For each category, a navbox is generated with links between the pages in the category.

Usage

This template relies on configuration data stored at Module:Categories/Data.

SyntaxBoilerplate
{{Categories
 |<categories>
 |abilities= 
 |bosses= 
 |characters= 
 |challenges= 
 |cutscenes= 
 |dlc= 
 |dungeons= 
 |enemies= 
 |groups= 
 |items= 
 |levels= 
 |locations= 
 |main-quests= 
 |mechanics= 
 |mini-games= 
 |modes= 
 |music= 
 |objects= 
 |playable= 
 |quests= 
 |scenarios= 
 |services= 
 |shrine-quests= 
 |side-quests= 
 |songs= 
 |stages= 
 |sub-bosses= 
 |symbols= 
}}
Required ParametersAll Parameters
{{Categories
}}
{{Categories
 |
 |abilities= 
 |bosses= 
 |characters= 
 |challenges= 
 |cutscenes= 
 |dlc= 
 |dungeons= 
 |enemies= 
 |groups= 
 |items= 
 |levels= 
 |locations= 
 |main-quests= 
 |mechanics= 
 |mini-games= 
 |modes= 
 |music= 
 |objects= 
 |playable= 
 |quests= 
 |scenarios= 
 |services= 
 |shrine-quests= 
 |side-quests= 
 |songs= 
 |stages= 
 |sub-bosses= 
 |symbols= 
}}
ParameterStatusDescriptionAccepted values
1categoriesoptionalComma separated list of categories which are not subcategorized by game. Examples of these include Animals, Forests, Fire-Related Enemies, and so on.
abilitiesoptionalComma-separated list of codes representing the games or other titles in which the given article subject is one of the Abilities.See Data:Franchise
bossesoptionalComma-separated list of codes representing the games or other titles in which the given article subject is one of the Bosses.See Data:Franchise
charactersoptionalComma-separated list of codes representing the games or other titles in which the given article subject is one of the Characters.See Data:Franchise
challengesoptionalComma-separated list of codes representing the games or other titles in which the given article subject is one of the Challenges.See Data:Franchise
cutscenesoptionalComma-separated list of codes representing the games or other titles in which the given article subject is one of the Cutscenes.See Data:Franchise
dlcoptionalComma-separated list of codes representing the games or other titles in which the given article subject is one of the DLC.See Data:Franchise
dungeonsoptionalComma-separated list of codes representing the games or other titles in which the given article subject is one of the Dungeons.See Data:Franchise
enemiesoptionalComma-separated list of codes representing the games or other titles in which the given article subject is one of the Enemies.See Data:Franchise
groupsoptionalComma-separated list of codes representing the games or other titles in which the given article subject is one of the Groups.See Data:Franchise
itemsoptionalComma-separated list of codes representing the games or other titles in which the given article subject is one of the Items.See Data:Franchise
levelsoptionalComma-separated list of codes representing the games or other titles in which the given article subject is one of the Levels.See Data:Franchise
locationsoptionalComma-separated list of codes representing the games or other titles in which the given article subject is one of the Locations.See Data:Franchise
main-questsoptionalComma-separated list of codes representing the games or other titles in which the given article subject is one of the Main Quests.See Data:Franchise
mechanicsoptionalComma-separated list of codes representing the games or other titles in which the given article subject is one of the Mechanics.See Data:Franchise
mini-gamesoptionalComma-separated list of codes representing the games or other titles in which the given article subject is one of the Mini-Games.See Data:Franchise
modesoptionalComma-separated list of codes representing the games or other titles in which the given article subject is one of the Modes.See Data:Franchise
musicoptionalComma-separated list of codes representing the games or other titles in which the given article subject is one of the Music.See Data:Franchise
objectsoptionalComma-separated list of codes representing the games or other titles in which the given article subject is one of the Objects.See Data:Franchise
playableoptionalComma-separated list of codes representing the games or other titles in which the given article subject is one of the Playable Characters.See Data:Franchise
questsoptionalComma-separated list of codes representing the games or other titles in which the given article subject is one of the Quests.See Data:Franchise
scenariosoptionalComma-separated list of codes representing the games or other titles in which the given article subject is one of the Scenarios.See Data:Franchise
servicesoptionalComma-separated list of codes representing the games or other titles in which the given article subject is one of the Services.See Data:Franchise
shrine-questsoptionalComma-separated list of codes representing the games or other titles in which the given article subject is one of the Shrine Quests.See Data:Franchise
side-questsoptionalComma-separated list of codes representing the games or other titles in which the given article subject is one of the Side Quests.See Data:Franchise
songsoptionalComma-separated list of codes representing the games or other titles in which the given article subject is one of the Songs.See Data:Franchise
stagesoptionalComma-separated list of codes representing the games or other titles in which the given article subject is one of the Stages.See Data:Franchise
sub-bossesoptionalComma-separated list of codes representing the games or other titles in which the given article subject is one of the Sub-Bosses.See Data:Franchise
symbolsoptionalComma-separated list of codes representing the games or other titles in which the given article subject is one of the Symbols.See Data:Franchise

Adding categories to pages. For each category, a navbox is generated with links between the pages in the category.

Template parameters

ParameterDescriptionTypeStatus
categories1

Comma separated list of categories which are not subcategorized by game. Examples of these include [[:Category:Animals|Animals]], [[:Category:Forests|Forests]], [[:Category:Fire-Related Enemies|Fire-Related Enemies]], and so on.

Stringoptional
abilitiesabilities

Comma-separated list of [[Data:Franchise|codes]] representing the games or other titles in which the given article subject is one of the [[:Category:Abilities|Abilities]].

Stringoptional
bossesbosses

Comma-separated list of [[Data:Franchise|codes]] representing the games or other titles in which the given article subject is one of the [[:Category:Bosses|Bosses]].

Stringoptional
characterscharacters

Comma-separated list of [[Data:Franchise|codes]] representing the games or other titles in which the given article subject is one of the [[:Category:Characters|Characters]].

Stringoptional
challengeschallenges

Comma-separated list of [[Data:Franchise|codes]] representing the games or other titles in which the given article subject is one of the [[:Category:Challenges|Challenges]].

Stringoptional
cutscenescutscenes

Comma-separated list of [[Data:Franchise|codes]] representing the games or other titles in which the given article subject is one of the [[:Category:Cutscenes|Cutscenes]].

Stringoptional
dlcdlc

Comma-separated list of [[Data:Franchise|codes]] representing the games or other titles in which the given article subject is one of the [[:Category:DLC|DLC]].

Stringoptional
dungeonsdungeons

Comma-separated list of [[Data:Franchise|codes]] representing the games or other titles in which the given article subject is one of the [[:Category:Dungeons|Dungeons]].

Stringoptional
enemiesenemies

Comma-separated list of [[Data:Franchise|codes]] representing the games or other titles in which the given article subject is one of the [[:Category:Enemies|Enemies]].

Stringoptional
groupsgroups

Comma-separated list of [[Data:Franchise|codes]] representing the games or other titles in which the given article subject is one of the [[:Category:Groups|Groups]].

Stringoptional
itemsitems

Comma-separated list of [[Data:Franchise|codes]] representing the games or other titles in which the given article subject is one of the [[:Category:Items|Items]].

Stringoptional
levelslevels

Comma-separated list of [[Data:Franchise|codes]] representing the games or other titles in which the given article subject is one of the [[:Category:Levels|Levels]].

Stringoptional
locationslocations

Comma-separated list of [[Data:Franchise|codes]] representing the games or other titles in which the given article subject is one of the [[:Category:Locations|Locations]].

Stringoptional
main-questsmain-quests

Comma-separated list of [[Data:Franchise|codes]] representing the games or other titles in which the given article subject is one of the [[:Category:Main Quests|Main Quests]].

Stringoptional
mechanicsmechanics

Comma-separated list of [[Data:Franchise|codes]] representing the games or other titles in which the given article subject is one of the [[:Category:Mechanics|Mechanics]].

Stringoptional
mini-gamesmini-games

Comma-separated list of [[Data:Franchise|codes]] representing the games or other titles in which the given article subject is one of the [[:Category:Mini-Games|Mini-Games]].

Stringoptional
modesmodes

Comma-separated list of [[Data:Franchise|codes]] representing the games or other titles in which the given article subject is one of the [[:Category:Modes|Modes]].

Stringoptional
musicmusic

Comma-separated list of [[Data:Franchise|codes]] representing the games or other titles in which the given article subject is one of the [[:Category:Music|Music]].

Stringoptional
objectsobjects

Comma-separated list of [[Data:Franchise|codes]] representing the games or other titles in which the given article subject is one of the [[:Category:Objects|Objects]].

Stringoptional
playableplayable

Comma-separated list of [[Data:Franchise|codes]] representing the games or other titles in which the given article subject is one of the [[:Category:Playable Characters|Playable Characters]].

Stringoptional
questsquests

Comma-separated list of [[Data:Franchise|codes]] representing the games or other titles in which the given article subject is one of the [[:Category:Quests|Quests]].

Stringoptional
scenariosscenarios

Comma-separated list of [[Data:Franchise|codes]] representing the games or other titles in which the given article subject is one of the [[:Category:Scenarios|Scenarios]].

Stringoptional
servicesservices

Comma-separated list of [[Data:Franchise|codes]] representing the games or other titles in which the given article subject is one of the [[:Category:Services|Services]].

Stringoptional
shrine-questsshrine-quests

Comma-separated list of [[Data:Franchise|codes]] representing the games or other titles in which the given article subject is one of the [[:Category:Shrine Quests|Shrine Quests]].

Stringoptional
side-questsside-quests

Comma-separated list of [[Data:Franchise|codes]] representing the games or other titles in which the given article subject is one of the [[:Category:Side Quests|Side Quests]].

Stringoptional
songssongs

Comma-separated list of [[Data:Franchise|codes]] representing the games or other titles in which the given article subject is one of the [[:Category:Songs|Songs]].

Stringoptional
stagesstages

Comma-separated list of [[Data:Franchise|codes]] representing the games or other titles in which the given article subject is one of the [[:Category:Stages|Stages]].

Stringoptional
sub-bossessub-bosses

Comma-separated list of [[Data:Franchise|codes]] representing the games or other titles in which the given article subject is one of the [[:Category:Sub-Bosses|Sub-Bosses]].

Stringoptional
symbolssymbols

Comma-separated list of [[Data:Franchise|codes]] representing the games or other titles in which the given article subject is one of the [[:Category:Symbols|Symbols]].

Stringoptional

Examples

Input
{{Categories
 |Keese, Ice-Related Enemies
 |enemies= OoT, OoT3D, MM, MM3D, TP, TPHD, PH, ST, TFH, BotW
 |sub-bosses= ST
}}
Output
Categories Added

Input
{{Categories
 |Demons, Loruleans, Sorcerers
 |bosses= TLoZ, ALttP, OoT, OoT3D, OoS, OoA, FSA, TP, TPHD, TFoE, TWoG, ZA, BSTLoZ, AST, HW, HWL, HWDE
 |characters= ALBW, HW
 |playable= HW
}}
Output
Categories Added

Input
{{Categories
 |Ancient Technology
 |items= OoT, OoT3D
 |objects= BotW
}}
Output
Categories Added

Input
{{Categories
 |dungeons= OoT, OoT3D
 |levels= TFH
 |locations= OoT, OoT3D
}}
Output
Categories Added

Input
{{Categories
 |stages= HW, HWL, HWDE
}}
Output
Categories Added

Input
{{Categories
 |songs= MM, MM3D, TP, TPHD, ST
}}
Output
Categories Added

Navboxes are not generated for categories with 99+ links.
Input
{{Categories
 |Hylians, Swords
}}
Output
Categories Added

Invalid codes, duplicate codes, and improperly ordered codes are handled appropriately.
Input
{{Categories
 |characters= TP, TP, fakeGame, OoT, OoT
}}
Output
Categories Added

Guidelines

This template should be added at the very bottom of articles, just before interwiki links. Types should be used in alphabetical order. If a type does not apply, it should not be used. Games should be entered in canon order.

The navboxes that are automatically generated by this template can be customized by creating a category navbox template using {{Categories/Navbox}}.

For more information on the navboxes automatically added by this template, see Module:Categories/Data.

This is the documentation page, it should be transcluded into the main template page. See here for more information.