Template:TOC right/doc: Difference between revisions

From Official Kodi Wiki
Jump to navigation Jump to search
(rewrote major parts of documentation)
(Copyedit for clarity)
 
(67 intermediate revisions by 50 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 [[{{NAMESPACE}}:TOCright/{{{1|doc}}}]]'' <small>[<span class="plainlinks">[{{fullurl:{{NAMESPACEE}}:TOCright/{{{1|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:Template documentation|{{PAGENAME}}]]<!--
 
--></includeonly><noinclude><center>
{| class="messagebox" style="width:80%; border:1px solid #c0c090; background:#f8eaba; margin:2px 4px 2px 4px;"
|- 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}}:TOCright]].}}'''<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>
<!-- EDIT TEMPLATE DOCUMENTATION BELOW THIS LINE -->
 
# {{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.


== 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.
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 coalition with text or use {{tl|clearleft}} or {{tl|clearright}} to prevent images coalitions.
* Avoid placing the TOC in a visually poor location; crossing a section division is probably a poor idea.
 
== Parameters (optional) ==
 
;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>.
 
;width: Set the CSS width.
 
;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]].
 
== Cautions ==
Usage of this template remains controversial with many editors and readers as it breaks consistency with the standardized appearance of the site.  When using this 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]]
 
* 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.
* If the TOC is floated left of a bulleted list, the bullets will be hidden.


== Site wide floating of TOC code ==
=== Parameters (optional) ===
{{see also|Help:User style}}
{{Glossary}}
Add to your [[Special:Mypage/monobook.css|userpage/monobook.css]] (if your using the default monobook skin)
{{Term|term=clear}}
<pre>
{{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>.
#bodyContent #toc {
{{Term|term=width}}
float: right;
{{Defn|defn=Set the CSS width.}}
clear: right;
{{Term|term=limit}}
margin: 0.3em;
{{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}}
</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.
<pre>
#bodyContent > #toc, #wikiPreview > #toc {
float: right;
clear: none;
padding: 0.2em;
margin: 0.3em;
}
</pre>


==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 -->
[[be-x-old:Шаблён:Зьмест справа]]
[[ca:Plantilla:TOCright]]
[[cs:Šablona:RIGHTTOC]]
[[de:Vorlage:TOCright]]
[[es:Plantilla:TOCderecha]]
[[fr:Modèle:Sommaire à droite]]
[[he:תבנית:תוכן שמאל]]
[[hr:Predložak:TOCright]]
[[hu:Sablon:TOCright]]
[[id:Templat:TOCright]]
[[it:Template:TOCright]]
[[mk:Шаблон:TOCright]]
[[ru:Шаблон:Содержание справа]]
[[vi:Tiêu bản:Mục lục bên phải]]


</includeonly>
[[Category:Template documentation pages]]</noinclude>

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"