Template:TOC right/doc - Revision history

Gwyneth Llewelyn: Cleaning up some explanations that may not be pertinent for the SL Wiki; prepared documentation to deal with both TOC left and right templates.

2023-06-11T00:27:07Z

Cleaning up some explanations that may not be pertinent for the SL Wiki; prepared documentation to deal with *both* TOC left and right templates.

← Older revision		Revision as of 17:27, 10 June 2023
Line 1:		Line 1:
	{{Documentation subpage}}		{{Documentation subpage}}
	<!--Categories where indicated at the bottom of this page, please; interwikis at Wikidata (see [[Wikipedia:Wikidata]])-->		<!--Categories where indicated at the bottom of this page, please; interwikis at Wikidata (see [[Wikipedia:Wikidata]])-->
	~~<!--{{High-use\| 34448 }}-->~~
	{{TOC right}}		{{TOC right}}
	{{tsh\|tocright\|TOCright}}		<!--{{tsh\|tocright\|TOCright}}-->
	{{Uses TemplateStyles\|Template:TOC limit/styles.css\|Template:TOC right/styles.css}}		<!--{{Uses TemplateStyles\|Template:TOC limit/styles.css\|Template:TOC right/styles.css}}-->
	{{cleanup}}		{{cleanup}}
	{{tl\|TOC right}} forces the auto-generated Table of Contents for an article to appear floated to the right side of the page, in order to improve article layout.		{{tl\|TOC right}} forces the auto-generated Table of Contents for an article to appear floated to the right side of the page, in order to improve article layout; {{tl\|TOC left}} is the equivalent template to float the TOC to the left.

	==Usage==		==Usage==
	Insert <code>{{{{BASEPAGENAME}}}}</code> at the point in the article where you want the top of the Table of Contents box to appear. This should usually be after the text of the lead section, and just before the first section heading, in accordance with {{Wikipedia\|MOS:LEADELEMENTS}}. Use with {{tl\|-}} or {{tl\|clear}} to prevent collision with text; use the '''clear''' parameter (see below) to prevent collision with images.		* Insert <code>{{{{BASEPAGENAME}}}}</code> at the point in the article where you want the top of the Table of Contents box to appear. This should usually be after the text of the lead section, and just before the first section heading, in accordance with {{Wikipedia\|MOS:LEADELEMENTS}}. Use with {{tl\|-}} or {{tl\|clear}} to prevent collision with text; use the '''clear''' parameter (see below) to prevent collision with images.

	* Avoid placing the TOC in a visually poor location. Crossing a section division is probably a poor idea.		* Avoid placing the TOC in a visually poor location. Crossing a section division is probably a poor idea.
			<!--
	;width: Set the CSS width.		;width: Set the CSS width.

