Template:TOC right/doc: Difference between revisions
(Updated documentation from {{TOCleft}}) |
(usage notes on the limit= param) |
||
| Line 6: | Line 6: | ||
== Usage == | == Usage == | ||
Insert <code>{{{{BASEPAGENAME}}}}</code> aat 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. | Insert <code>{{{{BASEPAGENAME}}}}</code> aat 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>{{{{BASEPAGENAME}}|limit=3}}</code> (for instance) will limit the TOC to showing level-3 (or whatever number you choose from 2 to 7 inclusive) headings but no subheadings below that; level-3 heading are those produced by ===heading===. | ||
== Cautions == | == Cautions == | ||
Revision as of 12:17, 20 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.
Usage
Insert {{TOC right}} aat 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. {{TOC right|limit=3}} (for instance) will limit the TOC to showing level-3 (or whatever number you choose from 2 to 7 inclusive) headings but no subheadings below that; level-3 heading are those produced by ===heading===.
Cautions
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.
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.
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