Difference between revisions of "Template:TOC/doc"

From EVE University Wiki
Jump to: navigation, search
m (Update doc.)
m (Update dependencies. Sync value between visible sample and actual sample. Update default for limit parameter.)
Line 5: Line 5:
 
:; Uses
 
:; Uses
 
:: [[MediaWiki:Common.css]]
 
:: [[MediaWiki:Common.css]]
 +
:: <nowiki>__TOC__</nowiki>
  
 
; Syntax
 
; Syntax
Line 10: Line 11:
  
 
; Parameters
 
; Parameters
:; limit : Number indicating the highest heading level to show in the table of contents. The lower, the fewer heading levels are shown. Note that in articles, the main level for headings starts at 2 (the article title is H1). Valid values 2 till 6. Defaults to 2.
+
:; limit : Number indicating the highest heading level to show in the table of contents. The lower, the fewer heading levels are shown. Note that in articles, the main level for headings starts at 2 (the article title is H1). Valid values 2 till 6. Defaults to no limit.
 
:; align : Whether to align the table of contents to the "right" or "left". The default is left.
 
:; align : Whether to align the table of contents to the "right" or "left". The default is left.
  
 
; Sample  
 
; Sample  
:<code><nowiki>{{TOC|limit=2|align=right}}</nowiki></code>
+
:<code><nowiki>{{TOC|limit= 3|align= right}}</nowiki></code>
 
::gives...
 
::gives...
{{TOC|limit=3|align=right}}
+
{{TOC|limit= 3|align= right}}
  
 
== section 1 ==
 
== section 1 ==
Line 26: Line 27:
 
===== section 1.1.1.1 =====
 
===== section 1.1.1.1 =====
  
;See also:
+
; See also:
 
:* [https://www.mediawiki.org/wiki/Template:TOC Template:TOC]
 
:* [https://www.mediawiki.org/wiki/Template:TOC Template:TOC]
  
 
<includeonly>[[Category:Link templates]]</includeonly>
 
<includeonly>[[Category:Link templates]]</includeonly>
 
<noinclude>[[Category:Template documentation]]</noinclude>
 
<noinclude>[[Category:Template documentation]]</noinclude>

Revision as of 11:05, 29 February 2024

Description
This template changes the way the table of contents is rendered.
Dependencies
Uses
MediaWiki:Common.css
__TOC__
Syntax
{{TOC|<limit=>|<align=>}}
Parameters
limit
Number indicating the highest heading level to show in the table of contents. The lower, the fewer heading levels are shown. Note that in articles, the main level for headings starts at 2 (the article title is H1). Valid values 2 till 6. Defaults to no limit.
align
Whether to align the table of contents to the "right" or "left". The default is left.
Sample
{{TOC|limit= 3|align= right}}
gives...

section 1

section 1.1

section 1.1.1

section 1.1.1.1
See also