View source for Template:CompactTOC8/doc

{{Documentation subpage}}
<!-- PLEASE ADD CATEGORIES AND INTERWIKIS AT THE BOTTOM OF THIS PAGE -->
{{ {{TNTN|Intricate template}} }}
__TOC__
==Purpose==
This is a Table-of-Contents replacement for alphabetical lists:
:* 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.

==Usage==
'''Typical''':

<code><nowiki>{{</nowiki>'''CompactTOC8'''|symnum=yes<nowiki>}}</nowiki></code>

'''For alphabetical only''' (no number or symbol entries):

<code><nowiki>{{</nowiki>'''CompactTOC8'''<nowiki>}}</nowiki></code>

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

<pre>
{{CompactTOC8
 |name=
 |side=yes
 |center=yes
 |right=
 |align=center
 |nobreak=yes
 |top=yes
 |num=yes
 |sym=yes
 |symnum=
 |pre1=
 |pre1name=
 |pre1link=
 ...
 |pre8=
 |pre8name=
 |pre8link=
 |prebreak=<br>
 |custom1=
 |custom1name=
 |custom1link=
 ...
 |custom8=
 |custom8name=
 |custom8link=
 |seealso=yes
 |notesfirst=
 |refs=yes
 |notes=yes
 |further=yes
 |extlinks=yes
 |a=
 ...
 |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>: center to ToC 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>align=</code>: sets the alignment of the ''links'' inside the table; default is left; use <code>center</code>, <code>right</code> or <code>left</code>
*<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>sym=yes</code>: enable the "!$@" link for symbolic entries section
*<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>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)
<!-- ------------------------------- Parameter: sep -->
*<code>sep=&amp;middot;</code>: set the separator-text between word-headers (not between "ABCDEF") to "&middot;"; could also be a vertical-bar or <code>&amp;bull;</code> (&bull;), etc.
<!-- ------------------------------- 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 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=&lt;br></code>: set break-line after all pre-list headers; can include text to introduce "ABCDEF".
<!-- ------------------------- Parameters seealso, refs...-->
*<code>seealso=yes</code>: enable link to the "See also" section
*<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>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>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 [[#Letters]] below for more detailed documentation of this feature.)''

==Letters==
Any letter can be omitted (i.e. when it has no entries in the list) by specifying it as a ''lower-case'' blank parameter:&nbsp;
{{tlx|CompactTOC8|side&#61;yes|j&#61;|q&#61;}}
{| style="margin-left:3.0em"
|{{CompactTOC8|side=yes|j=|q=}}
|}
Or it can be replaced with an unlinked letter by using that letter ('''upper-case'''):
{{tlx|CompactTOC8|side&#61;yes|j&#61;J|q&#61;Q}}
{| style="margin-left:3.0em"
|{{CompactTOC8|side=yes|j=J|q=Q}}
|}
''Note:'' It is often better to create an empty placeholder span (e.g. <code><nowiki><span id="Q" /></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 new users who might not realize the TOC-template has skipped some letters.

The letter-assignment feature can also be used to create range links:

{{tlx|CompactTOC8|side&#61;yes|x&#61;<nowiki>[[#X-Z|X-Z]]</nowiki>|y&#61;|z&#61;}}
{| style="margin-left:3.0em"
|{{CompactTOC8|side=yes|x=[[#X-Z|X-Z]]|y=|z=}}
|}
The feature can also be used (very tediously) for linking to sub-articles (e.g., for [[Wikipedia:Naming conventions (long lists)|long lists]] that have been split into multiple pages):

{{tlx|CompactTOC8|name&#61;<nowiki>[[</nowiki><var>Articlename</var><nowiki>]]</nowiki>|side&#61;yes|n&#61;<nowiki>[[</nowiki><var>Articlename</var> (N–Z)#N|N<nowiki>]]</nowiki>|o&#61;<nowiki>[[</nowiki><var>Articlename</var> (N–Z)#O|O<nowiki>]]</nowiki>|...|z&#61;<nowiki>[[</nowiki><var>Articlename</var> (N–Z)#Z|Z<nowiki>]]</nowiki>}}

{| style="margin-left:3.0em"
|{{CompactTOC8|name=[[Articlename]]|side=yes|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]]}}
|}

Or, as another example:

{{tlx|CompactTOC8|side&#61;yes|n&#61;<nowiki>[[</nowiki><var>Articlename</var> (N–Z)|&amp;nbsp;N–Z <small>(next page)</small><nowiki>]]</nowiki>|o&#61;|p&#61;|...|z&#61;}}

{| style="margin-left:3.0em"
|{{CompactTOC8|side=yes|n=[[Articlename (N–Z)|&nbsp;N–Z <small>(next page)</small>]]|o=|p=|q=|r=|s=|t=|u=|v=|w=|x=|y=|z=}}
|}

==Listing custom-headers==
The optional parameters pre1...pre8 and custom1...custom8 allow listing up to 16 other section-headers in the TOC, before or after, the "ABCDEF" list:

{{tlx|CompactTOC8|name&#61;no|center&#61;yes|top&#61;yes|seealso&#61;yes|notes&#61;yes|custom1&#61;New section|custom2&#61;Additional section}}
{{CompactTOC8|name=no|center=yes|top=yes|seealso=yes|notes=yes|custom1=New section|custom2=Additional section}}

{{tlx|CompactTOC8|name&#61;no|center&#61;yes|top&#61;yes|seealso&#61;yes|notes&#61;yes|custom1&#61;New section|custom1name&#61;Custom section name|custom2&#61;Outside page|custom2link&#61;Main Page}}
{{CompactTOC8|name=no|center=yes|top=yes|seealso=yes|notes=yes|custom1=New section|custom1name=Custom section name|custom2=Outside page|custom2link=Main Page}}

<br>Headers can be listed before & after "ABCDEF" using pre1 & custom1:
: {{tlx|CompactTOC8|center&#61;yes|align&#61;center|top&#61;yes|seealso&#61;yes<br>|pre1&#61;Scope of list|pre2&#61;Abbreviations used|prebreak&#61;&lt;br><br>|custom1&#61;Popular entries|custom2&#61;Excluded entries|notes&#61;yes}}
{{CompactTOC8|center=yes|align=center|top=yes|seealso=yes|pre1=Scope of list|pre2=Abbreviations used|prebreak=<br>|custom1=Popular entries|custom2=Excluded entries|notes=yes}}

<br>The separator text can be set to a mid-dot by "sep=&amp;middot;" :
: {{tlx|CompactTOC8|center&#61;yes|align&#61;center|top&#61;yes|seealso&#61;yes<br>|pre1&#61;Scope of list|pre2&#61;Abbreviations used|prebreak&#61;&lt;br><br>|custom1&#61;Popular entries|custom2&#61;Excluded entries|sep&#61;'''<nowiki>'''&amp;middot;'''</nowiki>'''}}
{{CompactTOC8|center=yes|align=center|top=yes|seealso=yes|pre1=Scope of list|pre2=Abbreviations used|prebreak=<br>|custom1=Popular entries|custom2=Excluded entries|notes=yes|sep='''&middot;'''}}

====Shorthand====
* <code>short1</code> can be used as the very first parameter (before <code>name=</code>) for shortening a common usage:

{{tlx|CompactTOC8|short1}}

{{CompactTOC8|short1}}

It replaces <nowiki>{{CompactTOC8|side=yes|center=yes|nobreak=yes|refs=yes}}</nowiki>

==Examples==
{{tlx|CompactTOC8|top&#61;yes}} <!--Example: top=yes -->
{| style="margin-left:2.0em"
|{{CompactTOC8|top=yes}}
|}

{{tlx|CompactTOC8|side&#61;yes|sym&#61;yes|num&#61;yes|refs&#61;yes|seealso&#61;yes|custom1&#61;Other}}
{| style="margin-left:2.0em"
|{{CompactTOC8|side=yes|sym=yes|num=yes|refs=yes|custom1=Other}}
|}

{{tlx|CompactTOC8|name&#61;Directory|top&#61;no|refs&#61;yes|notes&#61;yes|extlinks&#61;yes}}
{| style="margin-left:2.0em"
|{{CompactTOC8|name=Directory|top=no|refs=yes|notes=yes|extlinks=yes}}
|}

{{tlx|CompactTOC8|name&#61;no|side&#61;yes|right&#61;yes|symnum&#61;yes|seealso&#61;yes}}
{{CompactTOC8|name=no|side=yes|right=yes|symnum=yes|seealso=yes}}<br style="clear:right;" />

{{tlx|CompactTOC8|short1|num&#61;yes|sym&#61;yes|seealso&#61;yes|notesfirst&#61;yes|further&#61;yes|extlinks&#61;yes}}
{{CompactTOC8|short1|num=yes|sym=yes|seealso=yes|notesfirst=yes|further=yes|extlinks=yes}}

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

<includeonly><!-- CATEGORIES AND INTERWIKIS HERE, THANKS -->
[[Category:Exclude in print]]
[[Category:Formatting templates]]

</includeonly>