Template:TOC top/doc
 | This is a documentation subpage for Template:TOC top. It contains usage information, categories and other content that is not part of the original template page. |
 | This template is used on many 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 is used to create custom table of contents templates such as {{list TOC}}. It replaces and suppresses the ToC that the wiki software would automatically generate.
Usage
Please note that this is solely for ease of maintaining existing templates. Please do not use this to write new templates: instead, browse through Category:PBC table of contents templates and use an existing template. This code is one of the final pieces in cleaning up years of redundant and overlapping code in this area.
Parameters (optional)
- title
- The title to use for this ToC element. The default is Contents.
- align
- Sets the CSS float and clear properties, which forces this float underneath the side specified with this attribute. So,
align=rightwill place the element after all the right floating elements before it. Options areleft,right,center, ornone(default).
- clear
- Overrides the default CSS clear property set by the align parameter, which is not typically needed. Options are
left,right,both, ornone. The defaults areleftwhen|align=left,rightwhen|align=right,nonewhen|align=center, andleftwhen|align=none. Use|clear=noneto allow other floating elements to float next to the table of contents, and|clear=bothto force the table of contents to have nothing next to it.
- primary
- Set this to
falseif this ToC is not used as the primary ToC of a page. This makes sure that the title of this ToC does not show up in the primary ToC. A side effect of this is the disappearing of the show/hide toggle.
TemplateData
See the monthly error report for this template.
TemplateData for TOC top
This is used to create custom table of contents templates. It replaces and suppresses the ToC that the wiki software would automatically generate.
| Parameter | Description | Type | Status | |
|---|---|---|---|---|
| Title | title | The title to use for this ToC element. The default is Contents. | String | optional |
| Align | align | Sets the CSS float and clear properties, which forces this float underneath the side specified with this attribute. So, "right" will place the element after all the right floating elements before it. Options are left, right, center, or none (default). | String | optional |
| Clear | clear | Overrides the default CSS clear property set by the align parameter, which is not typically needed. Options are left, right, both, or none. The defaults are left when align=left, right when align=right, none when align=center, and left when align=none. Use "none" to allow other floating elements to float next to the table of contents, and "both" to force the table of contents to have nothing next to it. | String | optional |
| Primary | primary | Set this to "false" if this ToC is not used as the primary ToC of a page. This makes sure that the title of this ToC does not show up in the primary ToC. A side effect of this is the disappearing of the show/hide toggle. | String | optional |
See also
- {{TOC bottom}}