Template:TOC right/doc: Difference between revisions
Jump to navigation
Jump to search
No edit summary |
RogueScholar (talk | contribs) (Copyedit for clarity) |
||
| (61 intermediate revisions by 45 users not shown) | |||
| Line 1: | Line 1: | ||
{{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 /> | |||
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. | |||
== 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 | * Avoid placing the TOC in a visually poor location; crossing a section division is probably a poor idea. | ||
* Avoid placing the TOC in a visually poor location | |||
* 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. | ||
== | === Parameters (optional) === | ||
{{ | {{Glossary}} | ||
{{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>. | ||
{{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. 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}} | ||
== See also == | |||
< | * {{Tl|TOC left}}<includeonly> | ||
<!-- Categories go here --> | |||
< | |||
[[Category:Formatting templates]]</includeonly><noinclude> | |||
[[Category:Template documentation pages]]</noinclude> | |||
[[ | |||
</ | |||
Latest revision as of 07:01, 16 September 2022
|
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,
- width
- Set the CSS width.
- limit
- Limits the depth of subheadings shown. For instance, using
|limit=4will hide the fourth level and deeper subheadings in the hierarchy. And|limit=2will hide all subheadings, leaving only the main headings. This is implemented as a CSS class in the MediaWiki:Common.css.
|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.
See also
- {{TOC left}}