Template:Big toc/doc: Difference between revisions

From Tardis Wiki, the free Doctor Who reference
m (Protected "Template:Big toc/doc": Robot: Protecting all pages from category templates (‎[edit=sysop] (indefinite) ‎[move=sysop] (indefinite)))
Line 6: Line 6:
</pre>
</pre>
== No longer necessary ==
== No longer necessary ==
<div style="color:red">'''Please note that as of 28th February 2011 this template is effectively deprecated.'''</div>  Its functionality is now a part of our CSS style sheet, and therefore happens automatically.  '''This template should no longer be used in the main namespace — that is, on "regular" articles.'''
<div style="color:red">'''Please note that as of 28th February 2011 this template is mostly deprecated.'''</div>  The original aim of the template was to forcibly move TOCs to the right side of a page.  Since our CSS now does that automatically, there's not much of a need to use this template.


Nevertheless, in other namespaces, you ''may'' wish to use this template when you have a page with less than the minimum number of sections to trigger an automatic TOC.  This is especially useful in '''forum conversations''', where very ''long'' discussions typically have very ''few'' sections.  If you put {{tl|big toc}} at the top of the forum page, you'll get a bit of navigational help that the system otherwise wouldn't provide.  
You will occasionally see it in use on pages that have lead sections that are longer than the infobox, in order to bring the TOC up higher on the page. But it shouldn't be used on pages with moderate-to-small-sized leads.  Nor should it be used in the main [[namespace]] to create a TOC on a short page. If an ''article'' has only two sections, for example, it doesn't deserve a TOC. A TOC shouldn't extend lower than the last line of the article text.
 
'''To reiterate, however, please don't use with normal articles in the main namespace.''' If an ''article'' has only two sections, for example, it doesn't deserve a TOC.
<noinclude>[[category:template documentation|{{PAGENAME}}]]</noinclude>
<noinclude>[[category:template documentation|{{PAGENAME}}]]</noinclude>

Revision as of 15:46, 6 January 2014

Big toc/doc tames those massively long tables of content that can sometimes arise on this wiki. Whereas an unmodified TOC will simply put a division between the lead paragraph(s) and the "meat" of the article, using this template will tuck it away neatly on the right-hand side of the page. It is sized to fit seamlessly underneath infoboxes that have pictures sized to 250px. To use, just put immediately after the closing brackets of an infobox and before the first word of the lead. Alternately, if the article has no infobox, just place at before the first word of the lead.

For example:

{|infobox|}{{big toc}}'''Article name''' is . . . 

No longer necessary

Please note that as of 28th February 2011 this template is mostly deprecated.

The original aim of the template was to forcibly move TOCs to the right side of a page. Since our CSS now does that automatically, there's not much of a need to use this template.

You will occasionally see it in use on pages that have lead sections that are longer than the infobox, in order to bring the TOC up higher on the page. But it shouldn't be used on pages with moderate-to-small-sized leads. Nor should it be used in the main namespace to create a TOC on a short page. If an article has only two sections, for example, it doesn't deserve a TOC. A TOC shouldn't extend lower than the last line of the article text.