Cèṭa'an:Compact TOC/doc

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–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 ==!–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=}}

Abbreviated footer links

The template offers parameters to enable standard 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 . 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

Ariya dokumenna TemplateData ka'angghuy template nèka èghuna'aghi bi' VisualEditor tor alat laènna; see a monthly parameter usage report for this template in articles.

TemplateData untuk Compact TOC

Data used by citation tools

Tidak ada keterangan. Parameter templat Parameter Keterangan Jenis Status 1 1 tidak ada keterangan Tak dikenal opsional 2 2 tidak ada keterangan Tak dikenal opsional allowtoc allowtoc tidak ada keterangan Tak dikenal opsional class class tidak ada keterangan Tak dikenal opsional center center tidak ada keterangan Tak dikenal opsional name name tidak ada keterangan Tak dikenal opsional right right tidak ada keterangan Tak dikenal opsional align align tidak ada keterangan Tak dikenal opsional side side tidak ada keterangan Tak dikenal opsional top top tidak ada keterangan Tak dikenal opsional pre1 pre1 tidak ada keterangan Tak dikenal opsional preSec1 preSec1 tidak ada keterangan Tak dikenal opsional pre1link pre1link tidak ada keterangan Tak dikenal opsional preSec1link preSec1link tidak ada keterangan Tak dikenal opsional pre1name pre1name tidak ada keterangan Tak dikenal opsional preSec1name preSec1name tidak ada keterangan Tak dikenal opsional pre2 pre2 tidak ada keterangan Tak dikenal opsional preSec2 preSec2 tidak ada keterangan Tak dikenal opsional pre2link pre2link tidak ada keterangan Tak dikenal opsional preSec2link preSec2link tidak ada keterangan Tak dikenal opsional pre2name pre2name tidak ada keterangan Tak dikenal opsional preSec2name preSec2name tidak ada keterangan Tak dikenal opsional pre3 pre3 tidak ada keterangan Tak dikenal opsional preSec3 preSec3 tidak ada keterangan Tak dikenal opsional pre3link pre3link tidak ada keterangan Tak dikenal opsional preSec3link preSec3link tidak ada keterangan Tak dikenal opsional pre3name pre3name tidak ada keterangan Tak dikenal opsional preSec3name preSec3name tidak ada keterangan Tak dikenal opsional pre4 pre4 tidak ada keterangan Tak dikenal opsional preSec4 preSec4 tidak ada keterangan Tak dikenal opsional pre4link pre4link tidak ada keterangan Tak dikenal opsional preSec4link preSec4link tidak ada keterangan Tak dikenal opsional pre4name pre4name tidak ada keterangan Tak dikenal opsional preSec4name preSec4name tidak ada keterangan Tak dikenal opsional pre5 pre5 tidak ada keterangan Tak dikenal opsional preSec5 preSec5 tidak ada keterangan Tak dikenal opsional pre5link pre5link tidak ada keterangan Tak dikenal opsional preSec5link preSec5link tidak ada keterangan Tak dikenal opsional pre5name pre5name tidak ada keterangan Tak dikenal opsional preSec5name preSec5name tidak ada keterangan Tak dikenal opsional pre6 pre6 tidak ada keterangan Tak dikenal opsional preSec6 preSec6 tidak ada keterangan Tak dikenal opsional pre6link pre6link tidak ada keterangan Tak dikenal opsional preSec6link preSec6link tidak ada keterangan Tak dikenal opsional pre6name pre6name tidak ada keterangan Tak dikenal opsional preSec6name preSec6name tidak ada keterangan Tak dikenal opsional pre7 pre7 tidak ada keterangan Tak dikenal opsional preSec7 preSec7 tidak ada keterangan Tak dikenal opsional pre7link pre7link tidak ada keterangan Tak dikenal opsional preSec7link preSec7link tidak ada keterangan Tak dikenal opsional pre7name pre7name tidak ada keterangan Tak dikenal opsional preSec7name preSec7name tidak ada keterangan Tak dikenal opsional pre8 pre8 tidak ada keterangan Tak dikenal opsional preSec8 preSec8 tidak ada keterangan Tak dikenal opsional pre8link pre8link tidak ada keterangan Tak dikenal opsional preSec8link preSec8link tidak ada keterangan Tak dikenal opsional pre8name pre8name tidak ada keterangan Tak dikenal opsional preSec8name preSec8name tidak ada keterangan Tak dikenal opsional pre9 pre9 tidak ada keterangan Tak dikenal opsional preSec9 preSec9 tidak ada keterangan Tak dikenal opsional pre9link pre9link tidak ada keterangan Tak dikenal opsional preSec9link preSec9link tidak ada keterangan Tak dikenal opsional pre9name pre9name tidak ada keterangan Tak dikenal opsional preSec9name preSec9name tidak ada keterangan Tak dikenal opsional pre10 pre10 tidak ada keterangan Tak dikenal opsional preSec10 preSec10 tidak ada keterangan Tak dikenal opsional pre10link pre10link tidak ada keterangan Tak dikenal opsional preSec10link preSec10link tidak ada keterangan Tak dikenal opsional pre10name pre10name tidak ada keterangan Tak dikenal opsional preSec10name preSec10name tidak ada keterangan Tak dikenal opsional pre11 pre11 tidak ada keterangan Tak dikenal opsional preSec11 preSec11 tidak ada keterangan Tak dikenal opsional pre11link pre11link tidak ada keterangan Tak dikenal opsional preSec11link preSec11link tidak ada keterangan Tak dikenal opsional pre11name pre11name tidak ada keterangan Tak dikenal opsional preSec11name preSec11name tidak ada keterangan Tak dikenal opsional pre12 pre12 tidak ada keterangan Tak dikenal opsional preSec12 preSec12 tidak ada keterangan Tak dikenal opsional pre12link pre12link tidak ada keterangan Tak dikenal opsional preSec12link preSec12link tidak ada keterangan Tak dikenal opsional pre12name pre12name tidak ada keterangan Tak dikenal opsional preSec12name preSec12name tidak ada keterangan Tak dikenal opsional prebreak prebreak tidak ada keterangan Tak dikenal opsional sym sym tidak ada keterangan Tak dikenal opsional num num tidak ada keterangan Tak dikenal opsional 0-9 0-9 tidak ada keterangan Tak dikenal opsional symnum symnum tidak ada keterangan Tak dikenal opsional letters letters tidak ada keterangan Tak dikenal opsional a a tidak ada keterangan Tak dikenal opsional b b tidak ada keterangan Tak dikenal opsional c c tidak ada keterangan Tak dikenal opsional d d tidak ada keterangan Tak dikenal opsional e e tidak ada keterangan Tak dikenal opsional f f tidak ada keterangan Tak dikenal opsional g g tidak ada keterangan Tak dikenal opsional h h tidak ada keterangan Tak dikenal opsional i i tidak ada keterangan Tak dikenal opsional j j tidak ada keterangan Tak dikenal opsional k k tidak ada keterangan Tak dikenal opsional l l tidak ada keterangan Tak dikenal opsional m m tidak ada keterangan Tak dikenal opsional n n tidak ada keterangan Tak dikenal opsional o o tidak ada keterangan Tak dikenal opsional p p tidak ada keterangan Tak dikenal opsional q q tidak ada keterangan Tak dikenal opsional r r tidak ada keterangan Tak dikenal opsional s s tidak ada keterangan Tak dikenal opsional t t tidak ada keterangan Tak dikenal opsional u u tidak ada keterangan Tak dikenal opsional v v tidak ada keterangan Tak dikenal opsional w w tidak ada keterangan Tak dikenal opsional x x tidak ada keterangan Tak dikenal opsional y y tidak ada keterangan Tak dikenal opsional z z tidak ada keterangan Tak dikenal opsional nobreak nobreak tidak ada keterangan Tak dikenal opsional custom1 custom1 tidak ada keterangan Tak dikenal opsional Sec1 Sec1 tidak ada keterangan Tak dikenal opsional custom1link custom1link tidak ada keterangan Tak dikenal opsional Sec1link Sec1link tidak ada keterangan Tak dikenal opsional custom1name custom1name tidak ada keterangan Tak dikenal opsional Sec1name Sec1name tidak ada keterangan Tak dikenal opsional custom2 custom2 tidak ada keterangan Tak dikenal opsional Sec2 Sec2 tidak ada keterangan Tak dikenal opsional custom2link custom2link tidak ada keterangan Tak dikenal opsional Sec2link Sec2link tidak ada keterangan Tak dikenal opsional custom2name custom2name tidak ada keterangan Tak dikenal opsional Sec2name Sec2name tidak ada keterangan Tak dikenal opsional custom3 custom3 tidak ada keterangan Tak dikenal opsional Sec3 Sec3 tidak ada keterangan Tak dikenal opsional custom3link custom3link tidak ada keterangan Tak dikenal opsional Sec3link Sec3link tidak ada keterangan Tak dikenal opsional custom3name custom3name tidak ada keterangan Tak dikenal opsional Sec3name Sec3name tidak ada keterangan Tak dikenal opsional custom4 custom4 tidak ada keterangan Tak dikenal opsional Sec4 Sec4 tidak ada keterangan Tak dikenal opsional custom4link custom4link tidak ada keterangan Tak dikenal opsional Sec4link Sec4link tidak ada keterangan Tak dikenal opsional custom4name custom4name tidak ada keterangan Tak dikenal opsional Sec4name Sec4name tidak ada keterangan Tak dikenal opsional custom5 custom5 tidak ada keterangan Tak dikenal opsional Sec5 Sec5 tidak ada keterangan Tak dikenal opsional custom5link custom5link tidak ada keterangan Tak dikenal opsional Sec5link Sec5link tidak ada keterangan Tak dikenal opsional custom5name custom5name tidak ada keterangan Tak dikenal opsional Sec5name Sec5name tidak ada keterangan Tak dikenal opsional custom6 custom6 tidak ada keterangan Tak dikenal opsional Sec6 Sec6 tidak ada keterangan Tak dikenal opsional custom6link custom6link tidak ada keterangan Tak dikenal opsional Sec6link Sec6link tidak ada keterangan Tak dikenal opsional custom6name custom6name tidak ada keterangan Tak dikenal opsional Sec6name Sec6name tidak ada keterangan Tak dikenal opsional custom7 custom7 tidak ada keterangan Tak dikenal opsional Sec7 Sec7 tidak ada keterangan Tak dikenal opsional custom7link custom7link tidak ada keterangan Tak dikenal opsional Sec7link Sec7link tidak ada keterangan Tak dikenal opsional custom7name custom7name tidak ada keterangan Tak dikenal opsional Sec7name Sec7name tidak ada keterangan Tak dikenal opsional custom8 custom8 tidak ada keterangan Tak dikenal opsional Sec8 Sec8 tidak ada keterangan Tak dikenal opsional custom8link custom8link tidak ada keterangan Tak dikenal opsional Sec8link Sec8link tidak ada keterangan Tak dikenal opsional custom8name custom8name tidak ada keterangan Tak dikenal opsional Sec8name Sec8name tidak ada keterangan Tak dikenal opsional custom9 custom9 tidak ada keterangan Tak dikenal opsional Sec9 Sec9 tidak ada keterangan Tak dikenal opsional custom9link custom9link tidak ada keterangan Tak dikenal opsional Sec9link Sec9link tidak ada keterangan Tak dikenal opsional custom9name custom9name tidak ada keterangan Tak dikenal opsional Sec9name Sec9name tidak ada keterangan Tak dikenal opsional custom10 custom10 tidak ada keterangan Tak dikenal opsional Sec10 Sec10 tidak ada keterangan Tak dikenal opsional custom10link custom10link tidak ada keterangan Tak dikenal opsional Sec10link Sec10link tidak ada keterangan Tak dikenal opsional custom10name custom10name tidak ada keterangan Tak dikenal opsional Sec10name Sec10name tidak ada keterangan Tak dikenal opsional custom11 custom11 tidak ada keterangan Tak dikenal opsional Sec11 Sec11 tidak ada keterangan Tak dikenal opsional custom11link custom11link tidak ada keterangan Tak dikenal opsional Sec11link Sec11link tidak ada keterangan Tak dikenal opsional custom11name custom11name tidak ada keterangan Tak dikenal opsional Sec11name Sec11name tidak ada keterangan Tak dikenal opsional custom12 custom12 tidak ada keterangan Tak dikenal opsional Sec12 Sec12 tidak ada keterangan Tak dikenal opsional custom12link custom12link tidak ada keterangan Tak dikenal opsional Sec12link Sec12link tidak ada keterangan Tak dikenal opsional custom12name custom12name tidak ada keterangan Tak dikenal opsional Sec12name Sec12name tidak ada keterangan Tak dikenal opsional seealso seealso tidak ada keterangan Tak dikenal opsional notesfirst notesfirst tidak ada keterangan Tak dikenal opsional refs refs tidak ada keterangan Tak dikenal opsional notes notes tidak ada keterangan Tak dikenal opsional further further tidak ada keterangan Tak dikenal opsional extlinks extlinks tidak ada keterangan Tak dikenal opsional

Redirect

{{CompactTOC}}

See also

• Help:TOC
• {{Horizontal TOC}}
• {{Category TOC}}
• {{TOC limit}}
• {{TOC hidden}}
• Help:Magic words#Behavior switches for more help on:
  • __NOTOC__
  • __TOC__