Template:TOC right/doc

Usage
TOC right forces the auto-generated Table of Contents for an article to appear floated to the right side of the page, in order to improve article layout.

Insert  at the point in the article where you want the top of the Table of Contents box to appear. This should usually be after the text of the lead section, and just before the first section heading, in accordance with Lead section. Use with - or clear to prevent collision with text; use the clear parameter (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.

Parameters (optional)

 * clear: Sets the CSS clear property, which forces this float underneath the side specified with this attribute. So,  (which is the default) will place the element after all the right floating elements before it. Options are ,  ,  , or.


 * width: Set the CSS width.


 * limit: Limits the depth of subheadings shown. For instance using  will hide the fourth level and deeper subheadings in the hierarchy. And   will hide all subheadings leaving only the main headings. This is implemented as a CSS class in the MediaWiki:Common.css.

Cautions
Do not use this template to just force word wrap around the TOC, as this is 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.

Do not place this template so that the TOC aligns with a large image or infobox; this breaks the layout on narrow screens (even users with screens as wide as 1024px wide can have problems). Also, a TOC that crosses a section division is probably a poor idea, if that can be avoided.

Unless the section in which the TOC right is placed is long enough, the result may well be undesirable.

It should only be used in cases where the TOC gets in the way of other content or is detrimental to the layout of the page; it should not simply be used for aesthetics since it tampers with the standard appearance of articles. See Help:Section for further guidelines.

Attribution
Template and documentation from: https://en.wikipedia.org/w/index.php?title=Template:TOC_right&oldid=521430153