ModEnc is currently in Maintenance Mode: Changes could occur at any given moment, without advance warning.

Difference between revisions of "Template:Toc/doc"

From ModEnc
Jump to: navigation, search
(Doc to introduce this template.)
 
m
 
(3 intermediate revisions by the same user not shown)
Line 1: Line 1:
−
;Description
+
This template will specify the catalogue of the page and make it float (that is, the text can surround the catalogue), specify the location of the catalogue, or make it have no text around on the left / right side.
−
:This template will float the article's table of contents to the right. It will also force a ToC when/where it would not normally be found.
 
−
:Use it only when needed.
 
−
;Syntax
 
−
:Type <code>{{t|tocright}}</code>
 
  
−
<includeonly>[[Category:General wiki templates|{{PAGENAME}}]]</includeonly><noinclude>[[Category:Template documentation|{{PAGENAME}}]]</noinclude>
+
==Parameters descriptions==
 +
{| class="wikitable" style="background-color: #FFFFFF00;"
 +
! Parameters !! Default values !! Optional values !! Descriptions
 +
|-
 +
! <code>1</code>
 +
| <code>left</code> || <code>left</code>, <code>right</code>, <code>center</code> || The first parameter, for specifying the location of the catalogue. Please do not use <code>center</code> in general.
 +
|-
 +
! <code>2</code>
 +
|  (NULL) (Only if the value of parameter 1 is <code>left</code>)
 +
* <code>right</code> (Only if the value of parameter 1 is <code>right</code>)
 +
* <code>both</code> (Only if the value of parameter 1 is <code>center</code>)
 +
| <code>right</code> (Only if the value of parameter 1 is <code>left</code>)
 +
* No options (Only if the value of parameter 1 is <code>center</code> or <code>left</code>)
 +
| The second parameter, use for specifying which side of the catalogue to empty, which will make that side have no text around the catalogue. Only while the catalogue is left, you will have option <code>right</code> to clear the text on the right. In other cases, the side to be cleared will be automatically specified and cannot be customized.
 +
|}
 +
 
 +
==Examples==
 +
{{Toc/doc/example}}

Latest revision as of 10:30, 23 August 2021

This template will specify the catalogue of the page and make it float (that is, the text can surround the catalogue), specify the location of the catalogue, or make it have no text around on the left / right side.

Parameters descriptions

Parameters Default values Optional values Descriptions
1 left left, right, center The first parameter, for specifying the location of the catalogue. Please do not use center in general.
2 (NULL) (Only if the value of parameter 1 is left)
  • right (Only if the value of parameter 1 is right)
  • both (Only if the value of parameter 1 is center)
 right (Only if the value of parameter 1 is left)
  • No options (Only if the value of parameter 1 is center or left)
 The second parameter, use for specifying which side of the catalogue to empty, which will make that side have no text around the catalogue. Only while the catalogue is left, you will have option right to clear the text on the right. In other cases, the side to be cleared will be automatically specified and cannot be customized.

Examples

Use {{Toc}} or {{Toc|left}}

Use {{Toc|center}}

Use {{Toc|right}}

Retrieved from "https://modenc.renegadeprojects.com/index.php?title=Template:Toc/doc&oldid=21495"