Teamplaid:Sidebar/documentation

This template is about the vertical navigation template. For the horizontal template, see Teamplaid:Navbox. For the left sidebar of the interface, see the article in the Mediawiki Manual.

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.

{{Sidebar with collapsible lists}} is a version of {{Sidebar}} that adds collapsibility to its sections, i.e. the means to show or hide sections by clicking links beside their headings.

Ùsaid - Usage

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

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

| above = 

| heading1 = 
| content1 = 

| heading2 = 
| content2 = 

| heading3 = 
| content3 = 

<!-- etc, to: -->

| heading35 = 
| content35 = 

| below = 

}}

Paramadairean - Parameters

No parameters are mandatory, but if the V · T · E {{Navbar}} links along the bottom of a {{Sidebar}} 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 {{Sidebar}}, Mòideal:Sidebar, is being used directly.)

Principal parameters

Parameter	Explanation
name=	The sidebar's name, i.e. the name following "Teamplaid:" in the title shown at the top of the sidebar's page. Required if the V · T · E {{Navbar}} links at the bottom of the sidebar are to function correctly, unless their appearance is suppressed (see the Navbar parameter below) or {{Sidebar}} is not being used as a wrapper for Mòideal:Sidebar. When {{Sidebar}} is used as a wrapper, setting |name={{subst:PAGENAME}} is recommended.
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 |title= (if used). Full wiki syntax is expected (i.e. [[File:...]]). 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. (If |topimage= is used, it will appear immediately below it).
image=	Use to place an image between the |title= (if used) and first section. As with |topimage=, full wiki syntax is expected (i.e. [[File:...]]). 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= |content1=	First section's heading / content. content1 is required if heading1 is also to appear.
heading2= |content2=	Second section's heading / content. (content2 required if heading2 also to appear; etc.)
heading3= |content3=	Third section's heading / content.
...... etc ......
heading35= |content35=	Currently, the last possible section heading and/or content.

Other parameters

Parameter	Explanation
above=	Same as the |above= offered by {{Navbox}}.
|class= or |bodyclass= |outertitleclass= |topimageclass= |pretitleclass= |titleclass= |imageclass= |aboveclass= |headingclass= |contentclass= |belowclass=	Microformat classes for the corresponding parameters. (|class= and |bodyclass= are applied across the whole sidebar.)
below=	Same as the |below= offered by {{Navbox}}. (Use, for example, to add one or more portal links to the bottom of the template (shown, by default, in bold).)
|style= or |bodystyle= |outertitlestyle= |topimagestyle= |topcaptionstyle= |pretitlestyle= |titlestyle= |imagestyle= |captionstyle= |abovestyle= |headingstyle= |headingnstyle= |contentstyle= |contentnstyle= |belowstyle= |navbarstyle=   (or |tnavbarstyle=)	Use to alter the default CSS styling for the corresponding parameters. (|style= and |bodystyle= are applied across the whole sidebar.)
cellspacing= |cellpadding=	Use to amend the default cellspacing / cellpadding set for the infobox-class table with which the sidebar is built.
Navbar=  (or |tnavbar=)	Set to "off", "none", etc. (without quotes) to remove the {{Navbar}} links (V · T · E) that otherwise appear 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
 }}
| below = "below" text
}}

Note in the examples above that the child sidebar is placed in a content field, not a heading field. Notice also that the section subheadings do not appear in bold if this is not explicitly specified. To obtain bold section headings, move the titles to the heading field, 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 = First subsection
| content1 = 
 {{Sidebar |child=yes
  | heading1 = Heading 1.1
  | content1 = Content 1.1
 }}
| heading2 = Second subsection
| content2 = 
 {{Sidebar |child=yes
  | heading1 = Heading 2.1
  | content1 = Content 2.1
 }}
| below = "below" text
}}

Full blank syntax

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

<!-- (omitting heading4/content4 to penultimate heading/content parameters) -->

| belowclass = 
| belowstyle = 
| below = 

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

}}

Supplementary documentation

Supplementary related documentation (concerning {{Navbar}} use within a sidebar) is at Teamplaid:Navbar/documentation.

Roinn-seòrsa tracaidh - Tracking category

• Roinn-seòrsa:Pages using sidebar with the child parameter (2)

Faic cuideachd - Also see

• Last pre-Lua version
• {{Sidebar with collapsible lists}}
• {{Infobox}}
• UBLIST, for help using unbulleted lists within content.