Template:Sidebar/doc - Revision history

Matt at 09:24, 16 April 2025

2025-04-16T09:24:52Z

← Older revision		Revision as of 05:24, 16 April 2025
Line 92:		Line 92:
	\|-		\|-
	\| {{para\|topimage}}		\| {{para\|topimage}}
	\|style="padding-left:0.5em;"\| Use to place an image at the top of the sidebar, i.e. above {{para\|title}} (if used). Full wiki syntax is expected (i.e. <code><nowiki>[[File:...]]</nowiki></code>). <br />To add a caption below the image, use {{para\|topcaption}}. <br />Per [[WP:SIDEBAR]] this field should only be used to define a generic image for a sidebar, not to provide custom images for individual articles: sidebars are not displayed on mobile.		\|style="padding-left:0.5em;"\| Use to place an image at the top of the sidebar, i.e. above {{para\|title}} (if used). Full wiki syntax is expected (i.e. <code><nowiki>[[File:...]]</nowiki></code>). <br />To add a caption below the image, use {{para\|topcaption}}. <br />Per WP:SIDEBAR this field should only be used to define a generic image for a sidebar, not to provide custom images for individual articles: sidebars are not displayed on mobile.
	\|-		\|-
	\| {{para\|pretitle}}		\| {{para\|pretitle}}

Matt at 10:49, 14 April 2025

2025-04-14T10:49:20Z

← Older revision		Revision as of 06:49, 14 April 2025
Line 6:		Line 6:
	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.		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.

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

	Note that WP:LEADSIDEBAR discourages the placement of sidebars in the lead section of articles, though they may be included on a case-by-case basis.		Note that WP:LEADSIDEBAR discourages the placement of sidebars in the lead section of articles, though they may be included on a case-by-case basis.
Line 325:		Line 325:
	\|-		\|-
	\| {{para\|basestyle}}		\| {{para\|basestyle}}
	\| Additional CSS for a grabbag of parameters: {{para\|pretitle}}, {{para\|title}}, {{para\|heading<sub>n</sub>}}, and {{para\|listtitle<sub>n</sub>}} (for ~~{{tl\|sidebar with collapsible lists}}~~).		\| Additional CSS for a grabbag of parameters: {{para\|pretitle}}, {{para\|title}}, {{para\|heading<sub>n</sub>}}, and {{para\|listtitle<sub>n</sub>}} (for ).
	\| See related parameters for targeting pretitle, title, all headings, and all lists. Applies {{em\|before}} the specific style parameter so must be placed above that parameter's declarations if any in the TemplateStyles sheet.		\| See related parameters for targeting pretitle, title, all headings, and all lists. Applies {{em\|before}} the specific style parameter so must be placed above that parameter's declarations if any in the TemplateStyles sheet.
	\|-		\|-

Matt at 10:27, 14 April 2025

2025-04-14T10:27:05Z

← Older revision		Revision as of 06:27, 14 April 2025
Line 7:		Line 7:

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

	~~{{Navbox visibility}}~~

	Note that WP:LEADSIDEBAR discourages the placement of sidebars in the lead section of articles, though they may be included on a case-by-case basis.		Note that WP:LEADSIDEBAR discourages the placement of sidebars in the lead section of articles, though they may be included on a case-by-case basis.

Matt at 08:26, 14 April 2025

2025-04-14T08:26:33Z

← Older revision		Revision as of 04:26, 14 April 2025
Line 225:		Line 225:
	{{tl\|Normalwraplink}} may be used to handle individual 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 {{tlx\|normalwraplink\|{{var\|longlinkname}}}}, where {{para\|\|{{var\|longlinkname}}}} is the long link without its square brackets.		{{tl\|Normalwraplink}} may be used to handle individual 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 {{tlx\|normalwraplink\|{{var\|longlinkname}}}}, where {{para\|\|{{var\|longlinkname}}}} is the long link without its square brackets.

	Use the {{para\|wraplinks\|true}} parameter to enable link wrapping (disabling ~~{{codett\|lang=css\|nowraplinks}}~~ CSS class) for the whole template.		Use the {{para\|wraplinks\|true}} parameter to enable link wrapping (disabling CSS class) for the whole template.

	== Nesting ==		== Nesting ==

