TOC – Template
Jump to navigation
Jump to search
Lou Montana (talk | contribs) m (Fix Link/Hash → Link template) |
Lou Montana (talk | contribs) (Fix empty subtoc title, Add auto-categorisation on subtoc error) |
||
Line 13: | Line 13: | ||
| | | | ||
<div class="toc" style="font-size: .9em"> | <div class="toc" style="font-size: .9em"> | ||
<div class="toctitle">'''{{{title|Contents}}}'''</div> | {{#if:{{{title|a}}}|<div class="toctitle">'''{{{title|Contents}}}'''</div>}} | ||
{{{content}}} | {{{content}}} | ||
</div> | </div> | ||
| | | | ||
{{TemplateCase||[[Category:TOC template usage error]]}} | |||
}} | }} | ||
| | | | ||
__TOC__ | __TOC__ | ||
}}</div></includeonly><noinclude> | }}</div></includeonly><noinclude> | ||
{{Feature | important | Only '''one''' TOC (Table of Contents) is possible per page, with the exception of ''abc'' and ''subtoc''.}} | {{Feature |important|Only '''one''' TOC (Table of Contents) is possible per page, with the exception of ''abc'' and ''subtoc''.}} | ||
== Usage == | == Usage == | ||
Line 80: | Line 80: | ||
{{TOC|subtoc | {{TOC|subtoc | ||
|title= The sub-TOC title | |title= The sub-TOC title | ||
|content= | |||
* 1. {{Link|#Title 1}} | |||
* 2. {{Link|#Title 2}} | |||
* 3. {{Link|#Title 3}} | |||
}} | |||
|- | |||
| <pre>{{TOC|subtoc | |||
|title= | |||
|content= | |||
* 1. {{Link|#Title 1}} | |||
* 2. {{Link|#Title 2}} | |||
* 3. {{Link|#Title 3}} | |||
}}</pre> | |||
| style="padding-left: 2.5em" | | |||
{{TOC|subtoc | |||
|title= | |||
|content= | |content= | ||
* 1. {{Link|#Title 1}} | * 1. {{Link|#Title 1}} |
Revision as of 13:03, 1 June 2023
Usage
{{TOC|mode|size|limit|nonum|title=|content=}}
- mode: (Optional, default: "normal"; case-insensitive) 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
- subtoc - creates a TOC-like box. Additional parameters:
- title: (Optional, default empty) subTOC title
- content: subTOC content, usually a list of {{Link}} internal links in format:
* 1. {{Link|#Title 1}} * 2. {{Link|#Title 2}} * 3. {{Link|#Title 3}}
- 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
Code | Result |
---|---|
{{TOC}} |
|
{{TOC|abc}} |
|
{{TOC|subtoc |content= * 1. {{Link|#Title 1}} * 2. {{Link|#Title 2}} * 3. {{Link|#Title 3}} }} |
|
{{TOC|subtoc |title= The sub-TOC title |content= * 1. {{Link|#Title 1}} * 2. {{Link|#Title 2}} * 3. {{Link|#Title 3}} }} |
|
{{TOC|subtoc |title= |content= * 1. {{Link|#Title 1}} * 2. {{Link|#Title 2}} * 3. {{Link|#Title 3}} }} |