Character Vault
Any Concept / Any System
Your System Come To Life
Roll20 for Android
Streamlined for your Tablet
Roll20 for iPad
Streamlined for your Tablet

Personal tools

Difference between revisions of "Template:Toclimit"

From Roll20 Wiki

Jump to: navigation, search
(Created page with "{{toc|limit={{{1}}}|align={{{align|}}}}} <noinclude>{{documentation}}</noinclude>")
Line 1: Line 1:

Latest revision as of 08:20, 29 July 2016

[view] [edit] [history] [purge] Documentation icon Template documentation

Limits the auto-generated Table of Contents for an article to exclude some section headings.

[edit] 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.

[edit] Parameters (optional)

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.
Set the CSS width.
Float the table of contents to the left or right

[edit] 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.

[edit] See also