Template:Carboniferous period nav/doc

From Wikimedia Commons, the free media repository
Jump to navigation Jump to search

This template displays a navigational box for categories representng the Carboniferous Period, along with the epochs and ages that fall under it.

Usage

{{Carboniferous period nav/doc |epoch= |age= |cat_prefix= |cat_suffix= }}

Template parameters

ParameterDescriptionDefaultStatus
epochEpoch navboxesEnables the display of navigational boxes for the epochs preceding and succeeding the Carboniferous Period. (Disabled if this parameter is empty)emptysuggested
ageAge navboxesEnables the display of navigational boxes for the epochs and ages preceding and succeeding the Carboniferous Period. (Overrides epoch parameter; disabled if this parameter is empty)emptysuggested
cat_prefixCategory prefixAdds a custom word or phrase before each category link, in order to navigate within the bounds of such prefixed categories.emptyoptional
cat_suffixCategory suffixAdds a custom word or phrase after each category link, in order to navigate within the bounds of such suffixed categories.emptyoptional
<templatedata>JSON</templatedata> ./. {{TemplateBox}}
TemplateData

TemplateData is a way to store information about template parameters (the description of those and of the whole template) for both humans and machines. It is used by VisualEditor and possibly other tools like Upload Wizard.


Existing template documentation
At Wikimedia Commons, it is recommended to use {{TemplateBox}} with either ‎useTemplateData=1 or ‎useTemplateData=only on the ‎/doc subpage and transcluding it with {{Documentation}} into the template. ‎<nowiki>-tags can be wrapped around the arguments, if required, to avoid templates being expanded.

Newly created template documentation and imports
Another option, especially for imported templates, or for users with JSON experience, is placing raw ‎<templatedata>-tags into the Wikitext of the template, as described in various Wikipediae.


Wikipedia's help about TemplateDataCommons-specific information

This template displays a navigational box for categories representng the Carboniferous Period, along with the epochs and ages that fall under it.

Template parameters

This template prefers inline formatting of parameters.

ParameterDescriptionTypeStatus
Age navboxesage

Enables the display of navigational boxes for the epochs and ages preceding and succeeding the Carboniferous Period. (Overrides "epoch" parameter; disabled if this parameter is empty)

Stringsuggested
Category prefixcat_prefix

Adds a custom word or phrase before each category link, in order to navigate within the bounds of such prefixed categories.

Stringoptional
Category suffixcat_suffix

Adds a custom word or phrase after each category link, in order to navigate within the bounds of such suffixed categories.

Stringoptional
Epoch navboxesepoch

Enables the display of navigational boxes for the epochs preceding and succeeding the Carboniferous Period. (Disabled if this parameter is empty)

Stringsuggested

Additional information

The template is intended to be used in the following namespaces: the Category namespace

The template is intended to be used by the following user groups: all users

Placement: At the top of the page

Relies on:

Examples

{{Carboniferous period nav/doc|epoch=1}}

renders as:


{{Carboniferous period nav/doc|age=1}}

renders as:


{{Carboniferous period nav/doc|age=1|cat_suffix=geology by continent}}

renders as:

See also