Teamplaid:TOCright/documentation
 | This is a documentation subpage for Teamplaid:TOCright. It contains usage information, categories and other content that is not part of the original teamplaid page. |
 | This template is currently protected from editing. See the protection policy and protection log for more details. Please discuss any changes on the talk page; you may submit an edit request to ask an administrator to make an edit if it is uncontroversial or supported by consensus. You may also request that this page be unprotected. |
 |
This template is used on many pages and changes may be widely noticed. Test changes in the template's /sandbox or /testcases subpages, or in your own user subpage. Consider discussing changes on the talk page before implementing them. |
 | This template uses TemplateStyles: |
{{TOCright}} forces the auto-generated Table of Contents for an article to appear floated to the right side of the page, in order to improve article layout.
Ùsaid - Usage
Insert {{TOCright}} 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.
- Avoid placing the TOC in a visually poor location. Crossing a section division is probably a poor idea.
- 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 works by hiding the lower levels with CSS. See Template:TOClimit/styles.css.
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 {{TOCright}} 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 {{enUici|Help:Section#Floating the TOC|Floating the TOC]] for further guidelines.
Faic cuideachd - Also see
- {{TOCleft}}
Teamplaid-dàta - TemplateData
{{TOCright}} forces the auto-generated "Table of Contents" for an article to appear floated to the right side of the page (as seen right), in order to improve article layout.
| Paramadair | Tuairisgeul | Seòrsa | Staid | |
|---|---|---|---|---|
| Clear | 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 are left, right, both, or none. | Sreang | roghainneil |
| Limit | 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 works by hiding the lower levels with CSS | Àireamh | roghainneil |
| Width | width 1 | Overrides the CSS width | Chan eil fhios | roghainneil |