View source for Template:TOC/doc

{{Documentation subpage}}
<!--Categories where indicated at the bottom of this page, please; interwikis at Wikidata (see [[Wikipedia:Wikidata]])-->
{{High-use}}
{{TOC right}}
{{tl|TOC}} Flexible meta-template to allow better placement of the Table of Contents.

==Usage==
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 header}}

<!--<templatedata>-->
<syntaxhighlight lang="json">
{
	"params": {
		"float": {
			"label": "Float",
			"description": "Floats the TOC either to the left (default) or right",
			"type": "string"
		},
		"style": {
			"label": "Style",
			"description": "<div> style attribute",
			"type": "string"
		},
		"depth": {
			"label": "Depth",
			"description": "Limits the depth of subheadings shown. For instance, using depth=4 will hide the fourth level and deeper subheadings in the hierarchy. And depth=2 will hide all subheadings leaving only the main headings. This works by hiding the lower levels with CSS. Valid values are 1 to 6.",
			"type": "number"
		},
		"class": {
			"label": "Class",
			"description": "<div> class attribute",
			"type": "string"
		}
	},
	"description": "{{TOC}} allows the auto-generated \"Table of Contents\" for an article to be formatted/styled according to a few parameters.",
	"paramOrder": [
		"float",
		"style",
		"depth",
		"class"
	],
	"format": "inline"
}
</syntaxhighlight>
<!--</templatedata>-->


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

<includeonly>{{Sandbox other||
<!-- Categories below this line, please; interwikis at Wikidata -->
{{DEFAULTSORT:Toc}}
[[Category:Wikipedia table of contents templates]]

}}</includeonly>