Template:TOC left/doc: Difference between revisions

From Official Kodi Wiki
Jump to navigation Jump to search
(+vi:)
(Deleted history section, reword parts to discourage use)
Line 2: Line 2:
<!-- EDIT TEMPLATE DOCUMENTATION BELOW THIS LINE -->
<!-- EDIT TEMPLATE DOCUMENTATION BELOW THIS LINE -->


{{TOCleft}}
== Purpose ==
== Purpose ==


&#123;&#123;[[template:TOCleft|TOCleft]]&#125;&#125;
{{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.
 
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;TOCleft&#125;&#125;</code> at the point in the article where you want the top of the Table of Contents box to appear.
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|-}}, {{tl|clearleft}}, or {{tl|clearright}} to prevent images coalitions. 
 
== Example and cautions ==


{{TOCleft}}
== Cautions ==
← look to the left


Maybe be used with a <code>{{[[Template:-|-]]}}</code> as to prevent images colliding with the TOC.
Do not use this template to just force word warp 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.


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.
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.


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|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.


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]].
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.
:''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.
==See Also==


== History ==
* {{Lts|TOCleft}}
 
*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>
Line 39: Line 30:


<!-- ADD INTERWIKIS BELOW THIS LINE -->
<!-- ADD INTERWIKIS BELOW THIS LINE -->
[[be:Шаблён:Зьмест зьлева]]
[[be:Шаблён:Зьмест зьлева]]
[[uk:Шаблон:Зміст ліворуч]]
[[uk:Шаблон:Зміст ліворуч]]
Line 45: Line 35:
[[ru:Шаблон:Содержание слева]]
[[ru:Шаблон:Содержание слева]]
[[vi:Tiêu bản:Mục lục bên trái]]
[[vi:Tiêu bản:Mục lục bên trái]]
</includeonly>
</includeonly>

Revision as of 04:52, 3 April 2007

Template:Template doc page viewed directly

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 {{-}}, {{clearleft}}, or {{clearright}} to prevent images coalitions.

Cautions

Do not use this template to just force word warp 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.

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.

Unless the section in which the {{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.

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