Template:TOC right/doc: Difference between revisions

From Official Kodi Wiki
Jump to navigation Jump to search
(Copyedit for clarity)
 
(47 intermediate revisions by 32 users 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 />


{{selectskin}}
The <kbd style="font-size: 1.15em; font-weight: 800;"><nowiki>{{</nowiki>[[Template:TOC right|TOC right]]<nowiki>}}</nowiki></kbd> template forces the auto-generated Table of Contents for a page to appear in a table that is floated to the right side of the page, in order to improve page layout.
# {{tl|TOCright}} forces the auto-generated Table of Contents for an article to appear in a table that is floated to the right side of the page (as seen right), in order to improve article layout.
# {{tl|TOCnestright}} Operates similarly, but is designed to use early in introduction or second sections on the many pages having a lot of images or wikitable elements such as infoboxes dominating the right side of such pages. '''TOCnestright''' will drift up against such constructs allowing text wrapping above, left and below preventing discordantly ugly page breaks and large excessive whitespace gaps on the page as given by the default TOC.
::When using the TOCnestright template logout and check that it appears correctly with the default skin in Internet Explorer and a [[Acid2]] compatible browser (or Firefox).  Consult the following pages for placement elucidation [[Help:Section#Floating the TOC]] and [[Wikipedia:How to fix bunched-up edit links]], or see {{Tl|FixHTML}} and use it with TOCnestright as a matter of habit. (The problem is ''Some browser's'' render the page in different orders relative to HTML blocks or block elements (including images, tables, and infoboxes... so most of our pages!) FixHTML (also called FixBunching) "forces" rendering to' behave' '' itself. So prophylactic use is a good idea, and is a really good idea on pages with lots of images.


== Usage ==
== Usage ==
Insert {{Tlx|{{BASEPAGENAME}}}} at the point in the page where you want the top of the Table of Contents box to appear. Use with {{Tlx|-}} or {{Tlx|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;{{BASEPAGENAME}}&#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 collision with text; use the '''clear''' parameter (see below) to prevent collision with images.
=== Parameters (optional) ===
 
{{Glossary}}
== Parameters (optional) ==
{{Term|term=clear}}
 
{{Defn|defn=Sets the [[wikipedia:CSS|CSS]] clear property, which forces this float underneath the side specified with this attribute. So, {{Para|clear|right}} (which is the default) will place the element underneath all the right-floating elements before it. Valid values for {{Para|clear}} are: <code>left</code>, <code>right</code>, <code>both</code>, or <code>none</code>.
;clear : Sets the [[Cascading Style Sheets|CSS]] clear property, which forces this float underneath the side specified with this attribute. So, <code>clear=right</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>.
{{Term|term=width}}
 
{{Defn|defn=Set the CSS width.}}
;width: 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. And {{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}}


;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]].
== See also ==
 
* {{Tl|TOC left}}<includeonly>
* Avoid placing the TOC in a visually poor location.  Crossing a section division is probably a poor idea.
<!-- Categories go here -->
* If the TOC is floated left of a bulleted list, the bullets will be hidden.
<!-- CSS instructions have no business in this template help... good editors use the default skin so they can see what the customer readers see. Not customize their interfaces and leave themselves susceptable to getting faked out.
== Site wide floating of TOC code ==
{{see also|Help:User style}}
Add to your [[Special:Mypage/monobook.css|userpage/monobook.css]] (if your using the default monobook skin)
<pre>
#bodyContent #toc {
float: right;
clear: right;
margin: 0.3em;
}
</pre>


A more advanced (non IE users) using the CSS child selector to prevent existing TOC layout scheme from causing problems and allowing the TOC to float next to existing images.
[[Category:Formatting templates]]</includeonly><noinclude>
<pre>
#bodyContent > #toc, #wikiPreview > #toc {
float: right;
clear: none;
padding: 0.2em;
margin: 0.3em;
}
</pre>
--->
==See also==
* {{Lts|TOCleft}}
* [[Help:Magic words#Table of contents|Help:Magic words]]


<includeonly>
<!-- ADD CATEGORIES BELOW THIS LINE -->
[[Category:TOC templates| ]]


<!-- ADD INTERWIKIS BELOW THIS LINE -->
[[Category:Template documentation pages]]</noinclude>
[[ar:قالب:فهرس يسار]]
[[be-x-old:Шаблён:Зьмест справа]]
[[ca:Plantilla:TOCright]]
[[cs:Šablona:RIGHTTOC]]
[[da:Skabelon:TOC right]]
[[de:Vorlage:TOCright]]
[[eo:Ŝablono:TOC-dekstre]]
[[es:Plantilla:TOCderecha]]
[[fr:Modèle:Sommaire à droite]]
[[he:תבנית:תוכן שמאל]]
[[hr:Predložak:TOCright]]
[[hu:Sablon:TOCright]]
[[mk:Шаблон:Содржина-десно]]
[[id:Templat:TOCright]]
[[it:Template:TOCright]]
[[ko:틀:TOCright]]
[[ja:Template:TOCright]]
[[no:Mal:TOC right]]
[[pl:Szablon:Spis treści]]
[[pt:Predefinição:TOC-direita]]
[[ru:Шаблон:TOC-Right]]
[[sv:Mall:TOCright]]
[[vi:Tiêu bản:Mục lục bên phải]]
[[zh:Template:TOCright]]
[[zh-yue:Template:TOCright]]
</includeonly>

Latest revision as of 07:01, 16 September 2022

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


The {{TOC right}} template forces the auto-generated Table of Contents for a page to appear in a table that is floated to the right side of the page, in order to improve page layout.

Usage

Insert {{TOC right}} 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
{{Defn|defn=Sets the CSS clear property, which forces this float underneath the side specified with this attribute. So, |clear=right (which is the default) will place the element underneath all the right-floating elements before it. Valid values for |clear= 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.

See also

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