Template:TOCright/doc

__NOWYSIWYG__

Description

 * 1)  forces the auto-generated Table of contents (TOC) for an article to appear in a table that is floated to the right side of the page, in order to improve article layout.
 * 2) w:c:admintools:Template:TOCnestright operates similarly, but is designed to use early in introduction or second sections on the many pages having a lot of images or wikitable elements such as infoboxes dominating the right side of such pages. TOC nest right will drift up against such constructs allowing text wrapping above, left and below preventing discordantly ugly page breaks and large excessive whitespace gaps on the page as given by the default TOC.

Syntax
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 (see Elements of the lead). Use with ' or ' 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, right (which is the default) will place the element after all the right floating elements before it. Options are:
 * left
 * right
 * both
 * none


 * width : Set the CSS width.


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

Tips

 * 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.

Cautions
Do not use  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   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  is placed is long enough, the result may well be undesirable.

It should only be used in cases where a table of contents located on the left 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 Floating the TOC for further guidelines.