Difference between revisions of "Template:Sidebar/doc"
(One intermediate revision by the same user not shown) | |||
Line 1: | Line 1: | ||
− | + | <h2>Usage</h2> | |
Parameters with infrequent use omitted. | Parameters with infrequent use omitted. | ||
<pre overflow: auto;"> | <pre overflow: auto;"> | ||
Line 30: | Line 30: | ||
== Parameters == | == Parameters == | ||
− | |||
− | |||
=== Principal === | === Principal === | ||
{| class="wikitable" style="line-height: 1.4em;" | {| class="wikitable" style="line-height: 1.4em;" | ||
Line 37: | Line 35: | ||
|- style="vertical-align: top;" | |- style="vertical-align: top;" | ||
| ''name'' | | ''name'' | ||
− | | The sidebar's name, i.e. the name following "Template:" in the page's name. Required for the | + | | 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 ''<nowiki>{{subst:PAGENAME}}</nowiki>'' for this field. |
|- style="vertical-align: top;" | |- style="vertical-align: top;" | ||
| ''outertitle'' | | ''outertitle'' | ||
Line 79: | Line 77: | ||
|- style="vertical-align: top;" | |- style="vertical-align: top;" | ||
| ''navbar'' | | ''navbar'' | ||
− | | Set to "none" (without the quotes) to remove the | + | | Set to "none" (without the quotes) to remove the navbar links appearing at the bottom of the sidebar. |
|} | |} | ||
Line 87: | Line 85: | ||
|- style="vertical-align: top;" | |- style="vertical-align: top;" | ||
| ''above'' | | ''above'' | ||
− | | Corresponds to ''above'' parameter offered by {{ | + | | Corresponds to ''above'' parameter offered by template <nowiki>{{Navbox}}</nowiki>. |
|- | |- | ||
| | | | ||
Line 98: | Line 96: | ||
''headingclass'' <br /> | ''headingclass'' <br /> | ||
| | | | ||
− | + | Microformat classes for the corresponding parameters. | |
|- style="vertical-align: top;" | |- style="vertical-align: top;" | ||
| ''below'' | | ''below'' | ||
Line 115: | Line 113: | ||
''navbarstyle'' <br /> | ''navbarstyle'' <br /> | ||
| | | | ||
− | Use to alter default CSS styling for the corresponding parameters. | + | Use to alter default CSS styling for the corresponding parameters. |
|- style="vertical-align: top;" | |- style="vertical-align: top;" | ||
| ''cellspacing '' | | ''cellspacing '' | ||
Line 124: | Line 122: | ||
|- style="vertical-align: top;" | |- style="vertical-align: top;" | ||
| ''navbaroptions'' | | ''navbaroptions'' | ||
− | | Use to specify more options for the navbar at the bottom of the sidebar (see {{ | + | | Use to specify more options for the navbar at the bottom of the sidebar (see template <nowiki>{{Navbox}}</nowiki> for options available). |
|} | |} | ||
== Handling long links == | == Handling long links == | ||
− | + | Use <code style="white-space:nowrap;"><nowiki>{{normalwraplink|</nowiki>''longlinkname''}}</code>, where ''longlinkname'' is the long link without its square brackets. | |
Use the <code>wraplinks</code> parameter to turn link wrapping off for the whole template. | Use the <code>wraplinks</code> parameter to turn link wrapping off for the whole template. |
Latest revision as of 03:16, 28 December 2011
Contents
Usage
Parameters with infrequent use omitted.
{{sidebar | name = {{subst:PAGENAME}} | outertitle = | topimage = | pretitle = | title = | image = | headingstyle = | contentstyle = | heading1 = | content1 = | heading2 = | content2 = | heading3 = | content3 = ... | heading35 = | content35 = }}
Parameters
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. [[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 ...... | |
heading35 | Currently, the last possible section heading and/or content (if needed). |
content35 | |
navbar | Set to "none" (without the quotes) to remove the navbar links appearing at the bottom of the sidebar. |
Other parameters
Parameter | Explanation |
---|---|
above | Corresponds to above parameter offered by template {{Navbox}}. |
class (or bodyclass) |
Microformat classes for the corresponding parameters. |
below | Use to e.g. add one or more portal links to the bottom of the template (by default in bold). |
style (or bodystyle) |
Use to alter default CSS styling for the corresponding parameters. |
cellspacing | Use to amend the default cellspacing set for the infobox-class table with which the sidebar is built. |
cellpadding | Ditto the default cellpadding. |
navbaroptions | Use to specify more options for the navbar at the bottom of the sidebar (see template {{Navbox}} for options available). |
Handling long links
Use {{normalwraplink|longlinkname}}
, where longlinkname is the long link without its square brackets.
Use the wraplinks
parameter to turn link wrapping off for the whole template.
Full blank syntax
(omitting sections 4 to penultimate)
{{Sidebar | name = {{subst:PAGENAME}} | class = <!--or bodyclass--> | style = <!--or bodystyle--> | cellspacing = | cellpadding = | sectdivider = | outertitle = | outertitleclass = | outertitlestyle = | topimage = | topimageclass = | topimagestyle = | topcaption = | topcaptionstyle = | pretitle = | pretitlestyle = | title = | titleclass = | titlestyle = | image = | imageclass = | imagestyle = | caption = | captionstyle = | abovestyle = | above = | headingstyle = | contentstyle = | heading1style = | heading1 = | content1style = | content1 = | heading2style = | heading2 = | content2style = | content2 = | heading3style = | heading3 = | content3style = | content3 = <!--etc.--> | heading35style = | heading35 = | content35style = | content35 = | belowstyle = | below = | navbar = | navbarstyle = | navbaroptions = | wraplinks = true/false }}