View source for Template:Compact ToC/doc

{{Documentation subpage}}
{{High-use| 6041 }}
{{Intricate template}}
{{tsh|TOC|Toc}}
<!----Please place categories where indicated at the bottom of this page and interwikis at Wikidata (see [[Wikipedia:Wikidata]])-->

This is a [[H:TOC|table-of-contents]] replacement for alphabetical lists within mainspace articles. The template has all features of other TOC templates, such as optional "Top" "0–9" sections, and allows selecting other sections.
__TOC__

== Usage ==
=== Features ===
* The compact format goes sideways: A B C D E F G H I J K L ....
* The centering or numbers are optional: center=yes, num=yes.
* The "Contents" heading can go on top (default) or the side (side=yes).
* Letter ranges can be set (''see below:'' [[#Letters]]): A B C–F G H–K L...
* Some letters can be omitted, instead of 26 separate letters.
* Other headers can be listed in the TOC (''see below:'' [[#Listing custom headers|#Listing custom headers]]).
** Set upper headers before "ABCDEF" by pre1, pre2, ... pre8.
** Set lower headers after "ABCDEF" by custom1, custom2, ... custom8.
* Conceal subheader link-text as "pre1name" over "pre1link" and "custom1name" over "custom1link" etc.
* Other options include: top=yes, seealso=yes, refs=yes, extlinks=yes, etc.

=== Syntax ===
; Typical use : <nowiki>{{Compact ToC |symnum=yes}}</nowiki>
; Alphabetic (i.e. "A", "B", … "Z") links only : <nowiki>{{Compact ToC}}</nowiki>
; Common applications : <nowiki>{{Compact ToC |center=yes |seealso=yes|refs=yes|further=yes}}</nowiki>

===Full blank syntax===
<pre>
{{Compact ToC
 |side=|center=|right=
 |name=
 |top=

 |pre1=|pre1name=|pre1link=
 |pre2=|pre2name=|pre2link=
 <!--(etc, to:)-->
 |pre8=|pre8name=|pre8link=
 |prebreak=<!--yes-->

 |num= |sym= |symnum=
 |letters=

 |custom1=|custom1name=|custom1link=
 |custom2=|custom2name=|custom2link=
 <!--(etc, to:)-->
 |custom8=|custom8name=|custom8link=

 |nobreak=
 |seealso= |refs= |notesfirst=|notes= |further= |extlinks=
 |a=|b= <!--(etc, until:)--> |z=
}}
</pre>

===Parameters===
* <code>name=</code>: change the heading to an alternative name instead of "Contents", or hide it completely by entering <code>name=no</code>
* <code>side=yes</code>: put the "Contents" heading on the left side with a colon, instead of the top without one
* <code>center=yes</code>: float ToC centered in the horizontal middle of the page, instead of floated left
* <code>right=yes</code>: align the ToC horizontally to the right of the page (may require <code><nowiki><br style="clear:right;" /></nowiki></code> after it, depending on page layout), instead of floated left (this parameter is mutually exclusive with the "center" option above, and should be used sparingly and with good reason)
* <code>nobreak=yes</code>: no linebreak between the A-B-C-etc. stuff and the See also/References/etc. stuff (note: does not affect the heading; use <code>side=</code> for that)
* <code>top=yes</code>: enable the "Top" link; this is only useful if this copy of the ToC is a secondary ToC not at the top of the page, e.g. in the middle of a long glossary. (Every rendered page has a hidden <code><nowiki><a name="top" id="top"></a></nowiki></code> above the sitenotice which makes this link work without having to do anything but enable it in the template.)
* <code>num=yes</code>: enable the "0–9" link for numeric entries section (create a heading of <code><nowiki>==0&amp;ndash;9==</nowiki></code> for the link to work)
* <code>sym=yes</code>: enable the "!$@" link for symbolic entries section
* <code>symnum=yes</code>: enable the "!–9" link for combined symbolic and numeric entries section (create a heading of <code><nowiki>==!&amp;ndash;9==</nowiki></code> for the link to work)
* <code>letters=no</code>: suppresses the "A", "B", ..., "Z" entries.
<!-- ------------------------------- Parameters pre1..pre8 -->
* <code>pre1</code> to <code>pre8</code>: list up to 8 extra section headers ''before'' (pre-list) the "ABCDEF" list. These appear as <nowiki>[[#pre1|pre1]]</nowiki>.
* <code>pre1name</code> to <code>pre8name</code>: modifies the way the pre-list section headers appear: <nowiki>[[#pre1|pre1name]]</nowiki>
* <code>pre1link</code> to <code>pre8link</code>: modifies the targets of the pre-list headers: <nowiki>[[pre1link|pre1]]</nowiki>.
* <code>prebreak=yes</code>: set break-line after all pre-list headers
<!-- ------------------------------- Parameters custom1..8 -->
* <code>custom1</code> to <code>custom8</code>: add up to 8 extra "custom" sections after the "ABCDEF" list. These appear as <nowiki>[[#custom1|custom1]]</nowiki>.
* <code>custom1name</code> to <code>custom8name</code>: modifies the way the custom section headers appear: <nowiki>[[#custom1|custom1name]]</nowiki>
* <code>custom1link</code> to <code>custom8link</code>: modifies the targets of the custom sections: <nowiki>[[custom1link|custom1]]</nowiki>. Use this only for linking to another page.  ''Use sparingly!'' About the only legitimate use for this is connecting the sub-pages of multi-page articles, like long lists that have been broken up. Do not repurpose the ToC as a makeshift navbox.
<!-- ------------------------- Parameters seealso, refs...-->
* <code>seealso=yes</code>: enable link to the "See also" section
* <code>notesfirst=yes</code>: enable link to the "Notes" section, but placed before "References"; ''do not use with <code>notes</code>'' (and do observe that it is plural)
* <code>refs=yes</code>: enable link to the "References" section (observe that it is plural)
* <code>notes=yes</code>: enable link to the "Notes" section (observe that it is plural)
* <code>further=yes</code>: enable link to the "Further reading" section
* <code>extlinks=yes</code>: enable link to the "External links" section
* <code>a=</code> through <code>z=</code>: individually disable particular letters that have no entries. ''Use with caution'' and check regularly to make sure that new entries do not require the removal of these parameters. Can also be used to create range links, e.g. "X-Z". ''(See following section for more detailed documentation of this feature.)''
* <code>allowtoc=yes</code>: disables the hiding of the automatically-generated table of contents that <code><nowiki>__NOTOC__</nowiki></code> usually hides. (Since this template's purpose is usually to ''replace the existing table of contents'', this functionality is usually only necessary on Wikipedia guideline pages that use this template in examples.)

== Letters ==
Any letter can be omitted (i.e. when it has no entries in the list) by specifying it as a ''lowercase'' blank parameter, e.g. {{tlx|Compact ToC&#32;|<nowiki>side=yes |j=|q=</nowiki>}}:
{| style="margin-left:3.0em"
| {{Compact ToC |side=yes |j=|q=}}
|}
Or it can be replaced with an unlinked letter by using that letter (in ''uppercase''), e.g. {{tlx|Compact ToC&#32;|<nowiki>side=yes |j=J|q=Q</nowiki>}}:
{| style="margin-left:3.0em"
| {{Compact ToC |side=yes |j=J|q=Q}}
|}
''Note:'' It is often better to create an empty placeholder span (e.g. <code><nowiki><span id="Q"></span></nowiki></code>) where the letter's heading would be in the page if it existed, since in most cases it is quite possible that it will come to exist in the future. Using the span-id avoids confusing readers who might not realize the TOC-template has skipped some letters.

The letter-assignment feature can also be used to create range links, e.g. {{tlx|Compact ToC&#32;|<nowiki>side=yes |x=[[#X–Z|X–Z]] |y=|z=</nowiki>}}:
{| style="margin-left:3.0em"
| {{Compact ToC |side=yes |x=[[#X–Z|X–Z]] |y=|z=}}
|}

The feature can also be used (very tediously) for linking to sub-articles (e.g. [[Wikipedia:Naming conventions (long lists)|long lists]] that have been split into multiple pages):<br/>
{{tlx|Compact ToC&#32;|<nowiki>side=yes |name=[[</nowiki><var>Articlename</var><nowiki>]] |n=[[</nowiki><var>Articlename</var><nowiki> (N–Z)#N|N]] |o=[[</nowiki><var>Articlename</var><nowiki> (N–Z)#O|O]] |... |z=[[</nowiki><var>Articlename</var><nowiki> (N–Z)#Z|Z]]</nowiki>}}
{| style="margin-left:3.0em"
| {{Compact ToC |side=yes |name=[[Articlename]] |n=[[Article (N–Z)#N|N]] |o=[[Articlename (N–Z)#O|O]] |p=[[Articlename (N–Z)#P|P]] |q=[[Articlename (N–Z)#Q|Q]] |r=[[Articlename (N–Z)#R|R]] |s=[[Articlename (N–Z)#S|S]] |t=[[Articlename (N–Z)#T|T]] |u=[[Articlename (N–Z)#U|U]] |v=[[Articlename (N–Z)#V|V]] |w=[[Articlename (N–Z)#W|W]] |x=[[Articlename (N–Z)#X|X]] |y=[[Articlename (N–Z)#Y|Y]] |z=[[Articlename (N–Z)#Z|Z]]}}
|}
{{tlx|Compact ToC&#32;|<nowiki>side=yes |n=[[</nowiki><var>Articlename</var><nowiki> (N–Z)|&nbsp;N–Z {{small|(next page)}}]] |o=|p=|...|z=</nowiki>}}
{| style="margin-left:3.0em"
| {{Compact ToC |side=yes |n=[[Articlename (N–Z)|&nbsp;N–Z {{small|(next page)}}]] |o=|p=|q=|r=|s=|t=|u=|v=|w=|x=|y=|z=}}
|}

== Listing custom headers ==

The optional parameters ''pre1'', ''pre2'', ...''pre8'' and ''custom1'', ''custom2'', ...''custom8'' allow up to 16 other section headers to be listed before or after the "ABCDEF" list:

{{tlx|Compact ToC&#32;|<nowiki>name=no |center=yes |top=yes |custom1=New section |custom2=Additional section |seealso=yes|notes=yes</nowiki>}}
{{Compact ToC
 |name=no |center=yes |top=yes
 |custom1=New section |custom2=Additional section
 |seealso=yes |notes=yes
}}

{{tlx|Compact ToC&#32;|<nowiki>name=no |center=yes |top=yes |custom1=New section|custom1name=Custom section name |custom2=Outside page|custom2link=Main Page |seealso=yes|notes=yes</nowiki>}}
{{Compact ToC
 |name=no |center=yes |top=yes
 |custom1=New section |custom1name=Custom section name
 |custom2=Outside page |custom2link=Main Page
 |seealso=yes |notes=yes
}}

Headers can be listed before & after "ABCDEF" using ''pre1'' and ''custom1''&nbsp;:<br/>
{{tlx|Compact ToC&#32;|<nowiki>center=yes |top=yes |pre1=Scope of list |pre2=Abbreviations used |prebreak=yes |custom1=Popular entries |custom2=Excluded entries |notes=yes|seealso=yes</nowiki>}}
{{Compact ToC
 |center=yes |top=yes
 |pre1=Scope of list |pre2=Abbreviations used |prebreak=yes
 |custom1=Popular entries |custom2=Excluded entries
 |notes=yes |seealso=yes
}}

==="short1"===
<code><nowiki>{{Compact ToC |side=yes |center=yes |nobreak=yes |refs=yes}}</nowiki></code> is a common configuration whose parameters may be replaced by the shortcut
: {{tlx|Compact ToC&#32;|short1}}
i.e. by making <code>{{!}}short1</code> the very first parameter.

== Examples ==

{{tlx|Compact ToC&#32;|<nowiki>top=yes</nowiki>}}
{| style="margin-left:2.0em"
| {{Compact ToC |top=yes}}
|}

{{tlx|Compact ToC&#32;|<nowiki>side=yes |sym=yes|num=yes |custom1=Other |seealso=yes |refs=yes</nowiki>}}
{| style="margin-left:2.0em"
| {{Compact ToC |side=yes |sym=yes|num=yes |custom1=Other |seealso=yes |refs=yes}}
|}

{{tlx|Compact ToC&#32;|<nowiki>name=Directory |top=no |refs=yes|notes=yes|extlinks=yes</nowiki>}}
{| style="margin-left:2.0em"
|{{Compact ToC |name=Directory |top=no |refs=yes|notes=yes|extlinks=yes}}
|}

{{tlx|Compact ToC&#32;|<nowiki>side=yes|right=yes |name=no |symnum=yes |seealso=yes</nowiki>}}
{{Compact ToC |side=yes|right=yes |name=no |symnum=yes |seealso=yes}}<br style="clear:right;"/>

{{tlx|Compact ToC&#32;|<nowiki>short1 |sym=yes|num=yes|seealso=yes|notesfirst=yes|further=yes|extlinks=yes</nowiki>}}
{{Compact ToC |short1 |sym=yes|num=yes|seealso=yes|notesfirst=yes|further=yes|extlinks=yes}}

== Limitations ==
Unfortunately, it is not possible to center the contents due to the lack of supporting CSS in [[MediaWiki:Common.css]].

== See also ==
* [[Help:TOC]]
* [[Template:Horizontal TOC]]
* [[Template:Category TOC]]
* [[Help:Magic words#Behavior switches]] for more help on:
** <nowiki>__NOTOC__</nowiki>
** <nowiki>__TOC__</nowiki>

<includeonly>{{#ifeq:{{SUBPAGENAME}}|sandbox |
| <!--Categories below this line, please; interwikis at Wikidata-->
[[Category:Exclude in print]]
[[Category:Wikipedia table of contents templates]]
[[Category:Templates that add a tracking category]]
}}</includeonly>