Template:TOC right/doc: Difference between revisions
Jump to navigation
Jump to search
m (fix /doc transclusion notice link) |
(partial revert, began parameter documentation) |
||
| Line 1: | Line 1: | ||
<includeonly><!-- | <includeonly>{{template doc page transcluded}}</includeonly><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|{{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. | # <s>{{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.</s> Use <nowiki>{{TOCright|clear=none}}</nowiki> for this. | ||
== 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. Use with {{tl|-}}, {{tl|clearleft}}, or {{tl|clearright}} to prevent images coalitions. <code> | Insert <code>{{{{BASEPAGENAME}}}}</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) == | |||
;clear: Sets the CSS value of floats to clear. Options are <code>left</code>, <code>right</code>, <code>both</code>, or <code>none</code>. | |||
;width: Set the CSS width, may not always work properly in [[Internet Explorer]]. | |||
;limit: Allow limiting of which header levels are shown in a TOC; <code> limit=3, 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). | |||
== Cautions == | == Cautions == | ||
After placing these templates, logoff and view the page in the default skin to assure the appearance to our readers is sound. | 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. | 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. | 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. | 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. | ||
| Line 36: | Line 37: | ||
<!-- ADD INTERWIKIS BELOW THIS LINE --> | <!-- ADD INTERWIKIS BELOW THIS LINE --> | ||
[[be:Шаблён:Зьмест справа]] | [[be:Шаблён:Зьмест справа]] | ||
[[de:Vorlage:TOCright]] | [[de:Vorlage:TOCright]] | ||
| Line 50: | Line 45: | ||
[[cs:Šablona:RIGHTTOC]] | [[cs:Šablona:RIGHTTOC]] | ||
[[vi:Tiêu bản:Mục lục bên phải]] | [[vi:Tiêu bản:Mục lục bên phải]] | ||
</includeonly> | |||
Revision as of 00:16, 25 April 2007
Template:Template doc page viewed directly
- {{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 (as seen right), in order to improve article layout.
{{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.Use {{TOCright|clear=none}} for this.
Usage
Insert {{TOC right}} at the point in the article where you want the top of the Table of Contents box to appear. Use with {{-}}, {{clearleft}}, or {{clearright}} to prevent images coalitions.
Parameters (optional)
- clear
- Sets the CSS value of floats to clear. Options are
left,right,both, ornone.
- width
- Set the CSS width, may not always work properly in Internet Explorer.
- limit
- Allow limiting of which header levels are shown in a TOC;
limit=3, 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).
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 {{TOC right}} 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.
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