Template:Compact ToC: Difference between revisions

Revision as of 20:00, 3 June 2007

Contents
A B C D E F G H I J K L M N O P Q R S T U V W X Y Z

Template:Intricate template

Purpose

This Table of Contents replacement for alphabetical lists provides all the features of Template:CompactTOC7, plus ones from Template:CompactTOC2, etc. that #7 doesn't have (the "Top" "0-9" sections, optionally), and allows you to select what other sections you want. Even the centering is optional, and you can have the "Contents" heading on the top (default) or the side.

Usage

{{CompactTOC8|side=yes|center=yes|nobreak=yes|top=yes|num=yes|sym=yes|symnum=yes|seealso=yes|refs=yes|notes=yes|extlinks=yes}}

or

{{CompactTOC8 |side=yes |center=yes |nobreak=yes |top=yes |num=yes |sym=yes |symnum=yes |seealso=yes |refs=yes |notes=yes |extlinks=yes }}

for all features (leave off or change to "no" to disable a feature}}

Parameters

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)
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 (requires <span name="top"></span> at the top of the page)
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)
seealso=yes — enable link to the "See also" section (note that it is plural)
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)
extlinks=yes — enable link to the "External links" section

Examples

{{CompactTOC8|top=yes}} Template:CompactTOC8

{{CompactTOC8|center=yes|top=yes|seealso=yes}} Template:CompactTOC8

{{CompactTOC8|side=yes|sym=yes|num=yes|refs=yes}} Template:CompactTOC8

{{CompactTOC8|top=no|refs=yes|notes=yes|extlinks=yes}} Template:CompactTOC8

{{CompactTOC8|side=yes|right=yes|symnum=yes|seealso=yes}} Template:CompactTOC8

{{CompactTOC8|side=yes|center=yes|nobreak=yes|top=yes|num=yes|sym=yes|seealso=yes|refs=yes|notes=yes|extlinks=yes}} Template:CompactTOC8

@@ Line 26: / Line 26: @@
 *<code>side=yes</code> &mdash; put the "Contents" heading on the left side with a colon, instead of the top without one
 *<code>center=yes</code> &mdash; center to ToC in the horizontal middle of the page, instead of floated left
-*<code>right=yes</code> &mdash; align the ToC horizontally to the right of the page, instead of floated left (this parameter is mutually exclusive with the "center" option above, and should be used sparingly and with good reason)
+*<code>right=yes</code> &mdash; 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> &mdash; 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> &mdash; 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 (requires <code><nowiki><span name="top"></span></nowiki></code> at the top of the page)