Difference between revisions of "Template:TOC"

From Bohemia Interactive Community
Jump to navigation Jump to search
m (Text replacement - "\{\{( *)Important( *)\|" to "{{$1Feature$2|$2important$2|")
m (Fixed documentation)
Line 16: Line 16:
 
== Usage ==
 
== Usage ==
 
{{<nowiki/>TOC|'''''mode'''''|'''''size'''''|'''''limit'''''|'''''nonum'''''}}
 
{{<nowiki/>TOC|'''''mode'''''|'''''size'''''|'''''limit'''''|'''''nonum'''''}}
* mode: (Optional, default "normal" - case-insensitive) one of:
+
* mode: (Optional, default: "normal"; case-sensitive) one of:
 
** abc - a horizontal A..Z TOC (more of an ''index'')
 
** abc - a horizontal A..Z TOC (more of an ''index'')
 
** horizontal - a horizontal TOC, where full titles are kept
 
** horizontal - a horizontal TOC, where full titles are kept
 
** normal - the normal TOC - can be placed at the wanted position with this
 
** normal - the normal TOC - can be placed at the wanted position with this
** none - no TOC on the page (similar to <tt>__NOTOC__</tt>)
+
** none - no TOC on the page (similar to <tt><nowiki>__NOTOC__</nowiki></tt>)
 
** side - sets the TOC to the right
 
** side - sets the TOC to the right
 
* size: (Optional, default 1) size in em (e.g <tt>.9</tt> for 90%)
 
* size: (Optional, default 1) size in em (e.g <tt>.9</tt> for 90%)

Revision as of 17:23, 15 March 2021

Only one TOC (Table of Contents) is possible per page, with the exception of the abc one.

Usage

{{TOC|mode|size|limit|nonum}}

  • mode: (Optional, default: "normal"; case-sensitive) one of:
    • abc - a horizontal A..Z TOC (more of an index)
    • horizontal - a horizontal TOC, where full titles are kept
    • normal - the normal TOC - can be placed at the wanted position with this
    • none - no TOC on the page (similar to __NOTOC__)
    • side - sets the TOC to the right
  • size: (Optional, default 1) size in em (e.g .9 for 90%)
  • limit: (Optional, default empty) sub-level limit (e.g 2)
  • nonum: (Optional, default empty) y to hide numbers