View source for Template:Horizontal TOC/doc

{{Documentation subpage}}
{{Commons Import}}

<!-- Categories and interwikis go at the bottom of this page. -->
{{Uses TemplateStyles|Template:TOC limit/styles.css|Template:Horizontal TOC/styles.css|Template:Horizontal TOC/horizontal-toc-no-parentheses.css|noprotcat=yes}}

This template lays out the table of contents in a [[Wikipedia:WP:HLIST|horizontal list]] rather than a vertical one.

== Usage ==

<pre>
{{horizontal TOC}}
</pre>
There is no need to specify <code><nowiki>__NOTOC__</nowiki></code>: this template handles that automatically.
*[https://en.wikipedia.org/w/index.php?title=Template:Horizontal_TOC/doc&oldid=653960465 See example]

To hide the generated heading numbers, use:

<pre>
{{horizontal TOC|nonum=yes}}
</pre>
*[https://en.wikipedia.org/w/index.php?title=Template:Horizontal_TOC/doc&oldid=653960502 See example]

To suppress the parentheses around subsection lists, use:

<pre>
{{horizontal TOC|noparens=yes}}
</pre>

To limit the depth of the generated headings to the first headings only, use:

<pre>
{{horizontal TOC|limit=2}}
</pre>
*[https://en.wikipedia.org/w/index.php?title=Template:Horizontal_TOC/doc&oldid=653960535 See example]

To float the table of contents to the center of the page, use:

<pre>
{{horizontal TOC|align=center}}
</pre>
*[https://en.wikipedia.org/w/index.php?title=Template:Horizontal_TOC/doc&oldid=653960585 See example]

For country and state lists with flag icons, see these examples: [[Legality of cannabis by country]]. And: [[Legality of cannabis by U.S. jurisdiction]].

For example,
<pre>
{{horizontal TOC}}
</pre>
produces:
{{horizontal TOC}}

== See also ==
See wikipedia for more detail: [[wikipedia:Template:Horizontal TOC]]

<templatedata>
{
	"params": {
		"nonum": {
			"label": "No numbers",
			"description": "Hide the generated heading numbers",
			"example": "yes",
			"type": "string"
		},
		"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"
		},
		"no_parenthesis": {
			"label": "No parenthesis",
			"description": "Separates entries by bullets, regardless of sub-sections.",
			"example": "yes",
			"type": "string"
		},
		"align": {
			"label": "Align",
			"description": "Which side of the page to align the ToC to. Allowed values are left, right, center",
			"example": "align=left",
			"type": "string"
		},
		"clear": {
			"label": "Clear",
			"description": "Align underneath floating images and tables or not. Allowed values are left, right, both, none",
			"example": "clear:both",
			"type": "string"
		},
		"links": {
			"label": "Links",
			"description": "Specify a list of links for the table of contents instead of the section links automatically generated by the TOC magic word",
			"example": "* [[#Season 1|1]]",
			"type": "string"
		}

	},
	"description": "This template lays out the table of contents in a horizontal list rather than a vertical one.",
	"format": "inline"
}
</templatedata>

<includeonly>{{Sandbox other||
<!-- Categories go here -->
[[Category:Wikipedia table of contents templates]]
}}</includeonly>