Template:CompactTOC

Name: CompactTOC Types: Navigation Formatting Sub-Template: No Designers: Somestrangeflea Max

Usage

Typical:

{{CompactTOC|symnum=yes}}

For alphabetical only (no number or symbol entries):

{{CompactTOC}}

For maximum number of features and centered placement (leave off a parameter or change it to blank or "no" to disable a feature

{{CompactTOC|name=Contents|side=yes|center=yes|right=|align=center|nobreak=yes|top=yes|num=yes|sym=yes|symnum=|custom1=|custom2=|custom3=|seealso=yes|notesfirst=|refs=yes|notes=yes|extlinks=yes}}

or

{{CompactTOC
|name=
|side=yes
|center=yes
|right=
|align=center
|nobreak=yes
|top=yes
|num=yes
|sym=yes
|symnum=
|custom1=
|custom2=
|custom3=
|seealso=yes
|notesfirst=
|refs=yes
|notes=yes
|extlinks=yes
|a=
...
|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 — center to ToC 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)
• align= — sets the alignment of the links inside the table; default is left; use center, right or left
• 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 at the bottom (or middle, theoretically) of the page, as a secondary ToC (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)
• sym=yes — enable the "!$@" link for symbolic entries section
• num=yes — enable the "0–9" link for numeric entries section (note that it is "–", the en-dash, not "-", the hyphen-minus at upper right of most keyboards)
• symnum=yes — enable the "!–9" link for combined symbolic and numeric entries section (note that it is "–" not "-", and that the preceding two options are mutually exclusive with this one)
• custom1, custom2 and custom3 — add up to 3 extra "custom" sections at the end of the list (alternatively Sec1, Sec2, Sec3)
• seealso=yes — enable link to the "See also" section
• refs=yes — enable link to the "References" section (note that it is plural)
• notes=yes — enable link to the "Notes" section (note that it is plural)
• notesfirst=yes — enable link to the "Notes" section, but placed before "References"; do not use with notes (note that it is plural)
• extlinks=yes — enable link to the "External links" section

Letters

Any letter can be deleted by adding it as a lowercase blank parameter, or replaced with an unlinked letter by using that letter: {{CompactTOC|side=yes|j=|q=}}

{{CompactTOC|side=yes|j=J|q=Q}}

With a little more work, one can create range links:

{{CompactTOC|side=yes|x=[[#X-Z|X-Z]]|y=|z=}} (or x=|y=|z=[[#X-Z|X-Z]] etc.)

Shorthand

For quicker referencing common usage, short1 can be entered as the first parameter (before name=): {{CompactTOC|short1}}

Examples

{{CompactTOC|top=yes}}

{{CompactTOC|name=no|center=yes|top=yes|custom1=New section|...}}

{{CompactTOC|side=yes|sym=yes|num=yes|refs=yes|...}}

{{CompactTOC|name=Directory|top=no|refs=yes|notes=yes|...}}

{{CompactTOC|name=no|side=yes|right=yes|symnum=yes|...}}

{{CompactTOC|short1|num=yes|sym=yes|seealso=yes|notesfirst=yes|extlinks=yes}}