Template:Template category/doc

From Wikibooks, open books for an open world
Jump to: navigation, search

The {{template category}} template should be placed at the top of categories that contain only template pages and their related subcategories.

Usage[edit]

Default appearance


For the displayed output of 'topic' or 'description' inputs (only)
the parameters BG, FS, LH corresponding to HTML: 'background', 'font-size', and 'line-height' respectively have scope inside the text body.

Full syntax[edit]

{{template category|type= |topic= |description= }}

for example, using |type=documentation, like other type enums, the template changes the default message to:

 


Parameters[edit]

The following parameters that are all optional, may also be used:

type  
Adds a note as to which type of template the category (but not necessarily its subcategories) is meant to contain, e.g.
{{template category|type=navbox}}
Currently, setting type to one of several values produces a preset note. The values are:
book · conversion · external link · formatting · function · infobox · meta · navbox · stub · userbox
If type is set to something other than one of these values, the default message "The pages listed in this category are meant be type templates." appears.
topic  
Adds the default description "Templates relating to topic.", where topic is usually a wikilink to the book associated with the category (e.g. Algorithms for the category Category:Algorithms/Templates). See Example 1 below.
description 
Use this if a customized description is needed instead of (or, if topic also used, to follow) the default description above. See Example 2 below.

Examples[edit]

Example 1[edit]

{{template category
|type  = navbox
|topic = United States
}}



Example 2[edit]

{{template category
|type  = navbox
|topic = China
|description = For templates relating specifically to the People's Republic of China (PRC) or the current Republic of China (ROC, "Taiwan").
}}



Example 3[edit]

{{template category
|description = Here's a ''description'' without a preceding ''topic'' statement.
}}



Example 4[edit]

{{template category
|type = external link
|description = '''Templates aiding the creation and formatting of external links to topic databases.'''
}}