Template:Sidebar/doc - Revision history

Tungocman at 02:16, 28 December 2011

2011-12-28T02:16:19Z

← Older revision		Revision as of 02:16, 28 December 2011
Line 1:		Line 1:
	<~~accesscontrol~~>~~Administrators,,Cem(ro),,Maysunshine(ro),,mod~~</~~accesscontrol~~>		<h2>Usage</h2>
	~~== Usage ==~~
	Parameters with infrequent use omitted.		Parameters with infrequent use omitted.
	<pre overflow: auto;">		<pre overflow: auto;">
Line 31:		Line 30:

	== Parameters ==		== Parameters ==
	No parameters are required unless {{tl\|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).

	=== Principal ===		=== Principal ===
	{\| class="wikitable" style="line-height: 1.4em;"		{\| class="wikitable" style="line-height: 1.4em;"
Line 38:		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 ~~{{tl\|~~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.		\| 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 80:		Line 77:
	\|- style="vertical-align: top;"		\|- style="vertical-align: top;"
	\| ''navbar''		\| ''navbar''
	\| Set to "none" (without the quotes) to remove the ~~{{tl\|~~navbar}} links appearing at the bottom of the sidebar.		\| Set to "none" (without the quotes) to remove the navbar links appearing at the bottom of the sidebar.
	\|}		\|}

Line 88:		Line 85:
	\|- style="vertical-align: top;"		\|- style="vertical-align: top;"
	\| ''above''		\| ''above''
	\| Corresponds to ''above'' parameter offered by {{~~tl\|~~Navbox}}.		\| Corresponds to ''above'' parameter offered by template <nowiki>{{Navbox}}</nowiki>.
	\|-		\|-
	\|		\|
Line 99:		Line 96:
	''headingclass'' <br />		''headingclass'' <br />
	\|		\|
	~~[[Wikipedia:WikiProject Microformats#What are microformats?\|~~Microformat]] classes for the corresponding parameters. ~~<br /> (''class''{{\}}''bodyclass'' applies to the sidebar as a whole.)~~		Microformat classes for the corresponding parameters.
	\|- style="vertical-align: top;"		\|- style="vertical-align: top;"
	\| ''below''		\| ''below''
Line 116:		Line 113:
	''navbarstyle'' <br />		''navbarstyle'' <br />
	\|		\|
	Use to alter default CSS styling for the corresponding parameters. ~~<br /> (''style''{{\}}''bodystyle'' applies to the sidebar as a whole.)~~		Use to alter default CSS styling for the corresponding parameters.
	\|- style="vertical-align: top;"		\|- style="vertical-align: top;"
	\| ''cellspacing ''		\| ''cellspacing ''
Line 125:		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 {{~~tl\|navbar~~}} for options available).		\| 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 ==
	~~{{tl\|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 <code style="white-space:nowrap;"><nowiki>{{normalwraplink\|</nowiki>''longlinkname''}}</code>, where ''longlinkname'' is the long link without its square brackets.		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.

Tungocman at 05:35, 27 December 2011

2011-12-27T05:35:29Z

← Older revision		Revision as of 05:35, 27 December 2011
Line 1:		Line 1:
			<accesscontrol>Administrators,,Cem(ro),,Maysunshine(ro),,mod</accesscontrol>
	== Usage ==		== Usage ==
	Parameters with infrequent use omitted.		Parameters with infrequent use omitted.

Tungocman at 05:26, 27 December 2011

2011-12-27T05:26:30Z

← Older revision		Revision as of 05:26, 27 December 2011
Line 1:		Line 1:
	~~{{Template:Documentation~~
	~~\|Template-Documentation =~~
	== Usage ==		== Usage ==
	Parameters with infrequent use omitted.		Parameters with infrequent use omitted.
Line 207:		Line 205:
	}}		}}
	</pre>		</pre>
	}}

Tungocman at 05:15, 27 December 2011

2011-12-27T05:15:41Z

← Older revision		Revision as of 05:15, 27 December 2011
Line 1:		Line 1:
	This template is intended as a metatemplate for sidebar templates (vertically-aligned [[Wikipedia:Navigation templates\|navigation (navbox)]] templates usually positioned on the righthand sides of pages) in the same spirit as {{~~tl\|Infobox}} for [[Wikipedia~~:~~Manual of Style (infoboxes)\|infobox]] templates and {{tl\|Navbox}} for navbox templates.~~		{{Template:Documentation
			\|Template-Documentation =
	~~{{tl~~\|~~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.~~

	== Usage ==		== Usage ==
	Parameters with infrequent use omitted.		Parameters with infrequent use omitted.
Line 209:		Line 207:
	}}		}}
	</pre>		</pre>
			}}

Tungocman: Created page with "This template is intended as a metatemplate for sidebar templates (vertically-aligned navigation (navbox) templates usually positioned on the r..."

2011-12-27T05:09:34Z

Created page with "This template is intended as a metatemplate for sidebar templates (vertically-aligned navigation (navbox) templates usually positioned on the r..."

New page

