Template:TOC right/doc: Difference between revisions

From Official Kodi Wiki
Jump to navigation Jump to search
(Copyedit for clarity)
 
(80 intermediate revisions by 52 users not shown)
Line 1: Line 1:
<includeonly><!--
{{Documentation subpage}}
{{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 />


--><div class="notice" id="disambig">''The template documentation below is [[Wikipedia:Transclusion|transcluded]] from [[TOCright/doc]]'' <small>[<span class="plainlinks">[{{fullurl:TOCright/doc|action=edit}} edit]</span>]</small></div>
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.
 
[[Category:Formatting templates|{{PAGENAME}}]]<!--
--></includeonly><!--
-->[[Category:Template documentation|{{PAGENAME}}]]<!--
--><noinclude>{{template doc page viewed directly}}<!--
--></noinclude>
<!-- EDIT TEMPLATE DOCUMENTATION BELOW THIS LINE -->
# {{tl|{{BASEPAGENAME}}}} 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.


== 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|-}}, {{tl|clearleft}}, or {{tl|clearright}} to prevent images coalitions. <code>&#123;&#123;{{BASEPAGENAME}}|limit=3&#125;&#125;</code> (for instance) will limit the TOC to showing level-3 (or whatever number you choose from 2 to 7 inclusive) headings but no subheadings below that; level-3 heading are those produced by ===heading===.
=== Parameters (optional) ===
 
{{Glossary}}
== Cautions ==
{{Term|term=clear}}
After placing these templates, logoff and view the page in the default skin to assure the appearance to your readers is sound.
{{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>.
 
{{Term|term=width}}
<!-- 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. Huh! Adding to local .css page is a piss poor way to assure the customers see what the editor intends. --->
{{Defn|defn=Set the CSS width.}}
 
{{Term|term=limit}}
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.
{{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}}
Unless the section in which the {{tl|{{BASEPAGENAME}}}} 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==
== See also ==
* {{Lts|TOCleft}}
* {{Tl|TOC left}}<includeonly>
* [[Help:Magic words#Table_of_contents|Help:Magic words]]
<!-- Categories go here -->


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


<!-- ADD INTERWIKIS BELOW THIS LINE -->
{{#ifeq:{{PAGENAME}}|TOCright
|<!---
---------------------------------------------------
Interwiki's for TOCright below this line please ---
---------------------------------------------------
--->
[[be:Шаблён:Зьмест справа]]
[[de:Vorlage:TOCright]]
[[he:תבנית:תוכן שמאל]]
[[mk:Шаблон:TOCright]]
[[pl:Szablon:TOC ramka]]
[[ru:Шаблон:Содержание справа]]
[[cs:Šablona:RIGHTTOC]]
[[vi:Tiêu bản:Mục lục bên phải]]
|<!--- ------------------------------------------------
Interwiki's for TOCnestright below this line please ---
-------------------------------------------------------
---->


}}<!-- End if# Page choice
[[Category:Template documentation pages]]</noinclude>
----></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"