Teamplaid:Sidebar/doc

This template is intended to be a metatemplate for sidebar templates, which are vertically-aligned navigation templates. The sidebar is usually positioned on the right-hand side of a page, in the same way as the {{infobox}} template is aligned for infoboxes.

{{Sidebar with collapsible lists}} adds collapsibility to a sidebar's sections, i.e., the means to show or hide sections by clicking links beside their headings.

Usage

{{{outertitle}}}

{{{topimage}}} {{{topcaption}}}
{{{pretitle}}}
{{{title}}}
{{{image}}}
{{{above}}}
{{{heading1}}}
{{{content1}}}
{{{heading2}}}
{{{content2}}}
{{{heading3}}}
{{{content3}}}
... up to 35th ...
{{{heading35}}}
{{{content35}}}
{{{below}}}

(parameters with infrequent use omitted)

{{Sidebar
| name = {{subst:PAGENAME}}
| outertitle = 
| topimage = 
| pretitle = 
| title = 
| image = 

| headingstyle = 
| contentstyle = 

| heading1 = 
| content1 = 

| heading2 = 
| content2 = 

| heading3 = 
| content3 = 

<!--...up to 35th:-->

| heading35 = 
| content35 = 

}}

Parameters

No parameters are required unless {{navbar}} links (V - T - E) are to appear at the bottom of the sidebar, in which case the |name= parameter is needed (see entry in the table immediately below).

Principal

Parameter	Explanation
|name=	The sidebar's name, i.e., the name following "Template:" in the page's name. Required for the {{navbar}} links at the bottom of the sidebar to function correctly, unless these are omitted (see |navbar= at the bottom of this table). It is recommended to use {{subst:PAGENAME}} for this field.
|outertitle=	Use to place a title for the sidebar immediately above the sidebar.
|topimage=	Use to place an image at the top of the sidebar, i.e., above any |title= included. Full wikisyntax expected (i.e., [[Faidhle:...]]). To add a caption below the image, use |topcaption=.
|pretitle=	Use to place a line such as "Part of the X series on" before the title.
|title=	Use to place a title for the sidebar at the top of the sidebar (immediately below the |topimage=, if used).
|image=	Use to place an image between the |title= (if used) and first section. As with |topimage=, full wikisyntax expected (i.e., [[Faidhle:...]]). To add a caption below the image, use |caption=.
|headingstyle=	Use to alter the default CSS styling set for section headings. To alter the CSS styling for a specific section's heading, use |headingnstyle=, where n is the number of the section.
|contentstyle=	Use to alter the default CSS styling set for section content. To alter the CSS styling for a particular section's content, use |contentnstyle=, where n is the number of the section.
|heading1=	First section's heading (if needed).
|content1=	First section's content (required).
|heading2=	Second section's heading (if needed).
|content2=	Second section's content (if needed).
|heading3=	Third section's heading (if needed).
|content3=	Third section's content (if needed).
...... etc ......
|heading35=	Currently, the last possible section heading and/or content (if needed).
|content35=

Other parameters

Parameter	Explanation
|above=	Corresponds to |above= offered by {{navbox}}.
|bodyclass= (or |class=) |outertitleclass= |topimageclass= |pretitleclass= |titleclass= |imageclass= |aboveclass= |headingclass= |contentclass= |belowclass=	Microformat classes for the corresponding parameters. (|bodyclass= (or |class=) applies to the sidebar as a whole.)
|below=	Use to, e.g., add one or more portal links to the bottom of the template (by default in bold).
|bodystyle= (or |style=) |outertitlestyle= |topimagestyle= |topcaptionstyle= |pretitlestyle= |titlestyle= |imagestyle= |captionstyle= |abovestyle= |headingstyle= |headingnstyle= |contentstyle= |contentnstyle= |belowstyle= |navbarstyle= (or |tnavbarstyle=)	Use to alter default CSS styling for the corresponding parameters. (|bodystyle= (or |style=) applies to the sidebar as a whole.)
|cellspacing=	Use to amend the default cellspacing set for the infobox-class table with which the sidebar is built.
|cellpadding=	Ditto the default cellpadding.
|navbar= (or |tnavbar=)	Set to "none" (without the quotes) to remove the {{navbar}} links appearing at the bottom of the sidebar.
|navbarfontstyle= (or |tnavbarfontstyle=)	Use to specify the font style used by the navbar at the bottom of the sidebar (see {{navbar}} for options available).

Handling long links

{{Normalwraplink}} 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 {{normalwraplink|longlinkname}}, where |longlinkname is the long link without its square brackets.

Use the |wraplinks=true parameter to turn link wrapping off for the whole template.

Embedding

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

Top level title
First subsection
Heading 1.1
Content 1.1
Second subsection
Heading 2.1
Content 2.1
Below text

{{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
}}
|belowstyle = 
|below = Below text
}}

Note, in the examples above, the child infobox is placed in a content field, not a heading field. Notice that the section subheadings are not in bold font if bolding is not explicitly specified. To obtain bold section headings, place the child infobox in a heading field, either using

Top level title
First subsection
Heading 1.1
Content 1.1
Second subsection
Heading 2.1
Content 2.1
Below text

{{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
}}
|belowstyle = 
|below = Below text
}}

or,

Top level title
First subsection
Heading 1.1
Content 1.1
Second subsection
Heading 2.1
Content 2.1
Below text

{{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
}}
|belowstyle = 
|below = Below text
}}

Note that omitting the |title= parameter, and not including any text preceding the embedded sidebar, may result in spurious blank table rows, creating gaps in the visual presentation.

Full blank syntax

(omitting sections 4 to penultimate)

{{Sidebar
| name = {{subst:PAGENAME}}
| class =            <!--or bodyclass-->
| style =            <!--or bodystyle-->
| width = 
| cellspacing = 
| cellpadding = 

| 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 = 

<!--...up to 35th:-->

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

| belowclass = 
| belowstyle = 
| below = 

| navbarstyle =      <!--or tnavbarstyle-->
| navbarfontstyle =  <!--or tnavbarfontstyle-->
| navbar =           <!--or tnavbar-->

| wraplinks =        <!--true or false-->

}}

Supplementary documentation

Supplementary documentation relevant to navigational functionality through 'navbar' coding in a sidebar is at Teamplaid:Navbar/doc.

See also

• {{Sidebar with collapsible lists}}
• {{Infobox}}
• Wikipedia:UBLIST, for help in using unbulleted lists in fields.