Template:Horizontal TOC

Template documentation[ view · edit · history · purge ]

This documentation is transcluded from Template:Horizontal TOC/doc.

This template uses TemplateStyles:

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

Usage

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

Template parameters

Parameter	Description		Default	Status
`nonum`	no numbers	Hide the generated heading numbers	empty	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.	empty	optional
`align`	alignment	Which side of the page to align the ToC to. Allowed values are left, right, center	empty	optional
`clear`	clear	Align underneath floating images and tables or not. Allowed values are left, right, both, none	empty	optional

Template data

Parameter text is empty

TemplateData

TemplateData is a way to store information about template parameters (the description of those and of the whole template) for both humans and machines. It is used by VisualEditor and possibly other tools like Upload Wizard.

Existing template documentation
At Wikimedia Commons, it is recommended to use {{TemplateBox}} with either ‎useTemplateData=1 or ‎useTemplateData=only on the ‎/doc subpage and transcluding it with {{Documentation}} into the template. ‎<nowiki>-tags can be wrapped around the arguments, if required, to avoid templates being expanded.

Newly created template documentation and imports
Another option, especially for imported templates, or for users with JSON experience, is placing raw ‎<templatedata>-tags into the Wikitext of the template, as described in various Wikipediae.

Wikipedia's help about TemplateData • Commons-specific information

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

Template parameters[Edit template data]
This template prefers inline formatting of parameters.
Parameter		Description	Type	Status
alignment	`align`	Which side of the page to align the ToC to. Allowed values are left, right, center	Line	optional
clear	`clear`	Align underneath floating images and tables or not. Allowed values are left, right, both, none	Line	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 numbers	`nonum`	Hide the generated heading numbers	Line	optional

Additional information

The template is intended to be used in the following namespaces: no namespace specified

The template is intended to be used by the following user groups: no user group specified

Relies on:
{{Nonumtoc}}

Example

{{horizontal TOC|}}

renders as:

Further examples

To hide the generated heading numbers, use:

{{horizontal TOC|nonum=yes}}

See example

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