Template:TOC left/doc: Difference between revisions

From Official Kodi Wiki
Jump to navigation Jump to search
No edit summary
Line 2: Line 2:
<!-- EDIT TEMPLATE DOCUMENTATION BELOW THIS LINE -->
<!-- EDIT TEMPLATE DOCUMENTATION BELOW THIS LINE -->


{{TOCleft}}
{{TOC left}}
== Purpose ==
== Purpose ==


{{tl|{{BASEPAGENAME}}}} forces the auto-generated Table of Contents for an article to appear in a table that is floated to the left side of the page (as seen left), in order to improve article layout.
{{tl|{{BASEPAGENAME}}}} forces the auto-generated "Table of Contents" for an article to appear in a table that is floated to the left side of the page (as seen left), in order to improve article layout.


== Usage ==
== Usage ==
Insert <code>&#123;&#123;TOCleft&#125;&#125;</code> at the point in the article where you want the top of the Table of Contents box to appear. Use with {{tl|-}} or {{tl|clear}} to prevent images coalitions.  See [[John Vanbrugh]] for a live example.
Insert <code>&#123;&#123;TOCleft&#125;&#125;</code> at the point in the article where you want the top of the Table of Contents box to appear. Use with {{tl|-}} or {{tl|clear}} to prevent images coalitions.  See [[John Vanbrugh]] for a live example.


== Cautions ==
== Cautions ==
Do not use this template to just force word wrap around the TOC, as this is inappropriate method of achieving this.  Instead add a CSS class to your monobook.css file which will apply site wide.
Do not use this template to just force word wrap around the TOC, as this is inappropriate method of achieving this.  Instead add a CSS class to your monobook.css file which will apply site wide.


Line 18: Line 16:
Also, a TOC that crosses a section division is probably a poor idea, if that can be avoided.
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|TOCleft}} is placed is long enough, the result may well be undesirable.  Note particularly that if the TOC is floated left of a bulleted list, the bullets will be hidden.
Unless the section in which the {{tl|TOC left}} is placed is long enough, the result may well be undesirable.  Note particularly that if the TOC is floated left of a bulleted list, the bullets will be hidden.


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 [[Help:Section#Floating the TOC]] for further guidelines.
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 [[Help:Section#Floating the TOC]] for further guidelines.
Line 24: Line 22:
==See Also==
==See Also==


* {{Lts|TOCright}}
* {{Lts|TOC right}}


<includeonly>
<includeonly>

Revision as of 17:17, 6 June 2009


Purpose

{{TOC left}} forces the auto-generated "Table of Contents" for an article to appear in a table that is floated to the left side of the page (as seen left), in order to improve article layout.

Usage

Insert {{TOCleft}} at the point in the article where you want the top of the Table of Contents box to appear. Use with {{-}} or {{clear}} to prevent images coalitions. See John Vanbrugh for a live example.

Cautions

Do not use this template to just force word wrap around the TOC, as this is inappropriate method of achieving this. Instead add a CSS class to your monobook.css file which will apply site wide.

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 {{TOC left}} is placed is long enough, the result may well be undesirable. Note particularly that if the TOC is floated left of a bulleted list, the bullets will be hidden.

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 Help:Section#Floating the TOC for further guidelines.

See Also