Template:TOC navbar/doc
 | This template uses TemplateStyles: |
 | Text has been copied to or from this page; see the list below. The source pages now serve to provide attribution for the content in the destination pages and must not be deleted so long as the copies exist. For attribution and to access older versions of the copied text, please see the history links below.
|
{{TOC navbar}} forces the auto-generated Table of Contents for an article to appear centered in the middle of the page.
Usage
Insert {{TOC navbar}} at the point in the article where you want the top of the Table of Contents to appear. Use with {{-}} or {{clear}} to prevent collision with text; use the clear parameter (see below) to prevent collision with images.
- width
- Set the CSS width.
- limit (currently non-functional)
- 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 works by hiding the lower levels with CSS. See Template:TOC limit/styles.css.
It should not be used in cases where a standard TOC is acceptable for the layout of the page; it should only be used for aesthetics on pages such as WikiProjects. See Help:Section#Floating the TOC for further guidelines.
{{TOC navbar}} 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.
| 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 |
See also
References
All code and text modified from: Template:TOC right(edit talk links history)