Difference between revisions of "Template:Documentation constellation navbox/doc"

From blackwiki
Jump to navigation Jump to search
test>PhilipTerryGraham
test>PhilipTerryGraham
(Updated documentation to new version of the template)
Line 1: Line 1:
 
{{Documentation subpage}}
 
{{Documentation subpage}}
'''{{tl|Constellation navbox doc}}''' is a common documentation page for all navboxes listed in [[:Category:Constellation navboxes]]. It is designed to replace all the templates' individual documentation pages with a single interchangeable template, with words and links interchangeable with a single parameter. {{tl|Collapsible option}} and {{tl|Universe navboxes}} are used in this template.
+
'''{{tl|Documentation constellation navbox}}''' is a common documentation page for all navboxes listed in [[:Category:Constellation navboxes]]. It is designed to replace the predecessor documentation pages of each navbox with a single interchangeable template, with words and links interchangeable with a single parameter.  
  
 
== Usage ==
 
== Usage ==
This template has only one parameter, <code>1</code>, in which the name of a constellation is placed as the input. For example, <code><nowiki>{{Constellation navbox doc|Andromeda}}</nowiki></code> will output a description tailored to {{tl|Andromeda (constellation)}}. Only the name of the constellation is needed, regardless of whether or not the template name has "(constellation)" disambiguation. An [[mw:Help:Extension:ParserFunctions##ifexist|<code><nowiki>{{#ifexist:}}</nowiki></code> parser function]] is used to check if a template name has a disambiguation, and if it does, it automatically makes a proper wikilink to the template and its associated article, e.g. [[Andromeda (constellation)]]. To place the template on the page of a template, use the following syntax, with <code>constellation</code> replaced with the name of whichever constellation you want to feature:
+
This template has only one parameter, <code>1</code>, in which the name of a constellation is placed as the input. For example, <code><nowiki>{{Documentation constellation navbox|Andromeda}}</nowiki></code> will output a description tailored to {{tl|Andromeda (constellation)}}. Only the name of the constellation is needed, regardless of whether or not the template name has "(constellation)" disambiguation. An [[mw:Help:Extension:ParserFunctions##ifexist|<code><nowiki>{{#ifexist:}}</nowiki></code> parser function]] is used to check if a template name has a "{{xt|(constellation)}}" disambiguation, and if it does, it automatically makes a wikilink including its disambiguation to the template and its associated article, e.g. [[Template:Andromeda (constellation)]] and [[Andromeda (constellation)]]. To place this template on the page of a constellation navbox, use <code><nowiki>{{Documentation constellation navbox|1}}</nowiki></code>, with <code>1</code> replaced with the name of whichever constellation you want to feature, under <code><nowiki><noinclude></nowiki></code> tags.
<pre style="width:60%;">
 
{{Documentation
 
| 1      = Template:Constellation navbox doc
 
| content = {{Constellation navbox doc|constellation}}
 
}}
 
</pre>
 
  
 
== Succession ==
 
== Succession ==

Revision as of 02:21, 6 September 2019

{{Documentation constellation navbox}} is a common documentation page for all navboxes listed in Category:Constellation navboxes. It is designed to replace the predecessor documentation pages of each navbox with a single interchangeable template, with words and links interchangeable with a single parameter.

Usage

This template has only one parameter, 1, in which the name of a constellation is placed as the input. For example, {{Documentation constellation navbox|Andromeda}} will output a description tailored to {{Andromeda (constellation)}}. Only the name of the constellation is needed, regardless of whether or not the template name has "(constellation)" disambiguation. An {{#ifexist:}} parser function is used to check if a template name has a "(constellation)" disambiguation, and if it does, it automatically makes a wikilink including its disambiguation to the template and its associated article, e.g. Template:Andromeda (constellation) and Andromeda (constellation). To place this template on the page of a constellation navbox, use {{Documentation constellation navbox|1}}, with 1 replaced with the name of whichever constellation you want to feature, under <noinclude> tags.

Succession

This template is designed to be a successor to the following predecessor documentation templates which now serve as redirects to this template: