Difference between revisions of "Template:TOC/doc"
From EVE University Wiki
(Wrote new TOC docs) |
m (Add comment on the sample only working in a specific situation.) |
||
| (6 intermediate revisions by 2 users not shown) | |||
| Line 5: | Line 5: | ||
:; Uses | :; Uses | ||
:: [[MediaWiki:Common.css]] | :: [[MediaWiki:Common.css]] | ||
| + | :: <nowiki>__TOC__</nowiki> | ||
; Syntax | ; Syntax | ||
| Line 10: | Line 11: | ||
; Parameters | ; Parameters | ||
| − | :; limit | + | :; 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 | ||
| − | |||
; Sample | ; Sample | ||
| − | :<code><nowiki>{{TOC|limit= | + | :<code><nowiki>{{TOC|limit= 3|align= right}}</nowiki></code> |
| − | ::gives... | + | ::gives... (Note: Due to the way this template, the documentation template and the table of contents code works the sample does <em>not</em> function when not looking directly on the doc page.) |
| − | {{TOC|limit= | + | {{TOC|limit= 3|align= right}} |
== section 1 == | == section 1 == | ||
| Line 28: | 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> | ||
Latest revision as of 11:12, 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... (Note: Due to the way this template, the documentation template and the table of contents code works the sample does not function when not looking directly on the doc page.)
section 1
section 1.1
section 1.1.1
section 1.1.1.1
- See also
