Template:TOC right/doc: Difference between revisions

From Official Kodi Wiki
Jump to navigation Jump to search
(subst:template doc page viewed directly for multitemplate use of page)
(Copyedit for clarity)
 
(75 intermediate revisions by 51 users not shown)
Line 1: Line 1:
<includeonly>{{template doc page transcluded}}</includeonly><noinclude><center>
{{Documentation subpage}}
{| class="messagebox" style="width:80%; border:1px solid #c0c090; background:#f8eaba; margin:2px 4px 2px 4px;"
{{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 />
|- style="vertical-align:top;"
|align="center" style="width:60px; padding:1ex;"| [[Image:Edit-paste.svg|none|40px]]
| '''This is the [[Wikipedia:Template doc page pattern|template documentation page]] {{#if:{{{1|}}}|{{{1}}}|for [[{{NAMESPACE}}:{{BASEPAGENAME}}]].}}'''<br/><hr/>This page is not necessarily intended to be viewed directly. If it uses [[w:Help:Variable|variable]]s, some links may appear broken. Do not replace these variables with [[w:Hardcoded|hardcoded]] page names or URLs.
|}<br/><hr/>
</center>
[[Category:Template documentation|{{PAGENAME}}]]<!--


--></noinclude>
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.
<!-- 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.
=== 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 CSS value of floats to clear.  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, may not always work properly in [[Internet Explorer]].
{{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]].}}
;limit:  Allow limiting of which header levels are shown in a TOC; <code>limit=3</code>, for instance, will limit to showing ==headings== and ===headings=== but no further (as long as there are no =headings= on the page, which there shouldn't be according to the MOS).
{{Glossary end}}
 
== Cautions ==
After placing these templates, logoff and view the page in the default skin to assure the appearance to our readers is sound.
 
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|{{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.
 
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. <!-- Discuss on the talk page if you disagree! -->


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 ==
* {{Tl|TOC left}}<includeonly>
<!-- Categories go here -->


==See Also==
[[Category:Formatting templates]]</includeonly><noinclude>
* {{Lts|TOCleft}}
* {{Lts|TOCrightEx}}
* [[Help:Magic words#Table_of_contents|Help:Magic words]]


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


<!-- ADD INTERWIKIS BELOW THIS LINE -->
[[Category:Template documentation pages]]</noinclude>
[[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]]
</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"