در حال ویرایش الگو:Sidebar/توضیحات (بخش)

== پارامترها ==
{{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.)

{| class="wikitable"
|-
! scope="col" | Parameter
! scope="col" | Explanation
|-
| {{para|above}}
| Same as the {{para|above}} offered by {{tl|Navbox}}.
|-
| {{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.
|-
| {{para|float}}
| Accepts the values <code>none</code> and <code>left</code>. The former aligns the box left without floating and the latter with floating behavior. The default float is right and does not need specifying. Prefer this parameter (and passing it to any using templates such as with {{tl|Helpbox}}) to specifying your own floats in TemplateStyles.
|-
| {{para|outertitle}}
| Use to place a title for the sidebar immediately above the sidebar.
|-
| {{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.
|-
| {{para|pretitle}}
|style="padding-left:0.5em;"| Use to place a line such as "Part of the ''X'' series on" before the title.
|-
| {{para|title}}
|style="padding-left:0.5em;"| Use to place a title for the sidebar at the top of the sidebar. (If {{para|topimage}} is used, it will appear immediately below it).
|-
| {{para|image}}
|style="padding-left:0.5em;"| Use to place an image between the {{para|title}} (if used) and first section. As with {{para|topimage}}, full wiki syntax is expected (i.e. <code><nowiki>[[File:...]]</nowiki></code>). <br />To add a caption below the image, use {{para|caption}}.
|-
| {{para|heading<sub>n</sub>}}<br/>{{para|content<sub>n</sub>}}
|style="padding-left:0.5em;"| The ''n''th heading{{\}}content. ''content<sub>n</sub>'' is required if ''heading<sub>n</sub>'' is also to appear.
|-
| {{para|templatestyles}}
|style="padding-left:0.5em;"| See [[#TemplateStyles]].
|-
| id="Classes" |
*{{nowrap|{{para|class}} or {{para|bodyclass}}}}
*{{para|outertitleclass}}
*{{para|topimageclass}}
*{{para|pretitleclass}}
*{{para|titleclass}}
*{{para|imageclass}}
*{{para|aboveclass}}
*{{para|headingclass}}
*{{para|contentclass}}
*{{para|heading<sub>n</sub>class}}
*{{para|content<sub>n</sub>class}}
*{{para|belowclass}}
|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}}.

{{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]].

Dot before a class-name can be omitted: {{para|class|foo}}.
|-
| {{para|below}}
|style="padding-left:0.5em;"| Same as the {{para|below}} offered by {{tl|Navbox}}.<br />(Use, for example, to add one or more portal links to the bottom of the template (shown, by default, in bold).)
|-
| {{para|navbar}}
|style="padding-left:0.5em;"| When {{para|name}} is specified, {{tl|navbar}} is shown at the bottom of the sidebar. Setting {{para|navbar|off}} or {{para|navbar|none}} will suppress the {{navbar|Sidebar/doc|mini=1}} links showing.
|}

=== 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.

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.
# 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.

; {{para|templatestyles}}
: This parameter is intended for a template or module calling {{tl|sidebar}} directly.
; {{para|child templatestyles}}
: This parameter is intended for a template or module which calls a sidebar with {{para|templatestyles}}.
; {{para|grandchild 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:
{{div col}}
; <code>.sidebar</code>
: The top-level sidebar class.
; <code>.sidebar-outer-title</code>
: The class associated with a {{para|outertitle}}.
; <code>.sidebar-top-image</code>
: The class associated with a {{para|topimage}}.
; <code>.sidebar-top-caption</code>
: The class associated with a {{para|topcaption}}.
; <code>.sidebar-pretitle</code>
; <code>.sidebar-pretitle-with-top-image</code>
: The classes associated with a {{para|pretitle}}. Only one of these will be output per sidebar, depending on whether {{para|topimage}} is present.
; <code>.sidebar-title</code>
; <code>.sidebar-title-with-pretitle</code>
: The classes associated with a {{para|title}}. Only one of these will be output per sidebar, depending on whether {{para|pretitle}} is present.
; <code>.sidebar-image</code>
: The class associated with a {{para|image}}.
; <code>.sidebar-caption</code>
: The class associated with a {{para|caption}}.
; <code>.sidebar-above</code>
: The class associated with a {{para|above}}.
; <code>.sidebar-heading</code>
: The class associated with a {{para|heading<sub>n</sub>}}. Every heading will have this class.
; <code>.sidebar-content</code>
; <code>.sidebar-content-with-subgroup</code>
: The classes associated with {{para|content<sub>n</sub>}}. Every content group will have one of these classes, depending on whether the specific content has a subgroup.
; <code>.sidebar-below</code>
: The class associated with a {{para|below}}.
; <code>.sidebar-navbar</code>
: The class associated with a {{para|navbar}}.
{{div col end}}

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

For an example of a sidebar which does not need to support children templates of its own (whether because it has no children or because it wants no children):

<pre>
{{Sidebar
| title                = Child Example
| class                = sidebar-example
| templatestyles = Template:Sidebar/example/styles.css
}}
</pre>

For an example of a sidebar which does have its own children and an example of one of the children (grandchild templates have a similar use):

<div style="display: flex">
<pre>
{{Sidebar
| title                     = {{{title|Title Child Example}}}
| class                     = sidebar-example {{{class|}}}
| templatestyles      = Template:Sidebar/example/styles.css
| child templatestyles = {{{child templatestyles|}}}
}}
</pre>
<pre>
{{Sidebar/child example
| title                = Title Grandchild Example
| class                = sidebar-child-example
| child templatestyles = Template:Sidebar/child example/styles.css
}}
</pre>
</div>