Jump to content

Template:TOClimit: Difference between revisions

added note that the template doesn't do anything but is worth keeping in place on articles
m (by way of explaining why the Zukai article is mentioned)
(added note that the template doesn't do anything but is worth keeping in place on articles)
 
Line 1: Line 1:
<includeonly><div class="toclimit-{{{1|2}}}">__TOC__</div></includeonly><noinclude>Sometimes the length of a table of contents (TOC) is excessive because of the number of lower-level sections (=== and below). This template allows you to remove those lower headers from the TOC. To see how this can be useful, try previewing an edit of the [[OBD:Data types]] page after removing the call to this template, and you'll see that there are a distracting number of minor subheaders which the reader doesn't need to see; he probably only will care about clicking on a major type of data, then reading about where the various subtypes are used.
<includeonly><div class="toclimit-{{{1|2}}}">__TOC__</div></includeonly><noinclude>{{fmbox
  | text = This template used to be handy, but it does not function under the skin Vector 2022, which was made the default skin for the wiki in 2025. However please do not remove the template from any articles; it serves as a record of the articles for which we wish to manually control the TOC level. In the future this functionality may be added to MediaWiki itself as something like a magic word and we can then port the template usage over to that feature.
  }}
Sometimes the length of a table of contents (TOC) is excessive because of the number of lower-level sections (=== and below). This template allows you to remove those lower headers from the TOC. To see how this can be useful, try previewing an edit of the [[OBD:Data types]] page after removing the call to this template, and you'll see that there are a distracting number of minor subheaders which the reader doesn't need to see; he probably only will care about clicking on a major type of data, then reading about where the various subtypes are used.


On the other hand, if you simply have a lot of top-level sections (==) or you feel that the lower-level sections <u>should</u> be in the TOC, then you might want to look at the [[Template:TOCfloat|TOCfloat]] template, which will cause the article text to wrap around the TOC rather than starting after the TOC. TOCfloat also offers the same limit feature as this TOClimit template, so you can can use it to both shorten the TOC and wrap text around it.
On the other hand, if you simply have a lot of top-level sections (==) or you feel that the lower-level sections <u>should</u> be in the TOC, then you might want to look at the [[Template:TOCfloat|TOCfloat]] template, which will cause the article text to wrap around the TOC rather than starting after the TOC. TOCfloat also offers the same limit feature as this TOClimit template, so you can can use it to both shorten the TOC and wrap text around it.