Template:TOC right: Difference between revisions
Jump to navigation
Jump to search
(allow a limit to be given on header level in the TOC) |
({{pp-template|small=yes}}, {{documentation}}) |
||
Line 2: | Line 2: | ||
| __TOC__ | | __TOC__ | ||
|}<noinclude> | |}<noinclude> | ||
{{{{ | {{pp-template|small=yes}} | ||
{{documentation}} | |||
<!-- Add cats and interwikis to the /doc subpage, not here! --> | <!-- Add cats and interwikis to the /doc subpage, not here! --> | ||
</noinclude> | </noinclude> |
Revision as of 22:41, 9 November 2007
[edit] Template documentation
NOTICE: This is a documentation subpage for Template:TOC right: It contains usage information, categories and other content that is not part of the original template page. |
The {{TOC right}} template forces the auto-generated Table of Contents for a page to appear in a table that is floated to the right side of the page, in order to improve page layout.
Usage
Insert {{TOC right}} at the point in the page where you want the top of the Table of Contents box to appear. Use with {{-}} or {{Clear}} to prevent collision with text; use the clear attribute (see below) to prevent collision with images.
- 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.
Parameters (optional)
- clear {{Defn|defn=Sets the CSS clear property, which forces this float underneath the side specified with this attribute. So,
- width
- Set the CSS width.
- limit
- Limits the depth of subheadings shown. For instance, using
|limit=4
will hide the fourth level and deeper subheadings in the hierarchy. And|limit=2
will hide all subheadings, leaving only the main headings. This is implemented as a CSS class in the MediaWiki:Common.css.
|clear=right
(which is the default) will place the element underneath all the right-floating elements before it. Valid values for |clear=
are: left
, right
, both
, or none
.
See also
- {{TOC left}}