Deleted User at 00:18, 15 October 2022

2022-10-15T00:18:03Z

← Older revision		Revision as of 15:18, 14 October 2022
Line 1:		Line 1:
	{{Documentation subpage}}		{{Documentation subpage}}
	{{Uses TemplateStyles\|Template:TOC limit/styles.css}}		{{Uses TemplateStyles\|Template:TOC limit/styles.css}}
	<!-- Categories go where indicated at the bottom of this page, please; ~~interwikis go to Wikidata (see also: [[Wikipedia:Wikidata]]).~~ -->		<!-- Categories go where indicated at the bottom of this page, please; interwi -->
	{{High-use\| 15719 }}		{{High-use\| 15719 }}
	This template inserts a Table of Contents that omits subheadings beyond a certain depth. The table obeys the same layout rules as the <nowiki>__TOC__</nowiki> ~~[[WP:MAGIC\|~~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 a full table of contents. '''Before using this template, consider whether and why it would be helpful to readers and other editors.'''		This template inserts a Table of Contents that omits subheadings beyond a certain depth. The table obeys the same layout rules as the <nowiki>__TOC__</nowiki> 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 a full table of contents. '''Before using this template, consider whether and why it would be helpful to readers and other editors.'''

	=== Usage ===		=== Usage ===
Line 75:		Line 75:
	<includeonly>{{Sandbox other\|\|		<includeonly>{{Sandbox other\|\|
	<!-- Categories go below this line, please; interwikis go to Wikidata, thank you! -->		<!-- Categories go below this line, please; interwikis go to Wikidata, thank you! -->
	~~[[Category:Wikipedia table of contents templates\|{{PAGENAME}}]]~~

	}}</includeonly>		}}</includeonly>

Deleted User: Created page with "{{Documentation subpage}} {{Uses TemplateStyles|Template:TOC limit/styles.css}} {{High-use| 15719 }} This template inserts a Table of Contents that omits subheadings beyond a certain depth. The table obeys the same layout rules as the TOC magic word. Omitted sections still have section edit links in the..."

2022-03-27T22:27:24Z

Created page with "{{Documentation subpage}} {{Uses TemplateStyles|Template:TOC limit/styles.css}}  {{High-use| 15719 }} This template inserts a Table of Contents that omits subheadings beyond a certain depth. The table obeys the same layout rules as the <nowiki>__TOC__</nowiki> magic word. Omitted sections still have section edit links in the..."

New page

{{Documentation subpage}}
{{Uses TemplateStyles|Template:TOC limit/styles.css}}

{{High-use| 15719 }}
This template inserts a Table of Contents that omits subheadings beyond a certain depth. The table obeys the same layout rules as the <nowiki>__TOC__</nowiki> [[WP:MAGIC|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 a full table of contents. '''Before using this template, consider whether and why it would be helpful to readers and other editors.'''

=== Usage ===

{{tlx|TOC limit}} or {{tlx|TOC limit|3}}

The template defaults to including second- and third-level headings, e.g. those numbered "1" and "1.1" in the TOC. (Note: {{tlx|TOC limit|1}} does nothing: the first-level heading on a page is, by default, the page title.)

You can specify a different limit by adding a header level:

{{tlx|TOC limit|4}}

4 allows for fourth-level headings, e.g. "1.1.1", but omits any subheadings below that from the TOC.

The template works by hiding the lower levels with CSS. See [[Template:TOC limit/styles.css]].

=== TOC levels versus wikitext header levels ===
The heading levels in the TOC normally correspond to the header levels in the wikitext, so a "== Level-2 header ==" will normally generate the first-level ("1") TOC headings, a "=== Level-3 header ===" will normally generate the second-level ("1.1") TOC headings, and so on. This correspondence does ''not'' hold if the page contains "= Level-1 headers =" or skips header levels. For example, wikitext like this:
== Level-2 heading (A) ==
=== Level-3 heading (B) ===
== Level-2 heading (C) ==
====== Level-6 heading (D) ======
= Level-1 heading (E) =
== Level-2 heading (F) ==
=== Level-3 heading (G) ===
will generate a TOC like this:
{| class="toc"
|<div style="text-align:center">Contents</div>
<ul>
<li class="toclevel-1 tocsection-1">1 Level-2 heading (A)<ul>
<li class="toclevel-2 tocsection-2">1.1 Level-3 heading (B)</li>
</ul></li>
<li class="toclevel-1 tocsection-1">2 Level-2 heading (C)<ul>
<li class="toclevel-2 tocsection-2">2.1 Level-6 heading (D)</li>
</ul></li>
<li class="toclevel-1 tocsection-1">3 Level-1 heading (E)<ul>
<li class="toclevel-2 tocsection-2">3.1 Level-2 heading (F)<ul>
<li class="toclevel-3 tocsection-3">3.1.1 Level-3 heading (G)</li>
</ul></li>
</ul></li>
</ul>
|}
Using <code><nowiki>{{TOC limit}}</nowiki></code> on this page ''would not'' hide header D, because even though it is a level-6 heading it is shown at the second level in the TOC. And it ''would'' hide header G even though it is a level-3 heading just like header B, because header G is shown at the third level in the TOC while header B is shown at the second level.

=== Conflicts ===
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.

Due to the way the TOC is generated with MobileFrontend (mobile/tablet view) this template does not currently affect how the mobile TOC is displayed.

== TemplateData ==
<templatedata>
{
"params": {
"1": {
"aliases": [
"limit"
],
"label": "Limit",
"description": "Maximum header depth to be included in table of contents",
"default": "3",
"suggested": true,
"type": "number"
}
},
"description": "Inserts a Table of Contents that omits subheadings beyond a certain depth"
}
</templatedata>

==See also==
{{tl|TOC hidden}}
<includeonly>{{Sandbox other||

[[Category:Wikipedia table of contents templates|{{PAGENAME}}]]

}}</includeonly>

Template:TOC limit/doc - Revision history

Deleted User at 00:18, 15 October 2022