Difference between revisions of "Template:Toclimit/doc"
From Roll20 Wiki
(Created page with "{{documentation subpage|override=toclimit/doc|Toclimit}} Limits the headers visible in the table of contents <includeonly>Category:Utility Templates</includeonly>") |
|||
| Line 1: | Line 1: | ||
{{documentation subpage|override=toclimit/doc|Toclimit}} | {{documentation subpage|override=toclimit/doc|Toclimit}} | ||
| − | Limits the | + | Limits the auto-generated Table of Contents for an article to exclude some section headings. |
| + | |||
| + | == Usage == | ||
| + | Insert {{tlx|toclimit|''limit''}} 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. Use the clear parameter (see below) to prevent collision with images. The ''limit'' parameter is the maximum heading level that should be included in the contents. | ||
| + | |||
| + | * Avoid placing the TOC in a visually poor location. Crossing a section division is probably a poor idea. | ||
| + | |||
| + | === Parameters (optional) === | ||
| + | ;clear: Sets the [[wikipedia:Cascading Style Sheets|CSS]] clear property, which forces this float underneath the side specified with this attribute. So, <code>clear=right</code> (which is the default) will place the element after all the right floating elements before it. Options are <code>left</code>, <code>right</code>, <code>both</code>, or <code>none</code>. | ||
| + | ;width: Set the CSS width. | ||
| + | ;align: Float the table of contents to the left or right | ||
| + | |||
| + | == Cautions == | ||
| + | Do not use this template to just force word wrap around the TOC, as this is inappropriate method of achieving this. | ||
| + | |||
| + | 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 TOC that crosses a section division is probably a poor idea, if that can be avoided. | ||
| + | |||
| + | Unless the section in which the {{tl|toclimit}} is placed is long enough, the result may well be undesirable. | ||
| + | |||
| + | It should only be used in cases where the TOC 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. | ||
| + | |||
| + | == See also == | ||
| + | * {{tl|tocright}} | ||
| + | * {{tl|tocleft}} | ||
| + | * {{tl|toc}} | ||
<includeonly>[[Category:Utility Templates]]</includeonly> | <includeonly>[[Category:Utility Templates]]</includeonly> | ||
Revision as of 04:46, 29 July 2016
 |
This is a documentation subpage for Toclimit. It contains usage information, categories and other content that is not part of the original template page. |
Limits the auto-generated Table of Contents for an article to exclude some section headings.
Contents |
Usage
Insert {{toclimit|limit}} 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. Use the clear parameter (see below) to prevent collision with images. The limit parameter is the maximum heading level that should be included in the contents.
- Avoid placing the TOC in a visually poor location. Crossing a section division is probably a poor idea.
Parameters (optional)
- 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 areleft,right,both, ornone. - width
- Set the CSS width.
- align
- Float the table of contents to the left or right
Cautions
Do not use this template to just force word wrap around the TOC, as this is inappropriate method of achieving this.
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 TOC that crosses a section division is probably a poor idea, if that can be avoided.
Unless the section in which the {{toclimit}} is placed is long enough, the result may well be undesirable.
It should only be used in cases where the TOC 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.
