20,312
edits
Template:TOCfloat: Difference between revisions
added note that the template doesn't do anything now
(apparently we need to do it like this) |
(added note that the template doesn't do anything now) |
||
| (One intermediate revision by the same user not shown) | |||
| Line 1: | Line 1: | ||
<includeonly><div style="clear:left; margin-bottom:0.5em; float:{{{side|left}}}; padding:0.5em 1.4em 0.8em 0; background:none; width:{{{width|auto}}};" class="{{#ifeq:{{{numbers}}}|no|nonumtoc}} {{#if:{{{limit|}}}|toclimit-{{{limit}}}}}">__TOC__</div></includeonly><noinclude>Especially for articles which do not need a [[wp:WP:LEDE|lede]], a long table of contents (TOC) can be visually unsettling – "Hey, where's the article? There's just this long box!" Use this template to make the TOC a floating table, so that the article text wraps around it. Now, sometimes a long TOC is the best approach, as in [[Quotes/Speech]] where we want the reader to be able to choose from the full directory of conversations in the game without any distracting text to the right. But for a more normal article like [[Daodan DLL]] it would look bad if the article didn't start until after the lengthy TOC. | <includeonly><div style="clear:left; margin-bottom:0.5em; float:{{{side|left}}}; padding:0.5em 1.4em 0.8em 0; background:none; width:{{{width|auto}}};" class="{{#ifeq:{{{numbers}}}|no|nonumtoc}} {{#if:{{{limit|}}}|toclimit-{{{limit}}}}}">__TOC__</div></includeonly><noinclude>{{fmbox | ||
| text = This template used to be handy, but it does not do anything when using a skin that puts the TOC in the lefthand margin beside the content instead of embedding the TOC in the article. This includes Vector 2022, which was made the default skin for the wiki in 2025. | |||
}} | |||
Especially for articles which do not need a [[wp:WP:LEDE|lede]], a long table of contents (TOC) can be visually unsettling – "Hey, where's the article? There's just this long box!" Use this template to make the TOC a floating table, so that the article text wraps around it. Now, sometimes a long TOC is the best approach, as in [[Quotes/Speech]] where we want the reader to be able to choose from the full directory of conversations in the game without any distracting text to the right. But for a more normal article like [[Daodan DLL]] it would look bad if the article didn't start until after the lengthy TOC. | |||
See the [[Template:TOClimit|TOClimit]] template if you just want to omit lower-level section headers from the TOC, but note that this TOCfloat template does perform the same function if you use the "limit" parameter. See the [[Template:TOCnonum|TOCnonum]] template if you just want to omit automatic numbering from the TOC, but note that TOCfloat also offers the parameter "numbers=no" for this purpose. | See the [[Template:TOClimit|TOClimit]] template if you just want to omit lower-level section headers from the TOC, but note that this TOCfloat template does perform the same function if you use the "limit" parameter. See the [[Template:TOCnonum|TOCnonum]] template if you just want to omit automatic numbering from the TOC, but note that TOCfloat also offers the parameter "numbers=no" for this purpose. | ||
| Line 9: | Line 13: | ||
*"width" — e.g., "300px" or "30%"; this works in unusual ways: you can make the TOC more narrow than it would be normally (forcing line wrap on header names that exceed that width), but if you supply a width that is greater than the "auto" width (determined by the length of the longest header name), then the TOC stays at the "auto" width, but with a whitespace margin added to the right. When you use the template's default float:left style, this margin appears between the left-aligned TOC and the article text that wraps around it, which one could use to insert a small bit of extra space for aesthetic purposes. When you supply "side=right", however, excess width is still placed to the right of the TOC, making an undesirable white area as a sort of third column after the wrapped article text and the TOC. | *"width" — e.g., "300px" or "30%"; this works in unusual ways: you can make the TOC more narrow than it would be normally (forcing line wrap on header names that exceed that width), but if you supply a width that is greater than the "auto" width (determined by the length of the longest header name), then the TOC stays at the "auto" width, but with a whitespace margin added to the right. When you use the template's default float:left style, this margin appears between the left-aligned TOC and the article text that wraps around it, which one could use to insert a small bit of extra space for aesthetic purposes. When you supply "side=right", however, excess width is still placed to the right of the TOC, making an undesirable white area as a sort of third column after the wrapped article text and the TOC. | ||
*"limit" — limits the TOC to a certain level of hierarchy; for instance, <tt><nowiki>{{TOCfloat|limit=2}}</nowiki></tt> would only show level 2 headers (==), keeping the table short. | *"limit" — limits the TOC to a certain level of hierarchy; for instance, <tt><nowiki>{{TOCfloat|limit=2}}</nowiki></tt> would only show level 2 headers (==), keeping the table short. | ||
*" | *"numbers=no" — removes automatic numbering from the TOC; this is preferable visually when the article section names themselves already start with numbers. | ||
[[Category:Basic formatting templates]] | [[Category:Basic formatting templates]] | ||
</noinclude> | </noinclude> | ||