Matt at 22:33, 9 April 2025

2025-04-09T22:33:42Z

← Older revision		Revision as of 18:33, 9 April 2025
Line 1:		Line 1:
	{{wikipedia\|page name}}		{{wikipedia\|page name}}
	{{Documentation subpage}}		{{Documentation subpage}}
	{{#ifeq:{{FULLPAGENAME}}\|Template:Sidebar\|~~{{High-risk\| approximately 145000 }}~~{{Template display\|nomobile}}}}		{{#ifeq:{{FULLPAGENAME}}\|Template:Sidebar\|{{Template display\|nomobile}}}}
	{{Lua\|Module:Sidebar}}		{{Lua\|Module:Sidebar}}

Matt at 12:58, 9 April 2025

2025-04-09T12:58:21Z

← Older revision		Revision as of 08:58, 9 April 2025
Line 159:		Line 159:

	The canonical list of classes output with each kind of element of a sidebar (i.e. output for all {{para\|content<sub>n</sub>}}, or all cases of {{para\|above}}) can be found in Module:Sidebar/configuration in the "class" table. The below is a non-authoritative but otherwise sufficient list for most generic styling:		The canonical list of classes output with each kind of element of a sidebar (i.e. output for all {{para\|content<sub>n</sub>}}, or all cases of {{para\|above}}) can be found in Module:Sidebar/configuration in the "class" table. The below is a non-authoritative but otherwise sufficient list for most generic styling:
	~~{{div col}}~~
	; <code>.sidebar</code>		; <code>.sidebar</code>
	: The top-level sidebar class.		: The top-level sidebar class.
Line 189:		Line 188:
	; <code>.sidebar-navbar</code>		; <code>.sidebar-navbar</code>
	: The class associated with a {{para\|navbar}}.		: The class associated with a {{para\|navbar}}.
	~~{{div col end}}~~

	==== Example TemplateStyles parameter use ====		==== Example TemplateStyles parameter use ====

Matt at 11:59, 9 April 2025

2025-04-09T11:59:52Z

← Older revision		Revision as of 07:59, 9 April 2025
Line 1:		Line 1:
	{{wikipedia\|page name}}		{{wikipedia\|page name}}
	{{Documentation subpage}}		{{Documentation subpage}}
	~~{{about\|the vertical navigation template\|the horizontal template\|Template:Navbox\|the left sidebar of the interface\|mw:Manual:Interface/Sidebar{{!}}the article in the Mediawiki Manual}}~~
	{{#ifeq:{{FULLPAGENAME}}\|Template:Sidebar\|{{High-risk\| approximately 145000 }}{{Template display\|nomobile}}}}		{{#ifeq:{{FULLPAGENAME}}\|Template:Sidebar\|{{High-risk\| approximately 145000 }}{{Template display\|nomobile}}}}
	{{Lua\|Module:Sidebar}}		{{Lua\|Module:Sidebar}}
Line 398:		Line 397:
	* {{clc\|Sidebars with styles needing conversion}}		* {{clc\|Sidebars with styles needing conversion}}

	~~== See also ==~~
	* Last pre-Lua version
	* {{tl\|Sidebar with collapsible lists}}
	* {{tl\|Infobox}}
	* {{tl\|Side box}}
	* Wikipedia:UBLIST, for help using unbulleted lists within content.

	<includeonly>{{Sandbox other\|\|		<includeonly>{{Sandbox other\|\|

Matt at 15:07, 8 April 2025

2025-04-08T15:07:49Z

← Older revision		Revision as of 11:07, 8 April 2025
Line 5:		Line 5:
	{{Lua\|Module:Sidebar}}		{{Lua\|Module:Sidebar}}

	This template is a ~~[[wikt:~~metatemplate~~\|metatemplate]]~~ for the creation of sidebar templates, i.e. boxes that are ~~[[Vertical direction\|~~vertically]] aligned ~~[[Wikipedia:Navigation template\|~~navigation templates]]. Sidebars, like ~~[[Wikipedia:Manual of Style/Infoboxes\|~~infoboxes]], are usually positioned on the right-hand side of a page.		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.

	{{tl\|Sidebar with collapsible lists}} is a version of {{tl\|Sidebar}} that adds collapsibility to its sections, i.e. the means to show or hide sections by clicking links beside their headings.		{{tl\|Sidebar with collapsible lists}} is a version of {{tl\|Sidebar}} that adds collapsibility to its sections, i.e. the means to show or hide sections by clicking links beside their headings.
Line 11:		Line 11:
	{{Navbox visibility}}		{{Navbox visibility}}

	Note that [[WP:LEADSIDEBAR]] discourages the placement of sidebars in the lead section of articles, though they may be included on a case-by-case basis.		Note that WP:LEADSIDEBAR discourages the placement of sidebars in the lead section of articles, though they may be included on a case-by-case basis.

	== Usage ==		== Usage ==
Line 75:		Line 75:
	== Parameters ==		== Parameters ==
	{{anchor\|Other parameters}}		{{anchor\|Other parameters}}
	No parameters are mandatory. If {{tl\|navbar}} links 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. If {{tl\|navbar}} links 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 {{tlf\|Sidebar}}, Module:Sidebar, is being used directly.)

	{\| class="wikitable"		{\| class="wikitable"
Line 86:		Line 86:
	\|-		\|-
	\| {{para\|name}}		\| {{para\|name}}
	\| The sidebar's name, i.e. the name following "Template:" in the title shown at the top of the sidebar's page. <br />Required if the {{small\|{{smallcaps\|V T E}}}} {{tl\|navbar}} links at the bottom of the sidebar are to function correctly, unless their appearance is suppressed (see the ''navbar'' parameter ~~[[#Other parameters\|~~below]]) or {{tlf\|Sidebar}} is not being used as a ~~[[Wrapper function\|~~wrapper]] for [[Module:Sidebar]]. When {{tlf\|Sidebar}} is used as a wrapper, setting {{para\|name\|<nowiki>{{subst:PAGENAME}}</nowiki>}} is recommended.		\| The sidebar's name, i.e. the name following "Template:" in the title shown at the top of the sidebar's page. <br />Required if the {{small\|{{smallcaps\|V T E}}}} {{tl\|navbar}} links at the bottom of the sidebar are to function correctly, unless their appearance is suppressed (see the ''navbar'' parameter below) or {{tlf\|Sidebar}} is not being used as a wrapper for Module:Sidebar. When {{tlf\|Sidebar}} is used as a wrapper, setting {{para\|name\|<nowiki>{{subst:PAGENAME}}</nowiki>}} is recommended.
	\|-		\|-
	\| {{para\|float}}		\| {{para\|float}}
Line 110:		Line 110:
	\|-		\|-
	\| {{para\|templatestyles}}		\| {{para\|templatestyles}}
	\|style="padding-left:0.5em;"\| See [[#TemplateStyles]].		\|style="padding-left:0.5em;"\| See #TemplateStyles.
	\|-		\|-
	\| id="Classes" \|		\| id="Classes" \|
Line 126:		Line 126:
	*{{para\|belowclass}}		*{{para\|belowclass}}
	\|style="padding-left:0.5em;"\|		\|style="padding-left:0.5em;"\|
	Classes can be used to make styles easier to target for ~~[[#~~TemplateStyles~~\|TemplateStyles]]~~. {{para\|class}} must be used for this purpose for an entire sidebar (otherwise a page with multiple sidebars may take styles intended only for one sidebar). An example for a template named "Template:Example Sidebar" might have the class {{para\|class\|example-sidebar}}.		Classes can be used to make styles easier to target for TemplateStyles. {{para\|class}} must be used for this purpose for an entire sidebar (otherwise a page with multiple sidebars may take styles intended only for one sidebar). An example for a template named "Template:Example Sidebar" might have the class {{para\|class\|example-sidebar}}.

	{{para\|heading<sub>n</sub>class}} and {{para\|content<sub>n</sub>class}} can be used to target a specific heading or content group. This should be needed only rarely.		{{para\|heading<sub>n</sub>class}} and {{para\|content<sub>n</sub>class}} can be used to target a specific heading or content group. This should be needed only rarely.

	These classes can also be used for ~~[[WP:~~microformats~~\|microformats]]~~.		These classes can also be used for microformats.

	Dot before a class-name can be omitted: {{para\|class\|foo}}.		Dot before a class-name can be omitted: {{para\|class\|foo}}.
Line 144:		Line 144:
	{{further\|Wikipedia:TemplateStyles}}		{{further\|Wikipedia:TemplateStyles}}

	The TemplateStyles parameters {{para\|templatestyles}}, {{para\|child templatestyles}}, and {{para\|grandchild templatestyles}} take the pagename of a ~~[[WP:~~TemplateStyles~~\|TemplateStyles]]~~ page and turn it into a TemplateStyles tag. The TemplateStyles tag is a much more powerful way to add styling to a sidebar.		The TemplateStyles parameters {{para\|templatestyles}}, {{para\|child templatestyles}}, and {{para\|grandchild templatestyles}} take the pagename of a TemplateStyles page and turn it into a TemplateStyles tag. The TemplateStyles tag is a much more powerful way to add styling to a sidebar.

	Some rules of use:		Some rules of use:
	# Always add a template-specific class in {{para\|class}} so that the styles added to one sidebar will not "leak" into another sidebar. For example, [[Template:DYK tools]] has {{para\|class\|dyk-tools}} and the [[Template:DYK tools/styles.css]] page targets <code>.dyk-tools</code> for all of its added styling.		# Always add a template-specific class in {{para\|class}} so that the styles added to one sidebar will not "leak" into another sidebar. For example, Template:DYK tools has {{para\|class\|dyk-tools}} and the Template:DYK tools/styles.css page targets <code>.dyk-tools</code> for all of its added styling.
	# Do not assume Template:Sidebar will continue to have a table structure (i.e., do not target <code>table</code> or any other table HTML in the TemplateStyles page). The table structure is soft-deprecated and will go away at some point in the future.		# Do not assume Template:Sidebar will continue to have a table structure (i.e., do not target <code>table</code> or any other table HTML in the TemplateStyles page). The table structure is soft-deprecated and will go away at some point in the future.

	These tags are loaded in this order: Core templatestyles ([[Module:Sidebar/styles.css]]), templatestyles, child, and then grandchild, which can be used to 'cascade' the styles.		These tags are loaded in this order: Core templatestyles (Module:Sidebar/styles.css), templatestyles, child, and then grandchild, which can be used to 'cascade' the styles.

	; {{para\|templatestyles}}		; {{para\|templatestyles}}
Line 159:		Line 159:
	: This parameter is intended for a template or module which calls a sidebar with {{para\|child templatestyles}}.		: This parameter is intended for a template or module which calls a sidebar with {{para\|child templatestyles}}.

	The canonical list of classes output with each kind of element of a sidebar (i.e. output for all {{para\|content<sub>n</sub>}}, or all cases of {{para\|above}}) can be found in [[Module:Sidebar/configuration]] in the "class" table. The below is a non-authoritative but otherwise sufficient list for most generic styling:		The canonical list of classes output with each kind of element of a sidebar (i.e. output for all {{para\|content<sub>n</sub>}}, or all cases of {{para\|above}}) can be found in Module:Sidebar/configuration in the "class" table. The below is a non-authoritative but otherwise sufficient list for most generic styling:
	{{div col}}		{{div col}}
	; <code>.sidebar</code>		; <code>.sidebar</code>
Line 311:		Line 311:

	== Deprecated parameters ==		== Deprecated parameters ==
	The following parameters are deprecated in favor of ~~[[#~~TemplateStyles~~\|TemplateStyles]]~~ and templates/modules using them are categorized into [[:Category:Sidebars with styles needing conversion]]. The category page has further conversion information.		The following parameters are deprecated in favor of TemplateStyles and templates/modules using them are categorized into :Category:Sidebars with styles needing conversion. The category page has further conversion information.

	A specific real conversion example is [[Template:DYK tools]] where the ~~[[Special:Diff/1002727584\|~~styles were moved]] to [[Template:DYK tools/styles.css]].		A specific real conversion example is Template:DYK tools where the styles were moved to Template:DYK tools/styles.css.

	{\| class="wikitable"		{\| class="wikitable"
Line 322:		Line 322:
	\|-		\|-
	\| {{nowrap\|{{para\|style}} or {{para\|bodystyle}}}}		\| {{nowrap\|{{para\|style}} or {{para\|bodystyle}}}}
	\| Additional ~~[[Help:Cascading Style Sheets\|~~CSS]] for the whole sidebar.		\| Additional CSS for the whole sidebar.
	\| Class assigned to the template in {{para\|class}}		\| Class assigned to the template in {{para\|class}}
	\|-		\|-
Line 399:		Line 399:

	== See also ==		== See also ==
	* ~~[[Special:Permalink/609911857\|~~Last pre-Lua version]]		* Last pre-Lua version
	* {{tl\|Sidebar with collapsible lists}}		* {{tl\|Sidebar with collapsible lists}}
	* {{tl\|Infobox}}		* {{tl\|Infobox}}
	* {{tl\|Side box}}		* {{tl\|Side box}}
	* [[Wikipedia:UBLIST]], for help using unbulleted lists within content.		* Wikipedia:UBLIST, for help using unbulleted lists within content.

	<includeonly>{{Sandbox other\|\|		<includeonly>{{Sandbox other\|\|

Matt at 21:23, 5 March 2025

2025-03-05T21:23:51Z

← Older revision		Revision as of 17:23, 5 March 2025
Line 1:		Line 1:
			{{wikipedia\|page name}}
	{{Documentation subpage}}		{{Documentation subpage}}
	{{about\|the vertical navigation template\|the horizontal template\|Template:Navbox\|the left sidebar of the interface\|mw:Manual:Interface/Sidebar{{!}}the article in the Mediawiki Manual}}		{{about\|the vertical navigation template\|the horizontal template\|Template:Navbox\|the left sidebar of the interface\|mw:Manual:Interface/Sidebar{{!}}the article in the Mediawiki Manual}}

Matt: Protected "Template:Sidebar/doc": Initial wiki setup ([Edit=Allow only administrators] (indefinite) [Move=Allow only administrators] (indefinite))

2025-03-05T20:33:37Z

Protected "Template:Sidebar/doc": Initial wiki setup ([Edit=Allow only administrators] (indefinite) [Move=Allow only administrators] (indefinite))

← Older revision	Revision as of 16:33, 5 March 2025
(No difference)

← Older revision		Revision as of 07:59, 9 April 2025
Line 1:		Line 1:
	{{wikipedia\|page name}}		{{wikipedia\|page name}}
	{{Documentation subpage}}		{{Documentation subpage}}
	~~{{about\|the vertical navigation template\|the horizontal template\|Template:Navbox\|the left sidebar of the interface\|mw:Manual:Interface/Sidebar{{!}}the article in the Mediawiki Manual}}~~
	{{#ifeq:{{FULLPAGENAME}}\|Template:Sidebar\|{{High-risk\| approximately 145000 }}{{Template display\|nomobile}}}}		{{#ifeq:{{FULLPAGENAME}}\|Template:Sidebar\|{{High-risk\| approximately 145000 }}{{Template display\|nomobile}}}}
	{{Lua\|Module:Sidebar}}		{{Lua\|Module:Sidebar}}
Line 398:		Line 397:
	* {{clc\|Sidebars with styles needing conversion}}		* {{clc\|Sidebars with styles needing conversion}}

	~~== See also ==~~
	* Last pre-Lua version
	* {{tl\|Sidebar with collapsible lists}}
	* {{tl\|Infobox}}
	* {{tl\|Side box}}
	* Wikipedia:UBLIST, for help using unbulleted lists within content.

	<includeonly>{{Sandbox other\|\|		<includeonly>{{Sandbox other\|\|