Template:TOCright/doc
 | This is a documentation subpage for Template:TOCright. It contains usage information, categories and other content that is not part of the original template page. |
- {{TOCright}} forces the auto-generated Table of Contents for an article to appear in a table that is floated to the right side of the page (as seen right), in order to improve article layout.
- {{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. TOCnestright 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.
- When using the TOCnestright template logout and check that it appears correctly with the default skin in Internet Explorer and a Acid2 compatible browser (or Firefox).
Usage
Insert {{TOCright}} at the point in the article 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=right(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=4will hide the fourth level and deeper subheadings in the hierarchy. Andlimit=2will 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.
Related pages