Jump to content

Template:TOCfloat: Difference between revisions

apparently we need to do it like this
(guess not)
(apparently we need to do it like this)
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="{{#if:{{{nonum|usenum}}}||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>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 "nonum" parameter 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.


Note: It's important to have a grasp of proper wiki article layout, because this template includes the magic word <nowiki>__TOC__</nowiki> which determines the TOC's position within the article. This mean that, in order to preserve a standard article layout, <u>you have to place the template markup between the lede text (if there is any) and the first subheader</u> in the article. You are also expected to avoid the use of level 1 headers (=) when writing articles. The Daodan article linked above demonstrates proper layout with (1) a lede that describes the DLL briefly without the use of a section header, followed by (2) the TOCfloat template, followed by (3) the article's body with subheaders. The fact that the body is now wrapping around the TOC does not change the order of layout elements; it merely improves its appearance.
Note: It's important to have a grasp of proper wiki article layout, because this template includes the magic word <nowiki>__TOC__</nowiki> which determines the TOC's position within the article. This mean that, in order to preserve a standard article layout, <u>you have to place the template markup between the lede text (if there is any) and the first subheader</u> in the article. You are also expected to avoid the use of level 1 headers (=) when writing articles. The Daodan article linked above demonstrates proper layout with (1) a lede that describes the DLL briefly without the use of a section header, followed by (2) the TOCfloat template, followed by (3) the article's body with subheaders. The fact that the body is now wrapping around the TOC does not change the order of layout elements; it merely improves its appearance.