Template:Sidebar/doc

Template:Documentation subpage Template:Lua Template:For

This template is a metatemplate for the creation of sidebar templates, i.e. boxes that are vertically-aligned navigation templates. Sidebars, like infoboxes, are usually positioned on the right-hand side of a page.

Template:Tl is a version of Template:Tl that adds collapsibility to its sections, i.e. the means to show or hide sections by clicking links beside their headings.

Usage

Template:Generic template demo (parameters with infrequent use omitted)

{{Sidebar
| name = {{subst:PAGENAME}}
| pretitle = 
| title = 
| image = 
| headingstyle = 
| contentstyle = 

| above = 

| heading1 = 
| content1 = 

| heading2 = 
| content2 = 

| heading3 = 
| content3 = 

<!-- etc, to: -->

| heading35 = 
| content35 = 

| below = 

}}

Parameters

No parameters are mandatory, but if the Template:Small Template:Tl links along the bottom of a Template:Tlf are to function correctly (unless their appearance is suppressed; see the navbar parameter below), the parameter name needs to be set (to the name of the sidebar's page). (This does not apply if the Lua module that produces Template:Tlf, Module:Sidebar, is being used directly.)

Principal parameters

Parameter	Explanation
Template:Para	The sidebar's name, i.e. the name following "Template:" in the title shown at the top of the sidebar's page. Required if the Template:Small Template:Tl links at the bottom of the sidebar are to function correctly, unless their appearance is suppressed (see the navbar parameter below) or Template:Tlf is not being used as a wrapper for Module:Sidebar. When Template:Tlf is used as a wrapper, setting Template:Para is recommended.
Template:Para	Use to place a title for the sidebar immediately above the sidebar.
Template:Para	Use to place an image at the top of the sidebar, i.e. above Template:Para (if used). Full wiki syntax is expected (i.e. `[[File:...]]`). To add a caption below the image, use Template:Para.
Template:Para	Use to place a line such as "Part of the X series on" before the title.
Template:Para	Use to place a title for the sidebar at the top of the sidebar. (If Template:Para is used, it will appear immediately below it).
Template:Para	Use to place an image between the Template:Para (if used) and first section. As with Template:Para, full wiki syntax is expected (i.e. `[[File:...]]`). To add a caption below the image, use Template:Para.
Template:Para	Use to alter the default CSS styling set for section headings. To alter the CSS styling for a specific section's heading, use Template:Para, where n is the number of the section.
Template:Para	Use to alter the default CSS styling set for section content. To alter the CSS styling for a particular section's content, use Template:Para, where n is the number of the section.
Template:Para Template:Para	First section's headingTemplate:\content. content1 is required if heading1 is also to appear.
Template:Para Template:Para	Second section's headingTemplate:\content. (content2 required if heading2 also to appear; etc.)
Template:Para Template:Para	Third section's headingTemplate:\content.
...... etc ......
Template:Para Template:Para	Currently, the last possible section heading and/or content.

Other parameters

Parameter	Explanation
Template:Para	Same as the Template:Para offered by Template:Tl.
Template:Nowrap Template:Para Template:Para Template:Para Template:Para Template:Para Template:Para Template:Para Template:Para Template:Para	Microformat classes for the corresponding parameters. (Template:Para and Template:Para are applied across the whole sidebar.)
Template:Para	Same as the Template:Para offered by Template:Tl. (Use, for example, to add one or more portal links to the bottom of the template (shown, by default, in bold).)
Template:Nowrap Template:Para Template:Para Template:Para Template:Para Template:Para Template:Para Template:Para Template:Para Template:Para Template:Para Template:Para Template:Para Template:Para Template:Longitem	Use to alter the default CSS styling for the corresponding parameters. (Template:Para and Template:Para are applied across the whole sidebar.)
Template:Para Template:Para	Use to amend the default cellspacingTemplate:\cellpadding set for the infobox-class table with which the sidebar is built.
Template:Longitem	Set to "off", "none", etc (without quotes) to remove the Template:Tl links (Template:Small) that otherwise appear at the bottom of the sidebar.
Template:Longitem	Use to specify the font style used by the navbar at the bottom of the sidebar (see Template:Tl for options available).

Handling long links

Template:Tl may be used to handle links that should wrap within the sidebar or otherwise need to be made to wrap, in order to prevent the sidebar from becoming too wide. Use Template:Tlx, where Template:Para is the long link without its square brackets.

Use the Template:Para parameter to turn link wrapping off for the whole template.

Embedding

One sidebar template can be embedded into another using the Template:Para parameter. This feature can be used to create a modular sidebar, or to create more well-defined and logical sections.

{{Sidebar
| title = Top-level title
| content1 =
 {{Sidebar |child=yes
  | title = First subsection
  | heading1 = Heading 1.1
  | content1 = Content 1.1
 }}
| content2 =
 {{Sidebar |child=yes
  | title = Second subsection
  | heading1 = Heading 2.1
  | content1 = Content 2.1
 }}
| below = "below" text
}}

Note in the examples above that the child sidebar is placed in a Template:Code field, not a Template:Code field. Notice also that the section subheadings do not appear in bold if this is not explicitly specified. To obtain bold section headings, place the child sidebar in a Template:Code field, using either:

{{Sidebar
| title = Top-level title
| heading1 =
 {{Sidebar |child=yes
  | title = First subsection
  | heading1 = Heading 1.1
  | content1 = Content 1.1
 }}
| heading2 =
 {{Sidebar |child=yes
  | title = Second subsection
  | heading1 = Heading 2.1
  | content1 = Content 2.1
 }}
| below = "below" text
}}

or:

{{Sidebar
| title = Top-level title
| heading1 = First subsection
 {{Sidebar |child=yes
  | heading1 = Heading 1.1
  | content1 = Content 1.1
 }}
| heading2 = Second subsection
 {{Sidebar |child=yes
  | heading1 = Heading 2.1
  | content1 = Content 2.1
 }}
| below = "below" text
}}

Note that omitting the Template:Para parameter and not including any text preceding the embedded sidebar may result in the creation of gaps by spurious blank rows.

Full blank syntax

Template:Generic template demo

(omitting heading4/content4 to penultimate heading/content parameters)

{{Sidebar
| name = {{subst:PAGENAME}}
| class =            <!-- or: | bodyclass = -->
| style =            <!-- or: | bodystyle = -->
| width = 
| cellspacing = 
| cellpadding = 
| wraplinks =        <!-- "true" otherwise (default:) omit -->

| outertitleclass = 
| outertitlestyle = 
| outertitle = 

| topimageclass = 
| topimagestyle = 
| topimage = 
| topcaptionstyle = 
| topcaption = 

| pretitleclass = 
| pretitlestyle = 
| pretitle = 

| titleclass = 
| title = 

| imageclass = 
| imagestyle = 
| image = 
| captionstyle = 
| caption = 

| headingclass = 
| headingstyle = 
| contentclass = 
| contentstyle = 

| aboveclass = 
| abovestyle = 
| above = 

| heading1style = 
| heading1 = 
| content1style = 
| content1 = 

| heading2style = 
| heading2 = 
| content2style = 
| content2 = 

| heading3style = 
| heading3 = 
| content3style = 
| content3 = 

<!-- etc, to: -->

| heading35style = 
| heading35 = 
| content35style = 
| content35 = 

| belowclass = 
| belowstyle = 
| below = 

| navbarstyle =      <!-- or: | tnavbarstyle = -->
| navbarfontstyle =  <!-- or: | tnavbarfontstyle = -->
| navbar =           <!-- or: | tnavbar = --> <!-- "off", "none", etc otherwise (default:) omit -->

}}

Supplementary documentation

Supplementary related documentation (concerning Template:Tl use within a sidebar) is at Template:Navbar/doc.