Predloga:TOC top/dok

Iz Wikipedije, proste enciklopedije
Jump to navigation Jump to search

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[uredi kodo]

Please note that this is solely for ease of maintaining existing templates. Please do not use this to write new templates: instead, browse through KAtegorija:Predloge-kazala 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)[uredi kodo]

title
The title to use for this ToC element. The default is Vsebina.
align
Sets the CSS float and clear properties, which forces this float underneath the side specified with this attribute. So, align=right will place the element after all the right floating elements before it. Options are left, right, center, or none (default).
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 |clear=none to allow other floating elements to float next to the table of contents, and |clear=both to force the table of contents to have nothing next to it.
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.

TemplateData[uredi kodo]

This is used to create custom table of contents templates. It replaces and suppresses the ToC that the wiki software would automatically generate.

Template parameters

ParameterDescriptionTypeStatus
Titletitle

The title to use for this ToC element. The default is Contents.

Stringoptional
Alignalign

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

Stringoptional
Clearclear

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.

Stringoptional
Primaryprimary

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.

Stringoptional

See also[uredi kodo]