Difference between revisions of "Template:TOClimit/Doc"
The Beyond Skyrim Wiki — Hosted by UESP
m (1 revision imported: templates from UESPWiki) |
m (clean out MetaTemplate) |
||
| Line 1: | Line 1: | ||
| − | |||
== Summary == | == Summary == | ||
This template places a table of contents (TOC) at the location where the template is. The only difference from a standard TOC is that the subheaders shown in the TOC can be controlled, using the limit parameter. | This template places a table of contents (TOC) at the location where the template is. The only difference from a standard TOC is that the subheaders shown in the TOC can be controlled, using the limit parameter. | ||
| − | |||
| − | |||
== Parameters == | == Parameters == | ||
| − | {{ | + | {| class="wikitable" |
| + | !colspan="3"| {{{template|{{BASEPAGENAME}}}}} | ||
| + | |- | ||
| + | ! Parameter !! Scope !! Description | ||
| + | |- | ||
|1 ''or'' limit|required|The limit to place on the subheaders shown in the TOC. limit{{=}}4 is the same as the default wiki settings. limit{{=}}2 would only show level-1 or level-2 headers (<code><nowiki>=...=</nowiki></code> or <code><nowiki>==...==</nowiki></code>). Values below 2 are ignored by the MediaWiki software, resulting in a normal TOC. | |1 ''or'' limit|required|The limit to place on the subheaders shown in the TOC. limit{{=}}4 is the same as the default wiki settings. limit{{=}}2 would only show level-1 or level-2 headers (<code><nowiki>=...=</nowiki></code> or <code><nowiki>==...==</nowiki></code>). Values below 2 are ignored by the MediaWiki software, resulting in a normal TOC. | ||
| − | + | |} | |
== Example == | == Example == | ||
Revision as of 23:57, 30 June 2017
Summary
This template places a table of contents (TOC) at the location where the template is. The only difference from a standard TOC is that the subheaders shown in the TOC can be controlled, using the limit parameter.
Parameters
| TOClimit | ||
|---|---|---|
| Parameter | Scope | Description |
required|The limit to place on the subheaders shown in the TOC. limit=4 is the same as the default wiki settings. limit=2 would only show level-1 or level-2 headers (=...= or ==...==). Values below 2 are ignored by the MediaWiki software, resulting in a normal TOC.
| ||
Example
{{TOClimit|2}}
Contents
Demonstration
Notice that this section, being under a level-3 header, does not show in the TOC.
