Template:Sidebar/doc

From escforumwiki
Revision as of 19:36, 18 October 2008 by 86.5.145.165 (talk) (interwiki)
(diff) ← Older revision | Latest revision (diff) | Newer revision → (diff)
Jump to navigation Jump to search
For the previous Template:Sidebar,
use
<div class="infobox" style="width:20em;">......</div>.
That was its code.

This template is intended as a metatemplate for sidebar templates (vertically-aligned navigation (navbox) templates usually positioned on the righthand sides of pages) in the same spirit as {{Infobox}} for infobox templates and {{Navbox}} for navbox templates.

Pro forma

Parameters with infrequent use omitted.

{{Sidebar
|name     = 
|sectdivider = 
|exttitle = 
|topimage = 
|pretitle = 
|title    = 
|image    = 
|headingstyle = 
|contentstyle = 

|heading1 = 
|content1 = 

|heading2 = 
|content2 = 

|heading3 = 
|content3 = 

<!--(etc.)-->

|heading30 = 
|content30 = 
}}

Parameters

The only required parameter is content1, although see the entry for name in the table immediately below (first entry).

Principal

Parameter Explanation
name The sidebar's name, i.e. the name following "Template:" in the page's name. Required for the {{Tnavbar}} links at the bottom of the sidebar to function correctly, unless these are omitted (see tnavbar at the bottom of this table).
sectdivider CSS styling producing a visible divisions between the sidebar's headers, sections and footer. To disable, set sectdivider to "none;" or "off;", e.g. |sectdivider = none; (the trailing semicolon is required). Currently defaults to padding-bottom:0.4em; border-bottom:1px solid #aaa;, i.e. a single grey line separated from content above by a little padding.
exttitle Use to place a title for the sidebar immediately above the sidebar (i.e. externally).
topimage Use to place an image at the top of the sidebar, i.e. above any title included.
Full wikisyntax expected (i.e. [[Image:...]]).
To add a caption below the image, use topimagecaption.
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. [[Image:...]]).
To add a caption below the image, use imagecaption.
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 ......
heading30 Currently, the last possible section heading and/or content (if needed).
content30
tnavbar Set to "none" or "off" (but not to anything) to remove the {{Tnavbar}} links appearing at the bottom of the sidebar.

Other parameters

Parameter Explanation

class  (or bodyclass)
exttitleclass
topimageclass
titleclass
imageclass

Microformat classes for the corresponding parameters.
(class / bodyclass applies to the sidebar as a whole.)

portal Use to add one or more portal links to the bottom of the template (by default in bold).

style  (or bodystyle)
exttitlestyle
topimagestyle
topcaptionstyle
pretitlestyle
titlestyle
imagestyle
captionstyle
portalstyle
tnavbarstyle

Use to alter default CSS styling for the corresponding parameters.
(style / bodystyle 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.
tnavbaroptions Use to specify more options for the Tnavbar at the bottom of the sidebar (see {{Tnavbar}} for options available).

Full blank syntax

(omitting sections 4 to penultimate)

{{Sidebar
|name  = 
|class =        <!--or bodyclass-->
|style =        <!--or bodystyle-->
|cellspacing = 
|cellpadding = 
|sectdivider = 

|exttitle = 
|exttitleclass = 
|exttitlestyle = 

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

|pretitle =
|pretitlestyle = 

|title = 
|titleclass = 
|titlestyle = 

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

|headingstyle = 
|contentstyle = 

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

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

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

<!--(etc.)-->

|heading30style = 
|heading30 = 
|content30style = 
|content30 = 

|portalstyle = 
|portal = 

|tnavbarstyle   = 
|tnavbaroptions = 
}}

See also