Template:TOC limit/doc: Difference between revisions
>Rich [email protected] m (moved Template:TOClimit/doc to Template:TOC limit/doc: space per guidelines) |
>Rich [email protected] No edit summary |
||
| Line 6: | Line 6: | ||
=== Usage === | === Usage === | ||
<tt><nowiki>{{ | <tt><nowiki>{{TOC limit}}</nowiki></tt> | ||
The template defaults to including only == level 2 == and === level 3 === headers. | The template defaults to including only == level 2 == and === level 3 === headers. | ||
| Line 12: | Line 12: | ||
You can specify a different limit by adding a header level: | You can specify a different limit by adding a header level: | ||
<tt><nowiki>{{ | <tt><nowiki>{{TOC limit|4}}</nowiki></tt> | ||
4 allows ==== level 4 headers ==== but omits any subheadings below that from the TOC. | 4 allows ==== level 4 headers ==== but omits any subheadings below that from the TOC. | ||
| Line 19: | Line 19: | ||
=== Conflicts === | === Conflicts === | ||
This template does not interact well with the {{tl| | This template does not interact well with the {{tl|TOC right}}, {{tl|TOC left}}, {{tl|TOC center}} templates. To achieve the correct effect, use those with a limit parameter. For example, {{tlx|TOC right|2=limit=2}} has the effect that {{tlx|TOC right}} and {{tlx|TOC limit|2}} would have—if they worked together. | ||
<includeonly> | <includeonly> | ||
Revision as of 15:09, 3 October 2009
This template inserts a Table of Contents which omits subheadings lower than a certain level. The table obeys the same layout rules as the __TOC__ magic word. Omitted sections still have section edit links in the article body; the main use for this template is situations where you want section edit links for ease of editing but don't want to clutter the table of contents.
Usage
{{TOC limit}}
The template defaults to including only == level 2 == and === level 3 === headers.
You can specify a different limit by adding a header level:
{{TOC limit|4}}
4 allows ==== level 4 headers ==== but omits any subheadings below that from the TOC.
The template works by hiding the lower levels with CSS. See MediaWiki:Common.css.
Conflicts
This template does not interact well with the {{TOC right}}, {{TOC left}}, {{TOC center}} templates. To achieve the correct effect, use those with a limit parameter. For example, {{TOC right|limit=2}} has the effect that {{TOC right}} and {{TOC limit|2}} would have—if they worked together.