Template:TOC left/doc: Difference between revisions
Jump to navigation
Jump to search
No edit summary |
No edit summary |
||
(7 intermediate revisions by 3 users not shown) | |||
Line 1: | Line 1: | ||
{{tl|TOC left}} 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 <code>{{TOC left}}</code> at the point in the page where you want the top of the Table of Contents box to appear. Use with {{tl|-}} or {{tl|clear}} to prevent collision with text; use the '''clear''' parameter (see below) to prevent collision with images. | ||
{{tl| | |||
== | === Parameters (optional) === | ||
;clear : Sets the [[w:Cascading Style Sheets|CSS]] clear property, which forces this float underneath the side specified with this attribute. So, <code>clear=left</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]]. | |||
* 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== | ==See also== | ||
* {{ | * {{tl|TOC right}} | ||
<includeonly> | <includeonly> | ||
[[Category:Formatting templates]] | |||
[[Category: | |||
</includeonly> | </includeonly> |
Revision as of 10:18, 27 June 2013
{{TOC left}} 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 parameter (see below) to prevent collision with images.
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 after all the right floating elements before it. Options areleft
,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. Andlimit=2
will hide all subheadings leaving only the main headings. This is implemented as a CSS class in the MediaWiki:Common.css.
- 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
- {{TOC right}}