Template:TOC right/doc
 | This is a documentation subpage for Template:TOC right. It contains usage information, categories, and other content that is not part of the original template page. |
 | This template uses TemplateStyles: |
This template 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.
| Parameter | Description | Type | Status | |
|---|---|---|---|---|
| clear side | 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”, or “none”.
| Line | optional |
| width | width 1 | Set the CSS width of the TOC box.
| Line | optional |
| TOC level limit | 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. | Number | optional |
Usage[edit]
Insert {{TOC right}} at the point 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 above) to prevent collision with images.
- Avoid placing the TOC in a visually poor location. Crossing a section division is probably a poor idea.
Cautions[edit]
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 common.css file, which will apply site wide.
Unless the section in which the {{TOC right}} is placed is long enough, the result may well be undesirable.
The limit functionality is implemented as a CSS class in MediaWiki:Common.css and does not currently work on mobile.