Line 27:		Line 26:
	{{templatedata header}}		{{templatedata header}}

	~~<!--~~<templatedata~~>--~~>		<templatedata>
	<syntaxhighlight lang="json">		<syntaxhighlight lang="json">
	{		{
Line 58:		Line 57:
	}		}
	</syntaxhighlight>		</syntaxhighlight>
	~~<!--~~</templatedata>-->		</templatedata>-->

	==Note==		==Note==
	Unlike Wikipedia, which uses [https://www.mediawiki.org/wiki/Extension:TemplateStyles TemplateStyles], the SL Wiki already included a reasonably good 'hacked' {{~~Lts~~\|TOC}} template, and ~~this~~ only redirects it (probably badly).<ref>Still a work in progress, mind you — {{u\|Gwyneth Llewelyn}}</ref>		Unlike Wikipedia, which uses [https://www.mediawiki.org/wiki/Extension:TemplateStyles TemplateStyles], the SL Wiki already included a reasonably good 'hacked' {{Tl\|TOC}} template, and {{Tl\|{{BASEPAGENAME}}}} only redirects it (probably badly).<ref>Still a work in progress, mind you — {{u\|Gwyneth Llewelyn}}</ref>

	==See also==		==See also==
	* {{Lts\|TOC}}		* {{Lts\|TOC}}
			* {{Lts\|TOC right}}
	* {{Lts\|TOC left}}		* {{Lts\|TOC left}}

	<includeonly>{{Sandbox other\|\|		<includeonly>{{Sandbox other\|\|
	<!-- Categories below this line, please; interwikis at Wikidata -->		<!-- Categories below this line, please; interwikis at Wikidata -->
	{{DEFAULTSORT:Toc Right}}		<!--{{DEFAULTSORT:Toc Right}}--><!-- Merged documentation for left and right in the same spot-->
	[[Category:Wikipedia table of contents templates]]		[[Category:Wikipedia table of contents templates]]

	}}</includeonly>		}}</includeonly>

Gwyneth Llewelyn: fixed broken user page link

2023-06-11T00:15:08Z

fixed broken user page link

← Older revision		Revision as of 17:15, 10 June 2023
Line 61:		Line 61:

	==Note==		==Note==
	Unlike Wikipedia, which uses [https://www.mediawiki.org/wiki/Extension:TemplateStyles TemplateStyles], the SL Wiki already included a reasonably good 'hacked' {{Lts\|TOC}} template, and this only redirects it (probably badly).<ref>Still a work in progress, mind you — {{u~~:GwynethLlewelyn~~}}</ref>		Unlike Wikipedia, which uses [https://www.mediawiki.org/wiki/Extension:TemplateStyles TemplateStyles], the SL Wiki already included a reasonably good 'hacked' {{Lts\|TOC}} template, and this only redirects it (probably badly).<ref>Still a work in progress, mind you — {{u\|Gwyneth Llewelyn}}</ref>

	==See also==		==See also==

Gwyneth Llewelyn: /* See also */ Added main meta-template here as well

2023-06-11T00:13:42Z

See also: Added main meta-template here as well

← Older revision		Revision as of 17:13, 10 June 2023
Line 64:		Line 64:

	==See also==		==See also==
			* {{Lts\|TOC}}
	* {{Lts\|TOC left}}		* {{Lts\|TOC left}}

Gwyneth Llewelyn: Updating information explaining that this was adapted to use the already-existing (and working!) {{TOS}} template

2023-06-10T23:55:41Z

Updating information explaining that this was adapted to use the already-existing (and working!) {{TOS}} template

← Older revision		Revision as of 16:55, 10 June 2023
Line 59:		Line 59:
	</syntaxhighlight>		</syntaxhighlight>
	<!--</templatedata>-->		<!--</templatedata>-->

			==Note==
			Unlike Wikipedia, which uses [https://www.mediawiki.org/wiki/Extension:TemplateStyles TemplateStyles], the SL Wiki already included a reasonably good 'hacked' {{Lts\|TOC}} template, and this only redirects it (probably badly).<ref>Still a work in progress, mind you — {{u:GwynethLlewelyn}}</ref>

	==See also==		==See also==

Gwyneth Llewelyn: Fixing my own copypasted code :-P

2023-06-10T23:41:13Z

Fixing my own copypasted code :-P

← Older revision		Revision as of 16:41, 10 June 2023
Line 9:		Line 9:

	==Usage==		==Usage==
	Insert <code>{{{{BASEPAGENAME}}}}</code> at the point in the article where you want the top of the Table of Contents box to appear. This should usually be after the text of the lead section, and just before the first section heading, in accordance with [[MOS:LEADELEMENTS]]. Use with {{tl\|-}} or {{tl\|clear}} to prevent collision with text; use the '''clear''' parameter (see below) to prevent collision with images.		Insert <code>{{{{BASEPAGENAME}}}}</code> at the point in the article where you want the top of the Table of Contents box to appear. This should usually be after the text of the lead section, and just before the first section heading, in accordance with {{Wikipedia\|MOS:LEADELEMENTS}}. Use with {{tl\|-}} or {{tl\|clear}} to prevent collision with text; use the '''clear''' parameter (see below) to prevent collision with images.

	* Avoid placing the TOC in a visually poor location. Crossing a section division is probably a poor idea.		* Avoid placing the TOC in a visually poor location. Crossing a section division is probably a poor idea.
Line 15:		Line 15:
	;width: Set the CSS width.		;width: Set the CSS width.

	;limit: Limits the depth of subheadings shown. For instance using <code>limit=4</code> will hide the fourth level and deeper subheadings in the hierarchy. And <code>limit=2</code> will hide all subheadings leaving only the main headings. This works by hiding the lower levels with CSS. See [[Template:TOC limit/styles.css]].		;limit: Limits the depth of subheadings shown. For instance using <code>limit=4</code> will hide the fourth level and deeper subheadings in the hierarchy. And <code>limit=2</code> will hide all subheadings leaving only the main headings. This works by hiding the lower levels with CSS. See {{Wikipedia\|Template:TOC limit/styles.css}}.

	Do not place this template so that the TOC aligns with a large image or infobox; this breaks the layout on narrow screens (even users with screens as wide as 1024px wide can have problems). Also, a TOC that crosses a section division is probably a poor idea, if that can be avoided.		Do not place this template so that the TOC aligns with a large image or infobox; this breaks the layout on narrow screens (even users with screens as wide as 1024px wide can have problems). Also, a TOC that crosses a section division is probably a poor idea, if that can be avoided.
Line 21:		Line 21:
	Unless the section in which the {{tl\|TOC right}} is placed is long enough, the result may well be undesirable.		Unless the section in which the {{tl\|TOC right}} is placed is long enough, the result may well be undesirable.

	It should only be used in cases where the TOC gets in the way of other content or is detrimental to the layout of the page; it should ''not'' simply be used for aesthetics since it tampers with the standard appearance of articles. See [[Help:Section#Floating the TOC]] for further guidelines.		It should only be used in cases where the TOC gets in the way of other content or is detrimental to the layout of the page; it should ''not'' simply be used for aesthetics since it tampers with the standard appearance of articles. See {{Wikipedia\|Help:Section#Floating the TOC\|Floating the TOC}} for further guidelines.

	<templatedata>		==TemplateData==

			{{templatedata header}}

			<!--<templatedata>-->
			<syntaxhighlight lang="json">
	{		{
	"params": {		"params": {
Line 52:		Line 57:
	"format": "inline"		"format": "inline"
	}		}
	</templatedata>		</syntaxhighlight>
			<!--</templatedata>-->

	==See also==		==See also==

Gwyneth Llewelyn: Shamelessly copied from wikipedia.org; has errors needing cleaning up

2022-09-15T17:33:58Z

Shamelessly copied from wikipedia.org; has errors needing cleaning up

New page

{{Documentation subpage}}


{{TOC right}}
{{tsh|tocright|TOCright}}
{{Uses TemplateStyles|Template:TOC limit/styles.css|Template:TOC right/styles.css}}
{{cleanup}}
{{tl|TOC right}} forces the auto-generated Table of Contents for an article to appear floated to the right side of the page, in order to improve article layout.

==Usage==
Insert <code>{{{{BASEPAGENAME}}}}</code> at the point in the article where you want the top of the Table of Contents box to appear. This should usually be after the text of the lead section, and just before the first section heading, in accordance with [[MOS:LEADELEMENTS]]. Use with {{tl|-}} or {{tl|clear}} to prevent collision with text; use the '''clear''' parameter (see below) to prevent collision with images.

* Avoid placing the TOC in a visually poor location. Crossing a section division is probably a poor idea.

;width: Set the CSS width.

;limit: Limits the depth of subheadings shown. For instance using <code>limit=4</code> will hide the fourth level and deeper subheadings in the hierarchy. And <code>limit=2</code> will hide all subheadings leaving only the main headings. This works by hiding the lower levels with CSS. See [[Template:TOC limit/styles.css]].

Do not place this template so that the TOC aligns with a large image or infobox; this breaks the layout on narrow screens (even users with screens as wide as 1024px wide can have problems). Also, a TOC that crosses a section division is probably a poor idea, if that can be avoided.

Unless the section in which the {{tl|TOC right}} is placed is long enough, the result may well be undesirable.

It should only be used in cases where the TOC gets in the way of other content or is detrimental to the layout of the page; it should ''not'' simply be used for aesthetics since it tampers with the standard appearance of articles. See [[Help:Section#Floating the TOC]] for further guidelines.

<templatedata>
{
"params": {
"limit": {
"label": "Limit",
"description": "Limits the depth of subheadings shown. For instance using limit=4 will hide the fourth level and deeper subheadings in the hierarchy. And limit=2 will hide all subheadings leaving only the main headings. This works by hiding the lower levels with CSS",
"type": "number"
},
"clear": {
"label": "Clear",
"description": "Sets the CSS clear property, which forces this float underneath the side specified with this attribute. So, clear=right (which is the default) will place the element after all the right floating elements before it. Options are left, right, both, or none.",
"type": "string"
},
"width": {
"aliases": [
"1"
],
"label": "Width",
"description": "Overrides the CSS width"
}
},
"description": "{{TOC right}} forces the auto-generated \"Table of Contents\" for an article to appear floated to the right side of the page (as seen right), in order to improve article layout.",
"paramOrder": [
"clear",
"limit",
"width"
],
"format": "inline"
}
</templatedata>

==See also==
* {{Lts|TOC left}}

<includeonly>{{Sandbox other||

{{DEFAULTSORT:Toc Right}}
[[Category:Wikipedia table of contents templates]]

}}</includeonly>