19,344
edits
Template:TOCfloat: Difference between revisions
explaining "width" a bit more
(adding "side" parameter, more docs) |
(explaining "width" a bit more) |
||
| Line 2: | Line 2: | ||
Note that this template includes the magic word <nowiki>__TOC__</nowiki>, so it can also be used to reposition the TOC; if you <u>don't</u> intend to reposition it and just want it at its default location, that means <u>you have to place this template between the lede (if there is one) and the first header</u> in the article. Optional parameters: | Note that this template includes the magic word <nowiki>__TOC__</nowiki>, so it can also be used to reposition the TOC; if you <u>don't</u> intend to reposition it and just want it at its default location, that means <u>you have to place this template between the lede (if there is one) and the first header</u> in the article. Optional parameters: | ||
*"width" -- e.g., "300px" or "30%" | *"side" -- this is passed to the float property, so your only meaningful choices are "left" or "right" (default is "left") | ||
*"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 same auto-width, but with a whitespace margin. 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, <nowiki>{{TOCfloat|limit=2}}</nowiki> would only show level 2 headers (==), keeping the table short. | *"limit" -- limits the TOC to a certain level of hierarchy; for instance, <nowiki>{{TOCfloat|limit=2}}</nowiki> would only show level 2 headers (==), keeping the table short. | ||
[[Category:Basic formatting templates]] | [[Category:Basic formatting templates]] | ||
</noinclude> | </noinclude> | ||