Template:TOC right/doc: Difference between revisions
Jump to navigation
Jump to search
(Created page with "<noinclude>{{Documentation subpage}}</noinclude> <!-- EDIT TEMPLATE DOCUMENTATION BELOW THIS LINE --> {{TOC right}} # {{tl|TOC right}} forces the auto-generated Table of Conte...") |
No edit summary |
||
| Line 5: | Line 5: | ||
=== Usage === | === Usage === | ||
Insert <code>{{{{BASEPAGENAME}}}}</code> at the point in the article where you want the top of the Table of Contents box to appear. This should usually be after the text of the lead section, and just before the first section heading, in accordance with [[Wikipedia:Lead section#Elements of the lead]]. Use with {{tl|-}} or {{tl|clear}} to prevent collision with text; use the '''clear''' parameter (see below) to prevent collision with images. | Insert <code>{{{{BASEPAGENAME}}}}</code> at the point in the article where you want the top of the Table of Contents box to appear. This should usually be after the text of the lead section, and just before the first section heading, in accordance with [[Wikipedia:Lead section#Elements of the lead|Elements of the lead]]. Use with {{tl|-}} or {{tl|clear}} to prevent collision with text; use the '''clear''' parameter (see below) to prevent collision with images. | ||
=== Parameters (optional) === | === 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>. | ;clear : Sets the [[Wikipedia: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. | ;width: Set the CSS width. | ||
| Line 19: | Line 19: | ||
== Cautions == | == Cautions == | ||
Do not use this template to just force word wrap around the TOC, as this is inappropriate method of achieving this. Instead add a CSS class to your current skin's .css file, which will apply site wide. Go to [[Special:Mypage/skin.css]], which redirects to your current [[ | Do not use this template to just force word wrap around the TOC, as this is inappropriate method of achieving this. Instead add a CSS class to your current skin's .css file, which will apply site wide. Go to [[Special:Mypage/skin.css]], which redirects to your current [[Wikipedia:SKIN|skin]]'s CSS file. | ||
Do not place this template so that the TOC aligns with a large image or infobox; this breaks the layout on narrow screens (even users with screens as wide as 1024px wide can have problems). Also, a TOC that crosses a section division is probably a poor idea, if that can be avoided. | Do not place this template so that the TOC aligns with a large image or infobox; this breaks the layout on narrow screens (even users with screens as wide as 1024px wide can have problems). Also, a TOC that crosses a section division is probably a poor idea, if that can be avoided. | ||
| Line 25: | Line 25: | ||
Unless the section in which the {{tl|TOC right}} is placed is long enough, the result may well be undesirable. | Unless the section in which the {{tl|TOC right}} is placed is long enough, the result may well be undesirable. | ||
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. | 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 [[Wikipedia:Help:Section#Floating the TOC|Floating the TOC]] for further guidelines. | ||
<noinclude>[[Category:Templates]][[Category:Functionality]][[Category:Template documentation]]</noinclude> | <noinclude>[[Category:Templates]][[Category:Functionality]][[Category:Template documentation]]</noinclude> | ||
Latest revision as of 12:01, 10 November 2012
{{TOC right}}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, in order to improve article layout.
Usage
Insert {{TOC right}} at the point in the article where you want the top of the Table of Contents box to appear. This should usually be after the text of the lead section, and just before the first section heading, in accordance with Elements of the lead. Use with {{-}} or {{clear}} to prevent collision with text; use the clear parameter (see below) to prevent collision with images.
Parameters (optional)
- clear
- 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 after all the right floating elements before it. Options areleft,right,both, ornone.
- 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. Andlimit=2will hide all subheadings leaving only the main headings. This is implemented as a CSS class in the MediaWiki:Common.css.
- 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.
Cautions
Do not use this template to just force word wrap around the TOC, as this is inappropriate method of achieving this. Instead add a CSS class to your current skin's .css file, which will apply site wide. Go to Special:Mypage/skin.css, which redirects to your current skin's CSS file.
Do not place this template so that the TOC aligns with a large image or infobox; this breaks the layout on narrow screens (even users with screens as wide as 1024px wide can have problems). Also, a TOC that crosses a section division is probably a poor idea, if that can be avoided.
Unless the section in which the {{TOC right}} is placed is long enough, the result may well be undesirable.
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 Floating the TOC for further guidelines.