Template:Sidebar/doc
From OpenSimulator
(Created page with "{{documentation subpage}} This template is intended as a metatemplate for sidebar templates (vertically-aligned navigation (navbox) templates ...") |
Latest revision as of 22:58, 22 October 2011
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.
Use {{Unbulleted list}} rather than
{{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.
Contents |
[edit] 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 =
}}
[edit] Parameters
No parameters are required unless {{navbar}} links ("v·d·e") are to appear at the bottom of the sidebar, in which case the parameter name is needed (see entry in the table immediately below).
[edit] 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).</tr> | content1 | First section's content (required).</tr> |
| heading2 | Second section's heading (if needed).</tr> | content2 | Second section's content (if needed).</tr> |
| heading3 | Third section's heading (if needed).</tr> | content3 | Third section's content (if needed).</tr> |
| ...... etc ...... | |||
| heading35 | Currently, the last possible section heading and/or content (if needed).</tr> | content35 | |
| navbar | Set to "none" (without the quotes) to remove the {{navbar}} links appearing at the bottom of the sidebar. | ||
[edit] Other parameters
| Parameter | Explanation |
|---|---|
| above | Corresponds to above parameter offered by {{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 {{navbar}} for options available). |
[edit] 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 becoming too wide. 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.
[edit] 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
}}
