Template:TOC left: Difference between revisions
Jump to navigation
Jump to search
(Use {{documentation}}) |
(made change per talk request) |
||
Line 2: | Line 2: | ||
| __TOC__ | | __TOC__ | ||
|}<noinclude> | |}<noinclude> | ||
{{pp-template|small=yes}} | |||
{{documentation}} | {{documentation}} | ||
</noinclude> | </noinclude> |
Revision as of 02:24, 28 October 2008
[edit] Template documentation
NOTICE: This is a documentation subpage for Template:TOC left: It contains usage information, categories and other content that is not part of the original template page. |
The {{TOC left}} template forces the auto-generated "Table of Contents" for a page to appear in a table that is floated to the left side of the page (as seen left), in order to improve page layout.
Usage
Insert {{TOC left}} 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
- Sets the CSS clear property, which forces this float underneath the side specified with this attribute. So,
|clear=left
(which is the default) will place the element underneath all the left-floating elements before it. Valid values for this parameter are:left
,right
,both
, ornone
. - 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, while|limit=2
will hide all subheadings, leaving only the main headings. This is implemented as a CSS class in the MediaWiki:Common.css.
See also
- {{TOC right}}