Template:TOC left/doc: Difference between revisions

From Official Kodi Wiki
Jump to navigation Jump to search
(→‎Example and cautions: MoS discussion is now archived)
(Copyedit for clarity)
 
(44 intermediate revisions by 34 users not shown)
Line 1: Line 1:
<includeonly>{{template doc page transcluded}}</includeonly><noinclude>{{template doc page viewed directly}}</noinclude>
{{Documentation subpage}}
<!-- EDIT TEMPLATE DOCUMENTATION BELOW THIS LINE -->
{{Notice|It contains usage information, categories and other content that is not part of the original template page.|''NOTICE:'' This is a documentation subpage for [[:{{SUBJECTSPACE}}:{{BASEPAGENAME}}]]}}<br />


== Purpose ==
The <kbd style="font-size: 1.15em; font-weight: 800;"><nowiki>{{</nowiki>[[Template:TOC left|TOC left]]<nowiki>}}</nowiki></kbd> template 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.
 
&#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 {{Tlx|TOC left}} 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''' attribute (see below) to prevent collision with images.
* 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.


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) ===
 
{{Glossary}}
== Example and cautions ==
{{Term|term=clear}}
 
{{Defn|defn=Sets the [[wikipedia:CSS|CSS]] <samp>clear</samp> property, which forces this float underneath the side specified with this attribute. So, {{Para|clear|left}} (which is the default) will place the element underneath all the left-floating elements before it. Valid values for this parameter are: <code>left</code>, <code>right</code>, <code>both</code>, or <code>none</code>.}}
{{TOCleft}}
{{Term|term=width}}
← look to the left
{{Defn|defn=Set the CSS width.}}
 
{{Term|term=limit}}
Maybe be used with a <code>{{[[Template:-|-]]}}</code> as to prevent images colliding with the TOC.
{{Defn|defn=Limits the depth of subheadings shown. For instance using {{Para|limit|4}} will hide the fourth level and deeper subheadings in the hierarchy, while {{Para|limit|2}} will hide all subheadings, leaving only the main headings. This is implemented as a CSS class in the [[MediaWiki:Common.css]].}}
 
{{Glossary end}}
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.
 
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]].
:''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]]
== See also ==
*Created in response to the discussion of TOCright on TfD and elsewhere.
* {{Tl|TOC right}}<includeonly>
*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]]
<!-- Categories go here -->


<includeonly>
[[Category:Formatting templates]]</includeonly><noinclude>
<!-- ADD CATEGORIES BELOW THIS LINE -->
[[Category:TOC templates|{{PAGENAME}}]]


<!-- ADD INTERWIKIS BELOW THIS LINE -->


[[be:Шаблён:Зьмест зьлева]]
[[Category:Template documentation pages]]</noinclude>
[[uk:Шаблон:Зміст ліворуч]]
[[fi:Malline:TOCvasen]]
[[ru:Шаблон:Содержание слева]]
</includeonly>

Latest revision as of 07:09, 16 September 2022

Emblem-important-yellow.png NOTICE: This is a documentation subpage for Template:TOC left:
It contains usage information, categories and other content that is not part of the original template page.


The {{TOC left}} template 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 attribute (see below) to prevent collision with images.

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

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 underneath all the left-floating elements before it. Valid values for this parameter 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, while |limit=2 will hide all subheadings, leaving only the main headings. This is implemented as a CSS class in the MediaWiki:Common.css.

See also