Template:Sidebar/doc: Difference between revisions
More actions
تعديل |
No edit summary |
||
| Line 3: | Line 3: | ||
No parameters are mandatory, but if the {{small|{{smallcaps|V{{dot}}T{{dot}}E}}}} {{tl|navbar}} links along the bottom of a {{tlf|Sidebar}} are to function correctly (unless their appearance is suppressed; see the ''navbar'' parameter [[#Other parameters|below]]), the parameter ''name'' needs to be set (to [[Wikipedia:Page name|the name of]] the sidebar's page). (This does not apply if the [[Lua (programming language)|Lua module]] that produces {{tlf|Sidebar}}, [[Module:Sidebar]], is being used directly.) | No parameters are mandatory, but if the {{small|{{smallcaps|V{{dot}}T{{dot}}E}}}} {{tl|navbar}} links along the bottom of a {{tlf|Sidebar}} are to function correctly (unless their appearance is suppressed; see the ''navbar'' parameter [[#Other parameters|below]]), the parameter ''name'' needs to be set (to [[Wikipedia:Page name|the name of]] the sidebar's page). (This does not apply if the [[Lua (programming language)|Lua module]] that produces {{tlf|Sidebar}}, [[Module:Sidebar]], is being used directly.) | ||
وت | |||
===Other parameters=== | ===Other parameters=== | ||
Revision as of 21:50, 5 November 2025
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}}, Module:Sidebar, is being used directly.)
وت
Other parameters
| Parameter | Explanation |
|---|---|
|above=
|
Same as the |above= offered by {{Navbox}}.
|
|
Microformat classes for the corresponding parameters. |
|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).) |
|
Use to alter the default CSS styling for the corresponding parameters. |
|cellspacing=|cellpadding=
|
Use to amend the default cellspacingTemplate:\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, place the child sidebar in a heading field, using either:
| 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
}}
| 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
}}
| below = "below" text
}}
Note that omitting the |title= parameter and not including any text preceding the embedded sidebar may result in the creation of gaps by spurious blank rows.
Full blank syntax
Template:Generic template demo
(omitting heading4/content4 to penultimate heading/content parameters)
{{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 =
| 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 Template:Navbar/doc.
See also
- Last pre-Lua version
- {{Sidebar with collapsible lists}}
- {{Infobox}}
- Wikipedia:UBLIST, for help using unbulleted lists within content.