Difference between revisions of "Template:Categorylink"

From Twinsuniverse
Jump to: navigation, search
(Created page with "<includeonly></includeonly><noinclude> {{Stub}} Category:System Templates </noinclude>")
 
(added infobox)
 
(9 intermediate revisions by the same user not shown)
Line 1: Line 1:
<includeonly></includeonly><noinclude>
+
<includeonly>{{
{{Stub}}
+
#if: {{{category|}}}
 +
|{{
 +
    #if: {{{article|}}}
 +
    |{{
 +
        #if: {{{label|}}}
 +
        | [[{{{article}}}|{{{label}}}]]
 +
        | [[{{{article}}}]] }}{{superlink|article=:Category:{{{category}}}|label={{#if:{{{catlabel|}}}|{{{catlabel}}}|list all}}}}
 +
    |{{
 +
        #if: {{{label|}}}
 +
        |{{{label}}}{{superlink|article=:Category:{{{category}}}|label={{#if:{{{catlabel|}}}|{{{catlabel}}}|list all}}}}
 +
        |[[:Category:{{{category}}}|{{#if:{{{catlabel|}}}|{{{catlabel}}}|{{{category}}}}}]] }} }}
 +
}}</includeonly><noinclude>{{Infobox Template
 +
|purpose=formatting
 +
|singletag=no
 +
|multiline=no
 +
|gamerelated=no
 +
|suppressible=
 +
|choice=
 +
|cat1=
 +
|var1=
 +
}}
 +
 
 +
This template will render a link to a category. If the category has a main article and it is specified, a link to the article will be rendered instead and the link to the category itself will turn into a <nowiki>{{</nowiki>[[Template:Superlink|Superlink]]<nowiki>}}</nowiki>.
 +
 
 +
This template does not actually categorize an article under the specified category, for that, use the <nowiki>{{</nowiki>[[Template:Categorizer|Categorizer]]<nowiki>}}</nowiki> wrapper.
 +
 
 +
==Parameters==
 +
* '''category''': The name of the category to link to (case sensitive, defaults to nothing displayed, not even a '''label''')
 +
* '''catlabel''': An optional text to display on the link to the category (case sensitive, defaults to '''category''' or to "list all" if it is a superlink)
 +
* '''article''': A main article for the category (case sensitive, pushes the link to the category into a superlink)
 +
* '''label''': An optional text to display on the link to the main article (case sensitive, defaults to '''article''')
 +
 
 +
 
 +
'''''Note''': The link to the category will be pushed into a superlink if either '''article''' or '''label''' or both are specified.''
 +
 
 +
'''''Note''': The '''label''' may be used to optionally display custom text on the '''article''' link, but may also be used instead to remove the link and render text only.''
 +
 
 +
'''''Note''': The '''catlabel''' may be used to optionally display custom text on the '''category''' link, but the latter is not optional, unlike '''article'''.''
 +
 
 +
==Syntax==
 +
<nowiki>{{categorylink
 +
|category=
 +
|catlabel=
 +
|article=
 +
|label=
 +
}}</nowiki>
 +
 
 +
==Examples==
 +
Common use includes both the '''category''' and '''article''' parameters:
 +
<nowiki>{{categorylink|category=Quetches|article=Quetch}}</nowiki>
 +
 
 +
:[[Quetch]]{{superlink|article=:Category:Quetches|label=list all}}
 +
 
 +
 
 +
Both the text of the category link and article link may be customized, like this:
 +
<nowiki>{{categorylink
 +
|category=Quetches
 +
|catlabel=click here
 +
|article=Quetch
 +
|label=Resident
 +
}}</nowiki>
 +
 
 +
:[[Quetch|Resident]]{{superlink|article=:Category:Quetches|label=click here}}
 +
 
 +
 
 +
A different use includes only the '''category''' parameter, which would only render a link to the category itself like this:
 +
<nowiki>{{categorylink|category=Grobos}}</nowiki>
 +
 
 +
:[[:Category:Grobos|Grobos]]
 +
 
 +
 
 +
And again the text of the category link may be customized, like this:
 +
<nowiki>{{categorylink|category=Grobos|catlabel=Elephants}}</nowiki>
 +
 
 +
:[[:Category:Grobos|Elephants]]
 +
 
 +
 
 +
And even a third use includes the '''category''' parameter, combined not with the article but '''label''' parameter, which renders as the first example above but without a link on the article:
 +
<nowiki>{{categorylink|category=Quetches|label=Quetch}}</nowiki>
 +
<nowiki>{{categorylink|category=Quetches|label=Quetch|catlabel=members}}</nowiki>
 +
 
 +
:Quetch{{superlink|article=:Category:Quetches|label=list all}}
 +
:Quetch{{superlink|article=:Category:Quetches|label=members}}
 +
 
 +
 
 +
To summarize:
 +
* the '''catlabel''' parameter is used to display an optional text on the '''category''' link
 +
* the '''label''' parameter is used to display an optional text on the '''article''' link if it is specified, or instead if not
 +
* if either '''article''' or '''label''' is specified, the category link is pushed into a superlink behind it.
  
[[Category:System Templates]]
 
 
</noinclude>
 
</noinclude>

Latest revision as of 09:36, 4 June 2014

Categorylink
Purpose

Formatting [list all]

Single tag

No [list all]

Multi-line

No [list all]

Protected

No [list all]

Game related

No [list all]

Categorization
Categories

none [list all]

Variables
Names

none [list all]

Subpages

This template will render a link to a category. If the category has a main article and it is specified, a link to the article will be rendered instead and the link to the category itself will turn into a {{Superlink}}.

This template does not actually categorize an article under the specified category, for that, use the {{Categorizer}} wrapper.

Parameters

  • category: The name of the category to link to (case sensitive, defaults to nothing displayed, not even a label)
  • catlabel: An optional text to display on the link to the category (case sensitive, defaults to category or to "list all" if it is a superlink)
  • article: A main article for the category (case sensitive, pushes the link to the category into a superlink)
  • label: An optional text to display on the link to the main article (case sensitive, defaults to article)


Note: The link to the category will be pushed into a superlink if either article or label or both are specified.

Note: The label may be used to optionally display custom text on the article link, but may also be used instead to remove the link and render text only.

Note: The catlabel may be used to optionally display custom text on the category link, but the latter is not optional, unlike article.

Syntax

{{categorylink
 |category=
 |catlabel=
 |article=
 |label=
}}

Examples

Common use includes both the category and article parameters:

{{categorylink|category=Quetches|article=Quetch}}
Quetch [list all]


Both the text of the category link and article link may be customized, like this:

{{categorylink
 |category=Quetches
 |catlabel=click here
 |article=Quetch
 |label=Resident
}}
Resident [click here]


A different use includes only the category parameter, which would only render a link to the category itself like this:

{{categorylink|category=Grobos}}
Grobos


And again the text of the category link may be customized, like this:

{{categorylink|category=Grobos|catlabel=Elephants}}
Elephants


And even a third use includes the category parameter, combined not with the article but label parameter, which renders as the first example above but without a link on the article:

{{categorylink|category=Quetches|label=Quetch}}
{{categorylink|category=Quetches|label=Quetch|catlabel=members}}
Quetch [list all]
Quetch [members]


To summarize:

  • the catlabel parameter is used to display an optional text on the category link
  • the label parameter is used to display an optional text on the article link if it is specified, or instead if not
  • if either article or label is specified, the category link is pushed into a superlink behind it.