Template:TOC left/doc: Difference between revisions

From Official Kodi Wiki
Jump to navigation Jump to search
(+vi:)
No edit summary
(42 intermediate revisions by 33 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 -->
 
== Purpose ==
 
&#123;&#123;[[template:TOCleft|TOCleft]]&#125;&#125;
 
This template 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, 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.
=== Parameters (optional) ===


== Example and 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>.


{{TOCleft}}
;width: Set the CSS width.
← look to the left


Maybe be used with a <code>{{[[Template:-|-]]}}</code> as to prevent images colliding with the TOC.
;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]].


Note that this template should not be used when the result is to place the TOC in a visually poor location. A TOC that crosses a section division is probably a poor idea, if that can be avoided.
* 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.


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.
==See also==
 
* {{tl|TOC right}}
An MOS entry on when to use this template, and the parallel template {{tl|TOCright}} would probably be a good idea. A discussion is now (as of 7 July 2005) in progress at [[Wikipedia_talk:Manual_of_Style#Template:TOCright]].
:''Now archived at [[Wikipedia_talk:Manual_of_Style--Archive_17#Template:TOCright]].'' [[User:Hairy Dude|Hairy Dude]] 21:43, 27 February 2007 (UTC)
 
In general, it is probably better to insert {{tl|TOCleft}} after the lead section, or at least the first paragraph.
 
== History ==
 
*Template & Documented 5 July 2005 by [[User:DESiegel]]
*Created in response to the discussion of TOCright on TfD and elsewhere.
*Changed style statement to match what would be seen for a floating image, which uses the "thumb tleft" classes. 7 July 2005 by [[User:Moverton|Mike]]


<includeonly>
<includeonly>
<!-- ADD CATEGORIES BELOW THIS LINE -->
[[Category:Formatting templates]]
[[Category:TOC templates|{{PAGENAME}}]]
 
<!-- ADD INTERWIKIS BELOW THIS LINE -->
 
[[be:Шаблён:Зьмест зьлева]]
[[uk:Шаблон:Зміст ліворуч]]
[[fi:Malline:TOCvasen]]
[[ru:Шаблон:Содержание слева]]
[[vi:Tiêu bản:Mục lục bên trái]]
</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