Difference between revisions of "Template:TOC right/doc"
m |
m |
||
| Line 5: | Line 5: | ||
Insert {{tlc|TOC right}} at the point in the article where you want the top of the table of contents box to appear. This should usually be after the text of the lead section, and just before the first section heading, in accordance with [[Kompas Productions:Summertime Saga Wiki:Manual of Style|Summertime Saga Wiki manual of style]]. Use with {{tl|clear}} to prevent collision with text; use the {{para|clear}} parameter (see below) to prevent collision with images. | Insert {{tlc|TOC right}} at the point in the article where you want the top of the table of contents box to appear. This should usually be after the text of the lead section, and just before the first section heading, in accordance with [[Kompas Productions:Summertime Saga Wiki:Manual of Style|Summertime Saga Wiki manual of style]]. Use with {{tl|clear}} to prevent collision with text; use the {{para|clear}} parameter (see below) to prevent collision with images. | ||
| − | Do not place this template so that the TOC aligns with a large image or infobox; this breaks the layout on narrow screens (even users with screens as wide as 1024px wide can have problems). Also, a table of | + | Do not place this template so that the TOC aligns with a large image or infobox; this breaks the layout on narrow screens (even users with screens as wide as 1024px wide can have problems). Also, a table of contents that crosses a section division is probably a poor idea, if that can be avoided. |
Unless the section in which the {{tlc|TOC right}} is placed is long enough, the result may well be undesirable. | Unless the section in which the {{tlc|TOC right}} is placed is long enough, the result may well be undesirable. | ||
| − | It should only be used in cases where the table of | + | It should only be used in cases where the table of contents gets in the way of other content or is detrimental to the layout of the page; it should {{em|not}} simply be used for aesthetics since it tampers with the standard appearance of articles. |
== Parameters == | == Parameters == | ||
Revision as of 17:13, 20 July 2020
The template Template:Tl 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.
Usage
Insert Template:Tlc at the point in the article where you want the top of the table of contents box to appear. This should usually be after the text of the lead section, and just before the first section heading, in accordance with Summertime Saga Wiki manual of style. Use with Template:Tl to prevent collision with text; use the |clear= parameter (see below) to prevent collision with images.
Do not place this template so that the TOC aligns with a large image or infobox; this breaks the layout on narrow screens (even users with screens as wide as 1024px wide can have problems). Also, a table of contents that crosses a section division is probably a poor idea, if that can be avoided.
Unless the section in which the Template:Tlc is placed is long enough, the result may well be undesirable.
It should only be used in cases where the table of contents gets in the way of other content or is detrimental to the layout of the page; it should not simply be used for aesthetics since it tampers with the standard appearance of articles.
Parameters
|width=- Sets the CSS width.
|limit=- Limits the depth of subheadings shown. For instance, using
|limit=4will hide the fourth level and deeper subheadings in the hierarchy. And|limit=2will hide all subheadings leaving only the main headings. This works by hiding the lower levels with CSS.
|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.