Template:TOC side

Template documentation[ view · edit · history · purge ]

This documentation is transcluded from Template:TOC side/doc.

This template displays a floating table of contents at the place it’s used. It’s similar to {{TOC right}} and {{TOC left}}, but it contains the floating side in a parameter rather than in the template name, and works on pages translated using the Translate extension into right-to-left languages as probably intended, that is, it floats to the opposite side than the one specified in parameter. This means that if the parameter is for example “right”, it will float to the “far end” of the page: to the right on pages with left-to-right script and to the left on pages with right-to-left script. Thus it’s mainly useful on pages using the Translate extension, but nothing stops one from using it on any other page.

Usage

{{TOC side |1= }}

Template parameters

 Parameter text is empty

<templatedata>JSON</templatedata> ./. {{TemplateBox}}

TemplateData

TemplateData is a way to store information about template parameters (the description of those and of the whole template) for both humans and machines. It is used by VisualEditor and possibly other tools like Upload Wizard.

---

Existing template documentation
At Wikimedia Commons, it is recommended to use {{TemplateBox}} with either ‎useTemplateData=1 or ‎useTemplateData=only on the ‎/doc subpage and transcluding it with {{Documentation}} into the template. ‎<nowiki>-tags can be wrapped around the arguments, if required, to avoid templates being expanded.

Newly created template documentation and imports
Another option, especially for imported templates, or for users with JSON experience, is placing raw ‎<templatedata>-tags into the Wikitext of the template, as described in various Wikipediae.

Discussion
There is an ongoing discussion about that matter. Feel invited to comment if you are experienced in either way, your time permits and if you like to share your opinion or to make a suggestion.

---

Wikipedia's help about TemplateData • Commons-specific information

This template displays a floating table of contents at the place it’s used. It’s similar to {{TOC right}} and {{TOC left}}, but it contains the floating side in a parameter rather than in the template name, and works on pages translated using the Translate extension into right-to-left languages as probably intended, that is, it floats to the opposite side than the one specified in parameter. This means that if the parameter is for example “right”, it will float to the “far end” of the page: to the right on pages with left-to-right script and to the left on pages with right-to-left script. Thus it’s mainly useful on pages using the Translate extension, but nothing stops one from using it on any other page.

Template parameters[Edit template data]

This template prefers inline formatting of parameters.

Parameter		Description	Type	Status
floating side	1	Side to float to on left-to-right pages; “right” or “left”. On right-to-left pages, the TOC is floated to the opposite side. Suggested values left right Default right	Line	optional
clear	clear	Whether to add clearing, i.e. force the TOC to appear below any other elements floated to the same side Default 1	Boolean	optional

Additional information

The template is intended to be used in the following namespaces: no namespace specified

The template is intended to be used by the following user groups: all users

Relies on:
{{Yesno}}

See also

• {{TOC right}}
• {{TOC left}}

Localization

This template is not intended to be localized.