Template:Tocright/doc: Difference between revisions

Help

Revision as of 13:25, 27 May 2013

	This page contains usage information for [[{{#sub:Template:Tocright/doc\|0\|{{#rpos:Template:Tocright/doc\|/doc}}}}]].

Template for manipulating the table of contents (TOC) of an article: a maximum level for shown headlines can be specified, and the TOC can be aligned to the left/right of an article (with text flowing around it).

Usage

Simply place the following where you want the TOC to appear:

{{TOC}}

Parameters

{{#replace:{{#replace:{{#replace:{{#replace:<unnamed 1> // float|| }}| >> | up to }}| // | or }}| ++ |, }}

Specifies alignment of the TOC; sets CSS "float" (and "clear") attribute for the box.

Available options:

left: TOC will be aligned to the left, and text will flow around it on the right.
right: TOC will be aligned to the right, and text will flow around it on the left.

{{#replace:{{#replace:{{#replace:{{#replace:limit|| }}| >> | up to }}| // | or }}| ++ |, }}

If specified, subheadings with a level lower than limit will not be shown in the TOC. For example, with limit set to 3, only headings up to level 3 (===) will be displayed. Usually used for articles with a lot of subheadings in order to downsize the TOC.

Technical

Lower level headlines are hidden via CSS. See MediaWiki:Common.css.

@@ Line 1: / Line 1: @@
-;Description
+<noinclude>{{Documentationpage}}</noinclude>
-:This template will float the article's table of contents to the right. It will also force a ToC when/where it would not normally be found.
+Template for manipulating the table of contents (TOC) of an article: a maximum level for shown headlines can be specified, and the TOC can be aligned to the left/right of an article (with text flowing around it).
-:Use it only when needed.
-;Syntax
-:Type <code>{{t|tocright}}</code>
-<includeonly>[[Category:General wiki templates|{{PAGENAME}}]]</includeonly><noinclude>[[Category:Template documentation|{{PAGENAME}}]]</noinclude>
+==Usage==
+Simply place the following where you want the TOC to appear:
+<pre>{{TOC}}</pre>
+===Parameters===
+{{Docparam|name=<unnamed 1> // float|req=no|default=|desc=
+Specifies alignment of the TOC; sets [[wikipedia:Cascading Style Sheets|CSS]] "float" (and "clear") attribute for the box.
+Available options:
+* ''left'': TOC will be aligned to the left, and text will flow around it on the right.
+* ''right'': TOC will be aligned to the right, and text will flow around it on the left.
+}}
+{{Docparam|name=limit|req=no|default=|desc=
+If specified, subheadings with a level lower than <code>limit</code> will not be shown in the TOC. For example, with <code>limit</code> set to 3, only headings up to level 3 (<code>===</code>) will be displayed. Usually used for articles with a lot of subheadings in order to downsize the TOC.
+}}
+==Technical==
+* Lower level headlines are hidden via CSS. See [[MediaWiki:Common.css]].
+<includeonly>[[ja:Template:TOC]]</includeonly>