Template:Sidebar/doc: Difference between revisions

>PJosepherum
m 1 revision
iw>Jackmcbarn
Parameters: name no longer needed
Line 1: Line 1:
{{documentation subpage}}
{{documentation subpage}}
{{High-use|47 000+}}


This template is intended to be a [[wikt:metatemplate|metatemplate]] for sidebar templates, which are [[Vertical direction|vertically]]-aligned [[Wikipedia:Navigation templates|navigation templates]].  The sidebar is usually positioned on the right-hand side of a page, in the same way as the {{tlx|infobox}} template is aligned for [[Wikipedia:Manual of Style/Infoboxes|infoboxes]].  
This template is intended to be a [[wikt:metatemplate|metatemplate]] for sidebar templates, which are [[Vertical direction|vertically]]-aligned [[Wikipedia:Navigation templates|navigation templates]].  The sidebar is usually positioned on the right-hand side of a page, in the same way as the {{tlx|infobox}} template is aligned for [[Wikipedia:Manual of Style/Infoboxes|infoboxes]].  
Line 58: Line 59:


== Parameters ==
== Parameters ==
No parameters are required unless {{tl|navbar}} links ({{small|V - T - E}}) are to appear at the bottom of the sidebar, in which case the {{para|name}} parameter is needed (see entry in the table immediately below).
If [[Template:Sidebar]] is being used as a wrapper template (rather than using [[Module:Sidebar]] directly), and {{tl|navbar}} links ({{small|V - T - E}}) are to appear at the bottom of the sidebar, then the {{para|name}} parameter is needed (see entry in the table immediately below). Otherwise, no parameters are required.


=== Principal ===
=== Principal ===
Line 65: Line 66:
|- style="vertical-align: top;"
|- style="vertical-align: top;"
| {{para|name}}
| {{para|name}}
| The sidebar's name, i.e., the name following "Template:" in the page's name. Required for the {{tl|navbar}} links at the bottom of the sidebar to function correctly, unless these are omitted (see {{para|navbar}} at the bottom of this table). It is recommended to use ''<nowiki>{{subst:PAGENAME}}</nowiki>'' for this field.
| The sidebar's name, i.e., the name following "Template:" in the page's name. If using [[Template:Sidebar]] as a wrapper around [[Module:Sidebar]], then it is required for the {{tl|navbar}} links at the bottom of the sidebar to function correctly, unless these are omitted (see {{para|navbar}} at the bottom of this table). It is recommended to use ''<nowiki>{{subst:PAGENAME}}</nowiki>'' for this field if using the wrapper is necessary.
|- style="vertical-align: top;"
|- style="vertical-align: top;"
| {{para|outertitle}}
| {{para|outertitle}}