Template:TOC left/doc: Difference between revisions

From Official Kodi Wiki
Jump to navigation Jump to search
(→‎Cautions: +add something about narrow screens and not aligning it with infoboxes!)
No edit summary
(29 intermediate revisions by 23 users not shown)
Line 1: Line 1:
<includeonly>{{template doc page transcluded}}</includeonly><noinclude>{{template doc page viewed directly}}</noinclude>
{{tl|TOC left}} forces the auto-generated "Table of Contents" for a page to appear in a table that is floated to the left side of the page (as seen left), in order to improve page layout.
<!-- EDIT TEMPLATE DOCUMENTATION BELOW THIS LINE -->
 
{{TOCleft}}
== 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.


== Usage ==
== Usage ==
Insert <code>&#123;&#123;TOC left&#125;&#125;</code> at the point in the page where you want the top of the Table of Contents box to appear. Use with {{tl|-}} or {{tl|clear}} to prevent collision with text; use the '''clear''' parameter (see below) to prevent collision with images.


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.
=== Parameters (optional) ===


== Cautions ==
;clear : Sets the [[w:Cascading Style Sheets|CSS]] clear property, which forces this float underneath the side specified with this attribute. So, <code>clear=left</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>.


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.
;width: Set the CSS width.


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).
;limit:  Limits the depth of subheadings shown.  For instance using <code>limit=4</code> will hide the fourth level and deeper subheadings in the hierarchy.  And <code>limit=2</code> will hide all subheadings leaving only the main headings. This is implemented as a CSS class in the [[MediaWiki:Common.css]].
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.
* Avoid placing the TOC in a visually poor location.  Crossing a section division is probably a poor idea.
* 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==
 
* {{tl|TOC right}}
==See Also==
 
* {{Lts|TOCright}}


<includeonly>
<includeonly>
<!-- ADD CATEGORIES BELOW THIS LINE -->
[[Category:Formatting templates]]
[[Category:TOC templates| ]]
 
<!-- ADD INTERWIKIS BELOW THIS LINE -->
[[de:Vorlage:TOCleft]]
[[fi:Malline:TOCvasen]]
[[fr:Modèle:Sommaire à gauche]]
[[id:Templat:TOCleft]]
[[it:Template:TOCleft]]
[[ko:틀:TOCleft]]
[[ms:Templat:TOCkiri]]
[[nn:Mal:TOC left]]
[[pt:Predefinição:TOC-esquerda]]
[[ro:Format:TOCleft]]
[[ru:Шаблон:Содержание слева]]
[[simple:Template:TOCleft]]
[[sl:Predloga:TOCleft]]
[[sv:Mall:TOCleft]]
[[tr:Şablon:TOCsol]]
[[uk:Шаблон:Зміст ліворуч]]
[[vi:Tiêu bản:Mục lục bên trái]]
[[zh:Template:TOCleft]]
</includeonly>
</includeonly>

Revision as of 10:18, 27 June 2013

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

Usage

Insert {{TOC left}} at the point in the page where you want the top of the Table of Contents box to appear. Use with {{-}} or {{clear}} to prevent collision with text; use the clear parameter (see below) to prevent collision with images.

Parameters (optional)

clear
Sets the CSS clear property, which forces this float underneath the side specified with this attribute. So, clear=left (which is the default) will place the element after all the right floating elements before it. Options are left, right, both, or none.
width
Set the CSS width.
limit
Limits the depth of subheadings shown. For instance using limit=4 will hide the fourth level and deeper subheadings in the hierarchy. And limit=2 will hide all subheadings leaving only the main headings. This is implemented as a CSS class in the MediaWiki:Common.css.
  • Avoid placing the TOC in a visually poor location. Crossing a section division is probably a poor idea.
  • If the TOC is floated left of a bulleted list, the bullets will be hidden.

See also


Retrieved from "https://kodi.wiki/index.php?title=Template:TOC_left/doc&oldid=60095"