We are still actively working on the spam issue.

Difference between revisions of "Template:TOCright"

From InstallGentoo Wiki
Jump to: navigation, search
(Created a standard MediaWiki TOCright template)
 
m
 
Line 1: Line 1:
{{TOC
+
<noinclude>
|clear={{{clear|right}}}
+
{{Template}}
|width={{{width|{{{1|auto}}}}}}
+
<nowiki>{{TOC right}}</nowiki> 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.
|align=right
+
 
|limit={{{limit|}}}
+
== Usage ==
}}<noinclude>
+
Insert <code>&#123;&#123;{{BASEPAGENAME}}&#125;&#125;</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.
[[Category:Utility templates|{{PAGENAME}}]]
+
 
 +
=== 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>.
 +
 
 +
;width: Set the CSS width.
 +
 
 +
;limit: Limits the depth of subheadings shown. For instance using <code>limit=4</code> will hide the fourth level and deeper subheadings in the hierarchy. And <code>limit=2</code> will hide all subheadings leaving only the main headings. This is implemented as a CSS class in the [[MediaWiki:Common.css]].
 +
 
 
</noinclude>
 
</noinclude>
 +
<includeonly><div style="clear: {{{clear|right}}}; margin-bottom: .5em; float: right; padding: .5em 0 .8em 1.4em; background: none; width: {{{width|{{{1|auto}}}}}};" {{#if:{{{limit|}}}|class="toclimit-{{{limit}}}"}}>__TOC__</div></includeonly>

Latest revision as of 11:21, 27 April 2016

This page is a template. It contains no article-related information, but should be used as part of other articles. For more information, read Help:Template.

Please do not experiment with this template; you could ruin all pages using this template. If you want to edit this template, copy the text to Template:Sandbox, edit and test it there, and copy it back when it works.

Feel free to voice your opinion regarding this template.

{{TOC right}} 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.

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.

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 are left, right, both, or none.
width
Set the CSS width.
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 is implemented as a CSS class in the MediaWiki:Common.css.