Template:TOC left/doc: Difference between revisions

From Official Kodi Wiki
Jump to navigation Jump to search
m (45 revisions)
(Copyedit for clarity)
 
(5 intermediate revisions by one other user not shown)
Line 1: Line 1:
<noinclude>{{Documentation subpage}}</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.
{{TOC left}}
{{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 article where you want the top of the Table of Contents box to appear. Use with {{tl|-}} or {{tl|clear}} to prevent images collisionsSee [[John Vanbrugh]] for a live example.
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 locationCrossing a section division is probably a poor idea.
* If the TOC is floated left of a bulleted list, the bullets will be hidden.


== Cautions ==
=== Parameters (optional) ===
Do not use this template to just force word wrap around the TOC, as this is an inappropriate method of achieving this. Instead add a CSS class to your current skin's .css file, which will apply site wide. Go to [[Special:Mypage/skin.css]], which redirects to your current [[WP:SKIN|skin]]'s CSS file.
{{Glossary}}
{{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>.}}
{{Term|term=width}}
{{Defn|defn=Set the CSS width.}}
{{Term|term=limit}}
{{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}}


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).
== See also ==
Also, a TOC that crosses a section division is probably a poor idea, if that can be avoided.
* {{Tl|TOC right}}<includeonly>
<!-- Categories go here -->


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.
[[Category:Formatting templates]]</includeonly><noinclude>


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==
[[Category:Template documentation pages]]</noinclude>
* {{Lts|TOC right}}
 
<includeonly>
<!-- ADD CATEGORIES BELOW THIS LINE -->
[[Category:Wikipedia table of contents templates|Left]]
 
<!-- ADD INTERWIKIS BELOW THIS LINE -->
</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