Template:TOCright/doc - Revision history

Logmanoriginal: Mark as documentation subpage

2024-08-01T16:26:13Z

Mark as documentation subpage

Michael_Aivaliotis at 08:16, 8 October 2007

2007-10-08T08:16:44Z

Michael_Aivaliotis at 08:13, 8 October 2007

2007-10-08T08:13:25Z

Michael_Aivaliotis: New page:
''The template documentation below is transcluded from doc}}}''
2007-10-01T01:31:00Z

New page: <includeonly><div class="notice" id="disambig">''The template documentation below is transcluded from [[{{NAMESPACE}}:TOCright/{{{1|doc}}}]]'' <small...

New page
<includeonly><div class="notice" id="disambig">''The template documentation below is [[LabVIEW_Wiki:Transclusion|transcluded]] from [[{{NAMESPACE}}:TOCright/{{{1|doc}}}]]'' <small>[<span class="plainlinks">[{{fullurl:{{NAMESPACEE}}:TOCright/{{{1|doc}}}|action=edit}} edit]</span>]</small></div>[[Category:Template documentation|{{PAGENAME}}]]</includeonly><noinclude><center>
{| class="messagebox" style="width:80%; border:1px solid #c0c090; background:#f8eaba; margin:2px 4px 2px 4px;"
|- style="vertical-align:top;"
|align="center" style="width:60px; padding:1ex;"| [[Image:Edit-paste.png|none|40px]]
| '''This is the template documentation page {{#if:{{{1|}}}|{{{1}}}|for [[{{NAMESPACE}}:TOCright]].}}'''<br/><hr/>This page is not necessarily intended to be viewed directly. If it uses [[Help:Variable|variable]]s, some links may appear broken. Do not replace these variables with hardcoded page names or URLs.
|}<br/><hr/>
</center>
[[Category:Template documentation|{{PAGENAME}}]]</noinclude>


# {{tl|TOCright}} forces the auto-generated Table of Contents for an article to appear in a table that is floated to the right side of the page (as seen right), in order to improve article layout.
# {{tl|TOCnestright}} Operates similarly, but is designed to use early in introduction or second sections on the many pages having a lot of images or wikitable elements such as infoboxes dominating the right side of such pages. '''TOCnestright''' will drift up against such constructs allowing text wrapping above, left and below preventing discordantly ugly page breaks and large excessive whitespace gaps on the page as given by the default TOC.

== Usage ==

Insert <code>{{{{BASEPAGENAME}}}}</code> at the point in the article where you want the top of the Table of Contents box to appear. Use with {{tl|-}} or {{tl|clear}} to prevent coalition with text or use {{tl|clearleft}} or {{tl|clearright}} to prevent images coalitions.

== Parameters (optional) ==

;clear : Sets the CSS clear property, which forces this float underneath the side specified with this attribute. So, <code>clear=right</code> (which is the default) will place the element after all the right floating elements before it. Options are <code>left</code>, <code>right</code>, <code>both</code>, or <code>none</code>.

;width: Set the CSS width.

;limit: Limits the depth of subheadings shown. For instance using <code>limit=4</code> will hide the fourth level and deeper subheadings in the hierarchy. And <code>limit=2</code> will hide all subheadings leaving only the main headings. This is implemented as a CSS class in the [[MediaWiki:Common.css]].

== Cautions ==
* Avoid placing the TOC in a visually poor location. Crossing a section division is probably a poor idea.
* If the TOC is floated left of a bulleted list, the bullets will be hidden.

==See also==
* {{Lts|TOCleft}}

<includeonly>

[[Category:Templates|{{PAGENAME}}]]
</includeonly>