Template:Horizontal TOC/sandbox

This is the template sandbox page for Template:Horizontal TOC (diff).
See also the companion subpage for test cases.

Template documentation[view] [edit] [history] [purge]

This template is used on approximately 6,900 pages and changes may be widely noticed. Test changes in the template's /sandbox or /testcases subpages, or in your own user subpage. Consider discussing changes on the talk page before implementing them.

This template uses TemplateStyles:

This template does not work properly in the Vector 2022 skin. Read the documentation for an explanation.

This template lays out the table of contents in a horizontal list rather than a vertical one.

Usage

{{horizontal TOC}}

There is no need to specify __NOTOC__: this template handles that automatically.

See example

To hide the generated heading numbers, use:

{{horizontal TOC|nonum=yes}}

See example

To suppress the parentheses around subsection lists, use:

{{horizontal TOC|noparens=yes}}

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

{{horizontal TOC|limit=2}}

See example

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

{{horizontal TOC|align=center}}

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.

Limitations

Since the Vector 2022 skin forces the table of contents into a sidebar or a pop-up menu, this template does not control the placement of the TOC in that skin. {{Compact TOC}} is usually a viable substitute; it may need customization, which is explained in its documentation.

Template parameters[Edit template data]
This template prefers inline formatting of parameters.
Parameter		Description	Type	Status
No numbers	`nonum`	Hide the generated heading numbers Example yes	String	optional
Limit	`limit`	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	Number	optional
No parenthesis	`no_parenthesis` `noparens`	Separates entries by bullets, regardless of sub-sections. Example yes	String	optional
Align	`align`	Which side of the page to align the ToC to. Allowed values are left, right, center Suggested values `left` `center` `right` Example align=left	String	optional
Clear	`clear`	Align underneath floating images and tables or not. Allowed values are left, right, both, none Suggested values `left` `right` `both` `none` Example clear:both	String	optional
Links	`links`	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]]	String	optional

The above documentation is transcluded from Template:Horizontal TOC/doc.
Editors can experiment in this template's sandbox and testcases pages.
Add categories to the /doc subpage. Subpages of this template.