Template:C/doc

From AerialWiki
Jump to navigation Jump to search

Links to a category, either within the Commons or to another Wikipedia

Usage

{{C|1=|2=|3=}}

Parameters

Parameter name Description Default value required or optional?

parameter #1 (1) category name empty required
parameter #2 (2) link text to display (instead of category name) empty optional
parameter #3 (3) The 3rd parameter establishes either
  • interwiki access, with any language code,
or
  • a link to a category of the Commons, always with check for existence
    • existing categories are linked and displayed
    • non-existing categories are not linked, but displayed
(not specified): text is displayed in black color
if 3=x (lower case): text is displayed in red color
if 3=X (upper case): display with red background
empty optional

Additional information

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

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

Usage

The template will display {{{2}}}, or just the category name given as {{{1}}}.

The function is different for internal access within the commons, and for interwiki access.

Adressing categories within the commons

First of all, always a check for existence is performed.

When the category exists, code is implemented as:

[[:Category:{{{1}}}|{{{2|{{{1}}}}}}]]

If the category {{{1}}} does not exist no link will be generated;

[[Category:{{{1}}}]] or [[Category:{{{2}}}]] is displayed
[[Category:{{{1}}}]] or [[Category:{{{2}}}]] is displayed when {{{3}}} = x
{{{1}}} or {{{2}}} will get background color when {{{3}}} = X


example
  • {{C|Internal link templates}} produces [[Category:Internal link templates]]
  • {{C|Internal link templates|}} produces [[Category:Internal link templates]]
  • {{C|Internal link templates|C:''display''text}} produces [[Category:C:displaytext]]


  • {{C|not-existing-cat}} produces [[Category:not-existing-cat]]
  • {{C|not-existing-cat|display}} produces [[Category:display]]
  • {{C|not-existing-cat|3=x}} produces [[Category:not-existing-cat]]
  • {{C|not-existing-cat|display-cat|x}} produces [[Category:display-cat]]
  • {{C|not-existing-cat|3=X}} produces not-existing-cat
  • {{C|not-existing-cat|displayname|X}} produces displayname


Interwiki access

It is not possible to check for existence in other Wikipedias.
The link is always established, whether the category exists or not.