Loading
  • 21 Aug, 2019

  • By, Wikipedia

Template:Compact TOC

This is a 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.

Usage

Features

  • This template replaces the regular Table of Contents functionality. If you want a regular Table of Contents on a page where {{Compact TOC}} is in use, use __FORCETOC__ or __TOC__ as explained at HELP:TOC.
  • 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).
    • Set upper headers before "ABCDEF" by pre1, pre2, ... pre12.
    • Set lower headers after "ABCDEF" by custom1, custom2, ... custom12.
  • 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
{{Compact TOC |symnum=yes}}
Alphabetic (i.e. "A", "B", … "Z") links only
{{Compact TOC}}
Common applications
{{Compact TOC |center=yes |seealso=yes |refs=yes |further=yes}}

Full blank syntax

{{Compact TOC
 |side=|center=|right=
 |name=
 |top=

 |pre1=|pre1name=|pre1link=
 |pre2=|pre2name=|pre2link=
 <!--(etc, to:)-->
 |pre12=|pre12name=|pre12link=
 |prebreak=<!--yes-->

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

 |custom1=|custom1name=|custom1link=
 |custom2=|custom2name=|custom2link=
 <!--(etc, to:)-->
 |custom12=|custom12name=|custom12link=

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

Parameters

  • name=: change the heading to an alternative name instead of "Contents", or hide it completely by entering name=no
  • side=yes: put the "Contents" heading on the left side with a colon, instead of the top without one
  • center=yes: float TOC centered in the horizontal middle of the page, instead of floated left
  • right=yes: align the TOC horizontally to the right of the page (may require <br style="clear:right;" /> 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)
  • nobreak=yes: no linebreak between the A-B-C-etc. stuff and the See also/References/etc. stuff (note: does not affect the heading; use side= for that)
  • top=yes: 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 <a name="top" id="top"></a> above the sitenotice which makes this link work without having to do anything but enable it in the template.)
  • num=yes: enable the "0–9" link for numeric entries section (create a heading of ==0&ndash;9== for the link to work)
  • sym=yes: enable the "!$@" link for symbolic entries section
  • symnum=yes: enable the "!–9" link for combined symbolic and numeric entries section (create a heading of ==!&ndash;9== for the link to work)
  • letters=no: suppresses the "A", "B", ..., "Z" entries.
  • pre1 to pre12: list up to 12 extra section headers before (pre-list) the "ABCDEF" list. These appear as [[#pre1|pre1]].
  • pre1name to pre12name: modifies the way the pre-list section headers appear: [[#pre1|pre1name]]
  • pre1link to pre12link: modifies the targets of the pre-list headers: [[pre1link|pre1]].
  • prebreak=yes: set break-line after all pre-list headers
  • custom1 to custom12: add up to 12 extra "custom" sections after the "ABCDEF" list. These appear as [[#custom1|custom1]].
  • custom1name to custom12name: modifies the way the custom section headers appear: [[#custom1|custom1name]]
  • custom1link to custom12link: modifies the targets of the custom sections: [[custom1link|custom1]]. 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.
  • seealso=yes: enable link to the "See also" section
  • notesfirst=yes: enable link to the "Notes" section, but placed before "References"; do not use with notes (and do observe that it is plural)
  • refs=yes: enable link to the "References" section (observe that it is plural)
  • notes=yes: enable link to the "Notes" section (observe that it is plural)
  • further=yes: enable link to the "Further reading" section
  • extlinks=yes: enable link to the "External links" section
  • a= through z=: 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.)
    • The equivalent of this for numbers is 0-9= - note this is a hyphen and not a dash (the heading uses a dash)
  • allowtoc=yes: disables the hiding of the automatically-generated table of contents that __NOTOC__ 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. {{Compact TOC |side=yes |j=|q=}}:

Or it can be replaced with an unlinked letter by using that letter (in uppercase), e.g. {{Compact TOC |side=yes |j=J|q=Q}}:

Note: It is often better to create an empty placeholder span (e.g. <span id="Q"></span>) 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. {{Compact TOC |side=yes |x=[[#X–Z|X–Z]] |y=|z=}}:

Listing custom headers

The optional parameters pre1, pre2, ...pre12 and custom1, custom2, ...custom12 allow up to 24 other section headers to be listed before or after the "ABCDEF" list:

{{Compact TOC |name=no |center=yes |top=yes |custom1=New section |custom2=Additional section |seealso=yes|notes=yes}}

{{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 :
{{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"

{{Compact TOC |side=yes |center=yes |nobreak=yes |refs=yes}} is a common configuration whose parameters may be replaced by the shortcut

{{Compact TOC |short1}}

i.e. by making |short1 the very first parameter.

Hacks

Sub-articles

The omitted letters feature explained above can also be used (very tediously) for linking to sub-articles (e.g. long lists that have been split into multiple pages):
{{Compact TOC |side=yes |name=[[Articlename]] |n=[[Articlename (N–Z)#N|N]] |o=[[Articlename (N–Z)#O|O]] |... |z=[[Articlename (N–Z)#Z|Z]]}}

{{Compact TOC |side=yes |n=[[Articlename (N–Z)| N–Z {{small|(next page)}}]] |o=|p=|...|z=}}

The template offers parameters to enable standard footer sections to be linked from the compact display (see § Parameters (e.g., |refs=yes, |further=yes, and |extlinks=yes and others, above). However, these may add excessive length, and they appear on a separate line, after the letter indexes.

If you happen not to need letter 'Z' as a separate link, as shown in the last example in the Letters section above where it is combined as "X–Z", a hack is available to add an abbreviated link to one of the footer sections. For example, to link to the "References" section as "Refs" after the letter indexes and on the same line, you can do this:

{{Compact TOC |side=yes |x=[[#X–Z|X–Z]] |y= |z=[[#References|Refs]]}}

If you don't need a separate 'Y' link either (same X-Z example in the Letters section), then you can link two footers. Here's an example that links "Refs" to the § References section as in the previous example, and also links "Exts" to the § External links section:

{{Compact TOC |side=yes |x=[[#X–Z|X–Z]] |y=[[#References|Refs]] |z=[[#External links|Exts]]}}

Examples

{{Compact TOC |top=yes}}

{{Compact TOC |center=yes}}

{{Compact TOC |side=yes |sym=yes|num=yes |custom1=Other |seealso=yes |refs=yes}}

{{Compact TOC |name=Directory |top=no |refs=yes|notes=yes|extlinks=yes}}

{{Compact TOC |side=yes|right=yes |name=no |symnum=yes |seealso=yes}}


{{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.

Template data

This is the TemplateData for this template used by TemplateWizard, VisualEditor and other tools. See a monthly parameter usage report for Template:Compact TOC in articles based on its TemplateData.

TemplateData for Compact TOC

Data used by citation tools

No description.

Template parameters[Edit template data]

ParameterDescriptionTypeStatus
11

no description

Unknownoptional
22

no description

Unknownoptional
allowtocallowtoc

no description

Unknownoptional
classclass

no description

Unknownoptional
centercenter

no description

Unknownoptional
namename

no description

Unknownoptional
rightright

no description

Unknownoptional
alignalign

no description

Unknownoptional
sideside

no description

Unknownoptional
toptop

no description

Unknownoptional
pre1pre1

no description

Unknownoptional
preSec1preSec1

no description

Unknownoptional
pre1linkpre1link

no description

Unknownoptional
preSec1linkpreSec1link

no description

Unknownoptional
pre1namepre1name

no description

Unknownoptional
preSec1namepreSec1name

no description

Unknownoptional
pre2pre2

no description

Unknownoptional
preSec2preSec2

no description

Unknownoptional
pre2linkpre2link

no description

Unknownoptional
preSec2linkpreSec2link

no description

Unknownoptional
pre2namepre2name

no description

Unknownoptional
preSec2namepreSec2name

no description

Unknownoptional
pre3pre3

no description

Unknownoptional
preSec3preSec3

no description

Unknownoptional
pre3linkpre3link

no description

Unknownoptional
preSec3linkpreSec3link

no description

Unknownoptional
pre3namepre3name

no description

Unknownoptional
preSec3namepreSec3name

no description

Unknownoptional
pre4pre4

no description

Unknownoptional
preSec4preSec4

no description

Unknownoptional
pre4linkpre4link

no description

Unknownoptional
preSec4linkpreSec4link

no description

Unknownoptional
pre4namepre4name

no description

Unknownoptional
preSec4namepreSec4name

no description

Unknownoptional
pre5pre5

no description

Unknownoptional
preSec5preSec5

no description

Unknownoptional
pre5linkpre5link

no description

Unknownoptional
preSec5linkpreSec5link

no description

Unknownoptional
pre5namepre5name

no description

Unknownoptional
preSec5namepreSec5name

no description

Unknownoptional
pre6pre6

no description

Unknownoptional
preSec6preSec6

no description

Unknownoptional
pre6linkpre6link

no description

Unknownoptional
preSec6linkpreSec6link

no description

Unknownoptional
pre6namepre6name

no description

Unknownoptional
preSec6namepreSec6name

no description

Unknownoptional
pre7pre7

no description

Unknownoptional
preSec7preSec7

no description

Unknownoptional
pre7linkpre7link

no description

Unknownoptional
preSec7linkpreSec7link

no description

Unknownoptional
pre7namepre7name

no description

Unknownoptional
preSec7namepreSec7name

no description

Unknownoptional
pre8pre8

no description

Unknownoptional
preSec8preSec8

no description

Unknownoptional
pre8linkpre8link

no description

Unknownoptional
preSec8linkpreSec8link

no description

Unknownoptional
pre8namepre8name

no description

Unknownoptional
preSec8namepreSec8name

no description

Unknownoptional
pre9pre9

no description

Unknownoptional
preSec9preSec9

no description

Unknownoptional
pre9linkpre9link

no description

Unknownoptional
preSec9linkpreSec9link

no description

Unknownoptional
pre9namepre9name

no description

Unknownoptional
preSec9namepreSec9name

no description

Unknownoptional
pre10pre10

no description

Unknownoptional
preSec10preSec10

no description

Unknownoptional
pre10linkpre10link

no description

Unknownoptional
preSec10linkpreSec10link

no description

Unknownoptional
pre10namepre10name

no description

Unknownoptional
preSec10namepreSec10name

no description

Unknownoptional
pre11pre11

no description

Unknownoptional
preSec11preSec11

no description

Unknownoptional
pre11linkpre11link

no description

Unknownoptional
preSec11linkpreSec11link

no description

Unknownoptional
pre11namepre11name

no description

Unknownoptional
preSec11namepreSec11name

no description

Unknownoptional
pre12pre12

no description

Unknownoptional
preSec12preSec12

no description

Unknownoptional
pre12linkpre12link

no description

Unknownoptional
preSec12linkpreSec12link

no description

Unknownoptional
pre12namepre12name

no description

Unknownoptional
preSec12namepreSec12name

no description

Unknownoptional
prebreakprebreak

no description

Unknownoptional
symsym

no description

Unknownoptional
numnum

no description

Unknownoptional
0-90-9

no description

Unknownoptional
symnumsymnum

no description

Unknownoptional
lettersletters

no description

Unknownoptional
aa

no description

Unknownoptional
bb

no description

Unknownoptional
cc

no description

Unknownoptional
dd

no description

Unknownoptional
ee

no description

Unknownoptional
ff

no description

Unknownoptional
gg

no description

Unknownoptional
hh

no description

Unknownoptional
ii

no description

Unknownoptional
jj

no description

Unknownoptional
kk

no description

Unknownoptional
ll

no description

Unknownoptional
mm

no description

Unknownoptional
nn

no description

Unknownoptional
oo

no description

Unknownoptional
pp

no description

Unknownoptional
qq

no description

Unknownoptional
rr

no description

Unknownoptional
ss

no description

Unknownoptional
tt

no description

Unknownoptional
uu

no description

Unknownoptional
vv

no description

Unknownoptional
ww

no description

Unknownoptional
xx

no description

Unknownoptional
yy

no description

Unknownoptional
zz

no description

Unknownoptional
nobreaknobreak

no description

Unknownoptional
custom1custom1

no description

Unknownoptional
Sec1Sec1

no description

Unknownoptional
custom1linkcustom1link

no description

Unknownoptional
Sec1linkSec1link

no description

Unknownoptional
custom1namecustom1name

no description

Unknownoptional
Sec1nameSec1name

no description

Unknownoptional
custom2custom2

no description

Unknownoptional
Sec2Sec2

no description

Unknownoptional
custom2linkcustom2link

no description

Unknownoptional
Sec2linkSec2link

no description

Unknownoptional
custom2namecustom2name

no description

Unknownoptional
Sec2nameSec2name

no description

Unknownoptional
custom3custom3

no description

Unknownoptional
Sec3Sec3

no description

Unknownoptional
custom3linkcustom3link

no description

Unknownoptional
Sec3linkSec3link

no description

Unknownoptional
custom3namecustom3name

no description

Unknownoptional
Sec3nameSec3name

no description

Unknownoptional
custom4custom4

no description

Unknownoptional
Sec4Sec4

no description

Unknownoptional
custom4linkcustom4link

no description

Unknownoptional
Sec4linkSec4link

no description

Unknownoptional
custom4namecustom4name

no description

Unknownoptional
Sec4nameSec4name

no description

Unknownoptional
custom5custom5

no description

Unknownoptional
Sec5Sec5

no description

Unknownoptional
custom5linkcustom5link

no description

Unknownoptional
Sec5linkSec5link

no description

Unknownoptional
custom5namecustom5name

no description

Unknownoptional
Sec5nameSec5name

no description

Unknownoptional
custom6custom6

no description

Unknownoptional
Sec6Sec6

no description

Unknownoptional
custom6linkcustom6link

no description

Unknownoptional
Sec6linkSec6link

no description

Unknownoptional
custom6namecustom6name

no description

Unknownoptional
Sec6nameSec6name

no description

Unknownoptional
custom7custom7

no description

Unknownoptional
Sec7Sec7

no description

Unknownoptional
custom7linkcustom7link

no description

Unknownoptional
Sec7linkSec7link

no description

Unknownoptional
custom7namecustom7name

no description

Unknownoptional
Sec7nameSec7name

no description

Unknownoptional
custom8custom8

no description

Unknownoptional
Sec8Sec8

no description

Unknownoptional
custom8linkcustom8link

no description

Unknownoptional
Sec8linkSec8link

no description

Unknownoptional
custom8namecustom8name

no description

Unknownoptional
Sec8nameSec8name

no description

Unknownoptional
custom9custom9

no description

Unknownoptional
Sec9Sec9

no description

Unknownoptional
custom9linkcustom9link

no description

Unknownoptional
Sec9linkSec9link

no description

Unknownoptional
custom9namecustom9name

no description

Unknownoptional
Sec9nameSec9name

no description

Unknownoptional
custom10custom10

no description

Unknownoptional
Sec10Sec10

no description

Unknownoptional
custom10linkcustom10link

no description

Unknownoptional
Sec10linkSec10link

no description

Unknownoptional
custom10namecustom10name

no description

Unknownoptional
Sec10nameSec10name

no description

Unknownoptional
custom11custom11

no description

Unknownoptional
Sec11Sec11

no description

Unknownoptional
custom11linkcustom11link

no description

Unknownoptional
Sec11linkSec11link

no description

Unknownoptional
custom11namecustom11name

no description

Unknownoptional
Sec11nameSec11name

no description

Unknownoptional
custom12custom12

no description

Unknownoptional
Sec12Sec12

no description

Unknownoptional
custom12linkcustom12link

no description

Unknownoptional
Sec12linkSec12link

no description

Unknownoptional
custom12namecustom12name

no description

Unknownoptional
Sec12nameSec12name

no description

Unknownoptional
seealsoseealso

no description

Unknownoptional
notesfirstnotesfirst

no description

Unknownoptional
refsrefs

no description

Unknownoptional
notesnotes

no description

Unknownoptional
furtherfurther

no description

Unknownoptional
extlinksextlinks

no description

Unknownoptional

See also