Template:TOC left

From mediawiki.org
Jump to navigation Jump to search
Template documentation

Purpose[edit]

{{TOC left}} forces the auto-generated "Table of Contents" for an article to appear floated to the left side of the page (as seen left), in order to improve article layout.

Usage[edit]

Insert {{TOC left}} at the point in the article where you want the top of the Table of Contents box to appear. Use with {{clear}} to prevent e.g. image collisions.

Cautions[edit]

Do not use this template to just force word wrap around the TOC, as this is an inappropriate method of achieving this. Instead add a CSS class to your current skin's .css file, which will apply site wide. Go to Special:Mypage/skin.css, which redirects to your current skin's CSS file.

Unless the section in which the {{TOC left}} is placed is long enough, the result may well be undesirable. Note particularly that if the TOC is floated left of a bulleted list, the bullets will be hidden.


See also[edit]

{{TOC left}} forces the auto-generated "Table of Contents" for an article to appear floated to the left side of the page (as seen left), in order to improve article layout.

Template parameters

This template prefers inline formatting of parameters.

ParameterDescriptionTypeStatus
Clearclear

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 are left, right, both, or none.

Stringoptional
Limitlimit

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 works by hiding the lower levels with CSS

Numberoptional
Widthwidth 1

Overrides the CSS width

Unknownoptional