This template is intended as a metatemplate for sidebar templates (vertically-aligned [[Wikipedia:Navigation templates|navigation (navbox)]] templates usually positioned on the righthand sides of pages) in the same spirit as {{tl|Infobox}} for [[Wikipedia:Manual of Style (infoboxes)|infobox]] templates and {{tl|Navbox}} for navbox templates.

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

== Usage ==
Parameters with infrequent use omitted.
<pre overflow: auto;">
{{sidebar
| name = {{subst:PAGENAME}}
| outertitle =
| topimage =
| pretitle =
| title =
| image =
| headingstyle =
| contentstyle =

| heading1 =
| content1 =

| heading2 =
| content2 =

| heading3 =
| content3 =

...

| heading35 =
| content35 =

}}
</pre>

== Parameters ==
No parameters are required unless {{tl|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).

=== Principal ===
{| class="wikitable" style="line-height: 1.4em;"
! style="width: 7.0em;" | Parameter !! Explanation
|- style="vertical-align: top;"
| ''name''
| The sidebar's name, i.e. the name following "Template:" in the page's name. Required for the {{tl|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;"
| ''outertitle''
| Use to place a title for the sidebar immediately above the sidebar.
|- style="vertical-align: top;"
| ''topimage''
| Use to place an image at the top of the sidebar, i.e. above any ''title'' included. Full wikisyntax expected (i.e. <code><nowiki>[[Image:...]]</nowiki></code>). To add a caption below the image, use ''topimagecaption''.
|- style="vertical-align: top;"
| ''pretitle''
| Use to place a line such as "Part of the ''X'' series on" before the title.
|- style="vertical-align: top;"
| ''title''
| Use to place a title for the sidebar at the top of the sidebar (immediately below the ''topimage'', if used).
|- style="vertical-align: top;"
| ''image''
| Use to place an image between the ''title'' (if used) and first section. As with ''topimage'', full wikisyntax expected (i.e. <code><nowiki>[[Image:...]]</nowiki></code>). To add a caption below the image, use ''imagecaption''.
|- style="vertical-align: top;"
| ''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.
|- style="vertical-align: top;"
| ''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.
|- style="vertical-align: top;"
| ''heading1'' || First section's heading (if needed).
|-
| '''''content1''''' || First section's content (required).
|- style="vertical-align: top;"
| ''heading2'' || Second section's heading (if needed).
|-
| ''content2'' || Second section's content (if needed).
|- style="vertical-align: top;"
| ''heading3'' || Third section's heading (if needed).
|-
| ''content3'' || Third section's content (if needed).
|-
| colspan="2" | ...... etc ......
|-
| ''heading35'' || rowspan="2" | Currently, the last possible section heading and/or content (if needed).
|-
| ''content35''
|- style="vertical-align: top;"
| ''navbar''
| Set to "none" (without the quotes) to remove the {{tl|navbar}} links appearing at the bottom of the sidebar.
|}

=== Other parameters ===
{| class="wikitable" style="line-height: 1.4em;"
! style="width: 10.0em;" | Parameter !! Explanation
|- style="vertical-align: top;"
| ''above''
| Corresponds to ''above'' parameter offered by {{tl|Navbox}}.
|-
|
''class''  (or ''bodyclass'') 
''outertitleclass'' 
''topimageclass'' 
''pretitleclass'' 
''titleclass'' 
''imageclass'' 
''headingclass'' 
|
[[Wikipedia:WikiProject Microformats#What are microformats?|Microformat]] classes for the corresponding parameters. (''class''{{\}}''bodyclass'' applies to the sidebar as a whole.)
|- style="vertical-align: top;"
| ''below''
| Use to e.g. add one or more portal links to the bottom of the template (by default in bold).
|-
|
''style''  (or ''bodystyle'') 
''outertitlestyle'' 
''topimagestyle'' 
''topcaptionstyle'' 
''pretitlestyle'' 
''titlestyle'' 
''imagestyle'' 
''captionstyle'' 
''belowstyle'' 
''navbarstyle'' 
|
Use to alter default CSS styling for the corresponding parameters. (''style''{{\}}''bodystyle'' applies to the sidebar as a whole.)
|- style="vertical-align: top;"
| ''cellspacing ''
| Use to amend the default cellspacing set for the infobox-class table with which the sidebar is built.
|- style="vertical-align: top;"
| ''cellpadding''
| Ditto the default cellpadding.
|- style="vertical-align: top;"
| ''navbaroptions''
| Use to specify more options for the navbar at the bottom of the sidebar (see {{tl|navbar}} for options available).
|}

== Handling long links ==
{{tl|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 <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.

== Full blank syntax ==
(omitting sections 4 to penultimate)

<pre style="overflow: auto;">
{{Sidebar
| name = {{subst:PAGENAME}}
| class = 
| style = 
| 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 =



| heading35style =
| heading35 =
| content35style =
| content35 =

| belowstyle =
| below =

| navbar =
| navbarstyle =
| navbaroptions =

| wraplinks = true/false
}}
</pre>