Difference between revisions of "Template:Horizontal TOC/doc"
imported>Vanisaac m (→See also: clean up per WP:CAT#T and WP:AWBREQ add template:Sandbox other) |
imported>Gonnym (→See also: -1) |
||
| Line 52: | Line 52: | ||
*[[Help:TOC]] | *[[Help:TOC]] | ||
* {{tl|Compact ToC}} | * {{tl|Compact ToC}} | ||
| − | |||
* {{tl|List TOC Letters}} | * {{tl|List TOC Letters}} | ||
| − | |||
| − | |||
| − | |||
| − | |||
<templatedata> | <templatedata> | ||
{ | { | ||
| Line 103: | Line 98: | ||
} | } | ||
</templatedata> | </templatedata> | ||
| + | |||
| + | <includeonly>{{Sandbox other|| | ||
| + | <!-- Categories go here --> | ||
| + | [[Category:Wikipedia table of contents templates]] | ||
| + | }}</includeonly> | ||
Revision as of 16:24, 4 October 2020
| This is a documentation subpage for Template:Horizontal TOC. It contains usage information, categories and other content that is not part of the original template page. |
Script error: No such module "Uses TemplateStyles".
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.
To hide the generated heading numbers, use:
{{horizontal TOC|nonum=yes}}
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}}
To float the table of contents to the center of the page, use:
{{horizontal TOC|align=center}}
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,
{{horizontal TOC}}
produces:
Contents
See also
- Help:TOC
- {{Compact ToC}}
- {{List TOC Letters}}
This template lays out the table of contents in a horizontal list rather than a vertical one.
| Parameter | Description | Type | Status | |
|---|---|---|---|---|
| No numbers | nonum | Hide the generated heading numbers
| 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 | Separates entries by bullets, regardless of sub-sections.
| String | optional |
| Align | align | Which side of the page to align the ToC to. Allowed values are left, right, center
| String | optional |
| Clear | clear | Align underneath floating images and tables or not. Allowed values are left, right, both, none
| 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
| String | optional |