Template:TOC right/doc

Template page

Template:Documentation subpage

Template:Tl 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.

Usage[edit source]

Insert {{TOC right}} at the point in the page where you want the top of the Table of Contents box to appear. Use with Template:Tl or Template:Tl 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.
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. And limit=2 will hide all subheadings leaving only the main headings. This works by hiding the lower levels with CSS. See Template:TOC limit/styles.css.

Placing this template so that the TOC aligns with a large image or infobox breaks the layout on narrow screens (even users with screens as wide as 1024px wide can have problems).

Unless the section in which the Template:Tl is placed is long enough, the result may well be undesirable.


<templatedata> { "params": { "limit": { "label": "Limit", "description": "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", "type": "number" }, "clear": { "label": "Clear", "description": "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 are left, right, both, or none.", "type": "string" }, "width": { "aliases": [ "1" ], "label": "Width", "description": "Overrides the CSS width" } }, "description": "Template:TOC right forces the auto-generated \"Table of Contents\" for an article to appear floated to the right side of the page (as seen right), in order to improve article layout.", "paramOrder": [ "clear", "limit", "width" ], "format": "inline" } </templatedata>

Cookies help us deliver our services. By using our services, you agree to our use of cookies.