Difference between revisions of "Template:History of Ireland/doc"

From blackwiki
Jump to navigation Jump to search
imported>PBS
imported>PBS
(documention for the new paramters)
Line 2: Line 2:
 
<!-- Please place categories where indicated at the bottom of this page and interwikis at Wikidata (see [[Wikipedia:Wikidata]]) -->
 
<!-- Please place categories where indicated at the bottom of this page and interwikis at Wikidata (see [[Wikipedia:Wikidata]]) -->
 
== Usage ==
 
== Usage ==
 +
If this template is used without any [[Help:Template#Parameters|parameters]] in the format,
 +
<code><nowiki>{{</nowiki>{{BASEPAGENAME}}<nowiki>}}</nowiki></code>, the sidebar displays down the right-hand side of the page as displayed above.
 +
 +
If the parameter <code>|bar=</code> is set to any value, then the template displays as a bar or box across the width of the page, depending on the use of the parameters in [[#Additional parameters|§&nbsp;Additional parameters]] below. This is the format to use as a navbox at the bottom of an article.
 +
 +
:For example:
 +
 +
<code><nowiki>{{</nowiki>{{BASEPAGENAME}}<nowiki>|bar=yes}}</nowiki></code>
 +
 +
:would display as:
 +
 +
{{{{BASEPAGENAME}}|bar=yes}}
 +
 +
If, as in the latter case above, <code>|bar=</code> is used set to any value, then the [[#Additional parameters|§&nbsp;Additional parameters]] section applies and the visibility parameters function as described. If <code>|bar=</code> is not used, then those parameters are ignored.
 +
 +
== Additional parameters ==
 +
{{collapsible option}}
  
 
== See also ==
 
== See also ==

Revision as of 12:12, 14 October 2017

Usage

If this template is used without any parameters in the format, {{History of Ireland}}, the sidebar displays down the right-hand side of the page as displayed above.

If the parameter |bar= is set to any value, then the template displays as a bar or box across the width of the page, depending on the use of the parameters in § Additional parameters below. This is the format to use as a navbox at the bottom of an article.

For example:

{{History of Ireland|bar=yes}}

would display as:

If, as in the latter case above, |bar= is used set to any value, then the § Additional parameters section applies and the visibility parameters function as described. If |bar= is not used, then those parameters are ignored.

Additional parameters

Initial visibility: currently defaults to autocollapse

To set this template's initial visibility, the |state= parameter may be used:

  • |state=collapsed: {{History of Ireland|state=collapsed}} to show the template collapsed, i.e., hidden apart from its title bar
  • |state=expanded: {{History of Ireland|state=expanded}} to show the template expanded, i.e., fully visible
  • |state=autocollapse: {{History of Ireland|state=autocollapse}}
    • shows the template collapsed to the title bar if there is a {{navbar}}, a {{sidebar}}, or some other table on the page with the collapsible attribute
    • shows the template in its expanded state if there are no other collapsible items on the page

If the |state= parameter in the template on this page is not set, the template's initial visibility is taken from the |default= parameter in the Collapsible option template. For the template on this page, that currently evaluates to autocollapse.

See also