Template:TOC right/sandbox

This is the template sandbox page for Template:TOC right (diff).
See also the companion subpage for test cases.

Template documentation[view] [edit] [history] [purge]

This template is used on approximately 49,000 pages and changes may be widely noticed. Test changes in the template's /sandbox or /testcases subpages, or in your own user subpage. Consider discussing changes on the talk page before implementing them.

This template does not work properly in the Vector 2022 skin. Read the documentation for an explanation.

Shortcuts

This template uses TemplateStyles:

{{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. Since the Vector 2022 skin forces the table of contents into a sidebar or a pop-up menu, this template does not control the placement of the TOC in that skin.

Usage

Insert {{TOC right}} 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 MOS:LEADELEMENTS. 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.

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.

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#Floating the TOC for further guidelines.

TemplateData

This is the TemplateData for this template used by TemplateWizard, VisualEditor and other tools. See a monthly parameter usage report for Template:TOC right in articles based on its TemplateData.

TemplateData for TOC right

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

Template parameters[Edit template data]
This template prefers inline formatting of parameters.
Parameter		Description	Type	Status
Clear	`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 are left, right, both, or none.	String	optional
Limit	`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	Number	optional
Width	`width` `1`	Overrides the CSS width	Unknown	optional