View source for Template:TOC top/doc

<noinclude>{{Documentation subpage}}</noinclude>
<!-- Place categories where indicated at the bottom of this page and interwikis at Wikidata (see [[Wikipedia:Wikidata]]) -->


This is used to create custom table of contents templates such as {{tl|list TOC}}. It replaces and suppresses the ToC that the wiki software would automatically generate.

== Usage ==
Please note that this is '''solely for ease of maintaining existing templates'''. Please '''do not use this to write new templates''': instead, browse through [[:Category:Category templates]] and use an existing template. This code is one of the final pieces in cleaning up years of redundant and overlapping code in this area.

=== Parameters (optional) ===
; title : The title to use for this ToC element. The default is <strong>{{MediaWiki:Toc}}</strong>.

; align : Sets the [[Cascading Style Sheets|CSS]] float and clear properties, which forces this float underneath the side specified with this attribute. So, <code>align=right</code>  will place the element after all the right floating elements before it. Options are <code>left</code>, <code>right</code>, <code>center</code>, or <code>none</code> (default).

; clear : Overrides the default [[Cascading Style Sheets|CSS]] clear property set by the align parameter, which is not typically needed.  Options are <code>left</code>, <code>right</code>, <code>both</code>, or <code>none</code>.  The defaults are <code>left</code> when {{para|align|left}}, <code>right</code> when {{para|align|right}}, <code>none</code> when {{para|align|center}}, and <code>left</code> when {{para|align|none}}.  Use {{para|clear|none}} to allow other floating elements to float next to the table of contents, and {{para|clear|both}} to force the table of contents to have nothing next to it.

; primary : Set this to <code>false</code> if this ToC is not used as the primary ToC of a page. This makes sure that the title of this ToC does not show up in the primary ToC. A side effect of this is the disappearing of the show/hide toggle.



<includeonly>
[[Category:Category templates]]
</includeonly>