Template:Compact ToC/doc - Revision history

Dmarcadmin: 12 revisions imported

2015-07-17T02:56:59Z

12 revisions imported

New page

{{Documentation subpage}}
{{Intricate template}}
{{tsh|TOC|Toc}}


This is a [[H:TOC|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.
__TOC__

== Usage ==
; Features
* 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.

; Typical use : <nowiki>{{Compact ToC |symnum=yes}}</nowiki>

; Alphabetic (i.e. "A", "B", … "Z") links only : <nowiki>{{Compact ToC}}</nowiki>

; Common applications : <nowiki>{{Compact ToC |center=yes |seealso=yes|refs=yes|further=yes}}</nowiki>

===Full blank syntax===
<pre>
{{Compact ToC
|side=|center=|right=
|name=
|top=

|pre1=|pre1name=|pre1link=
|pre2=|pre2name=|pre2link=

|pre8=|pre8name=|pre8link=
|prebreak=

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

|custom1=|custom1name=|custom1link=
|custom2=|custom2name=|custom2link=

|custom8=|custom8name=|custom8link=

|nobreak=
|seealso= |refs= |notesfirst=|notes= |further= |extlinks=
|a=|b=  |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> </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>: 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>num=yes</code>: enable the "0–9" link for numeric entries section (create a heading of <code><nowiki>==0&ndash;9==</nowiki></code> for the link to work)
*<code>sym=yes</code>: enable the "!$@" link for symbolic entries section
*<code>symnum=yes</code>: enable the "!–9" link for combined symbolic and numeric entries section (create a heading of <code><nowiki>==!&ndash;9==</nowiki></code> for the link to work)
*<code>letters=no</code>: suppresses the "A", "B", ..., "Z" entries.

*<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=yes</code>: set break-line after all pre-list headers

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

*<code>seealso=yes</code>: enable link to the "See also" section
*<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>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>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 following section for more detailed documentation of this feature.)''
*<code>allowtoc=yes</code>: disables the hiding of the automatically-generated table of contents that <code><nowiki>__NOTOC__</nowiki></code> 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. {{tlx|Compact ToC |<nowiki>side=yes |j=|q=</nowiki>}}:
{| style="margin-left:3.0em"
| {{Compact ToC |side=yes |j=|q=}}
|}
Or it can be replaced with an unlinked letter by using that letter (in ''uppercase''), e.g. {{tlx|Compact ToC |<nowiki>side=yes |j=J|q=Q</nowiki>}}:
{| style="margin-left:3.0em"
| {{Compact ToC |side=yes |j=J|q=Q}}
|}
''Note:'' It is often better to create an empty placeholder span (e.g. <code><nowiki></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, e.g. {{tlx|Compact ToC |<nowiki>side=yes |x=[[#X-Z|X-Z]] |y=|z=</nowiki>}}:
{| style="margin-left:3.0em"
| {{Compact ToC |side=yes |x=[[#X-Z|X-Z]] |y=|z=}}
|}

The feature can also be used (very tediously) for linking to sub-articles (e.g. [[Wikipedia:Naming conventions (long lists)|long lists]] that have been split into multiple pages): 
{{tlx|Compact ToC |<nowiki>side=yes |name=[[</nowiki><var>Articlename</var><nowiki>]] |n=[[</nowiki><var>Articlename</var><nowiki> (N–Z)#N|N]] |o=[[</nowiki><var>Articlename</var><nowiki> (N–Z)#O|O]] |... |z=[[</nowiki><var>Articlename</var><nowiki> (N–Z)#Z|Z]]</nowiki>}}
{| style="margin-left:3.0em"
| {{Compact ToC |side=yes |name=[[Articlename]] |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]]}}
|}
{{tlx|Compact ToC |<nowiki>side=yes |n=[[</nowiki><var>Articlename</var><nowiki> (N–Z)| N–Z {{small|(next page)}}]] |o=|p=|...|z=</nowiki>}}
{| style="margin-left:3.0em"
| {{Compact ToC |side=yes |n=[[Articlename (N–Z)| N–Z {{small|(next page)}}]] |o=|p=|q=|r=|s=|t=|u=|v=|w=|x=|y=|z=}}
|}

== Listing custom headers ==

The optional parameters ''pre1'', ''pre2'', ...''pre8'' and ''custom1'', ''custom2'', ...''custom8'' allow up to 16 other section headers to be listed before or after the "ABCDEF" list:

{{tlx|Compact ToC |<nowiki>name=no |center=yes |top=yes |custom1=New section |custom2=Additional section |seealso=yes|notes=yes</nowiki>}}
{{Compact ToC
|name=no |center=yes |top=yes
|custom1=New section |custom2=Additional section
|seealso=yes |notes=yes
}}

{{tlx|Compact ToC |<nowiki>name=no |center=yes |top=yes |custom1=New section|custom1name=Custom section name |custom2=Outside page|custom2link=Main Page |seealso=yes|notes=yes</nowiki>}}
{{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'' : 
{{tlx|Compact ToC |<nowiki>center=yes |top=yes |pre1=Scope of list |pre2=Abbreviations used |prebreak=yes |custom1=Popular entries |custom2=Excluded entries |notes=yes|seealso=yes</nowiki>}}
{{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"===
<code><nowiki>{{Compact ToC |side=yes |center=yes |nobreak=yes |refs=yes}}</nowiki></code> is a common configuration whose parameters may be replaced by the shortcut
: {{tlx|Compact ToC |short1}}
i.e. by making <code>{{!}}short1</code> the very first parameter.

== Examples ==

{{tlx|Compact ToC |<nowiki>top=yes</nowiki>}}
{| style="margin-left:2.0em"
| {{Compact ToC |top=yes}}
|}

{{tlx|Compact ToC |<nowiki>side=yes |sym=yes|num=yes |custom1=Other |refs=yes|seealso=yes</nowiki>}}
{| style="margin-left:2.0em"
| {{Compact ToC |side=yes |sym=yes|num=yes |custom1=Other |refs=yes|seealso=yes}}
|}

{{tlx|Compact ToC |<nowiki>name=Directory |top=no |refs=yes|notes=yes|extlinks=yes</nowiki>}}
{| style="margin-left:2.0em"
|{{Compact ToC |name=Directory |top=no |refs=yes|notes=yes|extlinks=yes}}
|}

{{tlx|Compact ToC |<nowiki>side=yes|right=yes |name=no |symnum=yes |seealso=yes</nowiki>}}
{{Compact ToC |side=yes|right=yes |name=no |symnum=yes |seealso=yes}} 

{{tlx|Compact ToC |<nowiki>short1 |num=yes|sym=yes |seealso=yes|notesfirst=yes|further=yes|extlinks=yes</nowiki>}}
{{Compact ToC |short1 |num=yes|sym=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]].

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

<includeonly>{{#ifeq:{{SUBPAGENAME}}|sandbox |
| 
[[Category:Exclude in print]]
[[Category:List templates]]
[[Category:Wikipedia table of contents templates]]
}}</includeonly>

178.239.50.146: /* See also */

2013-02-28T18:22:05Z

See also

New page

{{Documentation subpage}}

{{Intricate template}}
{{tsh|TOC|Toc}}
__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.
The template has all features of other TOC templates, such as optional "Top" "0–9" sections, ''and'' allows selecting other sections.

==Usage==
;Typical:

<nowiki>{{Compact ToC|symnum=yes}}</nowiki>

;For alphabetical only

<nowiki>{{Compact ToC}}</nowiki>

;For common applications:

<nowiki>{{Compact ToC|center=yes|seealso=yes|refs=yes|further=yes}}</nowiki>

:or vertical:

<pre>
{{Compact ToC
|center = yes
|seealso = yes
|refs = yes
|further = yes
}}
</pre>

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

<pre>
{{Compact ToC
|name=
|side=yes
|center=yes
|right=
|align=center
|nobreak=yes
|top=yes
|num=yes
|sym=yes
|symnum=
|pre1=
|pre1name=
|pre1link=
...
|pre8=
|pre8name=
|pre8link=
|prebreak= 
|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> </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&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>==!&ndash;9==</nowiki></code> for the link to work)

*<code>sep=&middot;</code>: set the separator-text between word-headers (not between "ABCDEF") to "·"; could also be a vertical-bar or <code>&bull;</code> (•), etc.

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

*<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= </code>: set break-line after all pre-list headers; can include text to introduce "ABCDEF".

*<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: 
{{tlx|Compact ToC|side=yes|j=|q=}}
{| style="margin-left:3.0em"
|{{Compact ToC|side=yes|j=|q=}}
|}
Or it can be replaced with an unlinked letter by using that letter ('''upper-case'''):
{{tlx|Compact ToC|side=yes|j=J|q=Q}}
{| style="margin-left:3.0em"
|{{Compact ToC|side=yes|j=J|q=Q}}
|}
''Note:'' It is often better to create an empty placeholder span (e.g. <code><nowiki></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|Compact ToC|side=yes|x=<nowiki>[[#X-Z|X-Z]]</nowiki>|y=|z=}}
{| style="margin-left:3.0em"
|{{Compact ToC|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|Compact ToC|name=<nowiki>[[</nowiki><var>Articlename</var><nowiki>]]</nowiki>|side=yes|n=<nowiki>[[</nowiki><var>Articlename</var> (N–Z)#N|N<nowiki>]]</nowiki>|o=<nowiki>[[</nowiki><var>Articlename</var> (N–Z)#O|O<nowiki>]]</nowiki>|...|z=<nowiki>[[</nowiki><var>Articlename</var> (N–Z)#Z|Z<nowiki>]]</nowiki>}}

{| style="margin-left:3.0em"
|{{Compact ToC|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|Compact ToC|side=yes|n=<nowiki>[[</nowiki><var>Articlename</var> (N–Z)|&nbsp;N–Z (next page)<nowiki>]]</nowiki>|o=|p=|...|z=}}

{| style="margin-left:3.0em"
|{{Compact ToC|side=yes|n=[[Articlename (N–Z)| N–Z (next page)]]|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|Compact ToC|name=no|center=yes|top=yes|seealso=yes|notes=yes|custom1=New section|custom2=Additional section}}
{{Compact ToC|name=no|center=yes|top=yes|seealso=yes|notes=yes|custom1=New section|custom2=Additional section}}

{{tlx|Compact ToC|name=no|center=yes|top=yes|seealso=yes|notes=yes|custom1=New section|custom1name=Custom section name|custom2=Outside page|custom2link=Main Page}}
{{Compact ToC|name=no|center=yes|top=yes|seealso=yes|notes=yes|custom1=New section|custom1name=Custom section name|custom2=Outside page|custom2link=Main Page}}

 Headers can be listed before & after "ABCDEF" using pre1 & custom1:
: {{tlx|Compact ToC|center=yes|align=center|top=yes|seealso=yes |pre1=Scope of list|pre2=Abbreviations used|prebreak= |custom1=Popular entries|custom2=Excluded entries|notes=yes}}
{{Compact ToC|center=yes|align=center|top=yes|seealso=yes|pre1=Scope of list|pre2=Abbreviations used|prebreak= |custom1=Popular entries|custom2=Excluded entries|notes=yes}}

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

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

{{tlx|Compact ToC|short1}}

{{Compact ToC|short1}}

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

==Examples==
{{tlx|Compact ToC|top=yes}} 
{| style="margin-left:2.0em"
|{{Compact ToC|top=yes}}
|}

{{tlx|Compact ToC|side=yes|sym=yes|num=yes|refs=yes|seealso=yes|custom1=Other}}
{| style="margin-left:2.0em"
|{{Compact ToC|side=yes|sym=yes|num=yes|refs=yes|custom1=Other}}
|}

{{tlx|Compact ToC|name=Directory|top=no|refs=yes|notes=yes|extlinks=yes}}
{| style="margin-left:2.0em"
|{{Compact ToC|name=Directory|top=no|refs=yes|notes=yes|extlinks=yes}}
|}

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

{{tlx|Compact ToC|short1|num=yes|sym=yes|seealso=yes|notesfirst=yes|further=yes|extlinks=yes}}
{{Compact ToC|short1|num=yes|sym=yes|seealso=yes|notesfirst=yes|further=yes|extlinks=yes}}

== See also ==
* [[Help:Section#Table of contents (TOC)]]
* [[Help:Magic words#Behavior switches]] for more help on:
**<nowiki>__NOTOC__</nowiki>
**<nowiki>__TOC__</nowiki>

<includeonly>
[[Category:Exclude in print]]
[[Category:List templates]]
[[Category:Wikipedia table of contents templates]]

[[bn:টেমপ্লেট:TOC]]
[[bs:Šablon:TOC]]
[[ca:Template:Índex]]
[[de:Vorlage:TOC]]
[[eo:Ŝablono:Indekso]]
[[es:Plantilla:Índice]]
[[fa:الگو:فهرست فارسی]]
[[fr:Modèle:CompactTOC8]]
[[gl:Modelo:CompactTOC]]
[[hi:साँचा:CompactTOC8]]
[[hsb:Předłoha:TOC]]
[[id:Templat:CompactTOC8]]
[[is:Snið:Stafayfirlit]]
[[it:Template:Indice]]
[[ja:Template:TOC]]
[[ka:თარგი:TOC]]
[[la:Formula:A-Z]]
[[lt:Šablonas:CompactTOC]]
[[pt:Predefinição:Peqind]]
[[ru:Шаблон:CompactTOC8]]
[[sl:Predloga:CompactTOC3]]
[[sv:Mall:Alfabetisk]]
[[uz:Andoza:Ixcham mundarija]]
</includeonly>

64.85.216.195: fixed redirect: CompactTOC ==> Compact ToC

2012-03-13T11:53:55Z

fixed redirect: CompactTOC ==> Compact ToC

New page

{{Documentation subpage}}

{{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.
The template has all features of other TOC templates, such as optional "Top" "0–9" sections, ''and'' allows selecting other sections.

==Usage==
;Typical:

<nowiki>{{Compact ToC|symnum=yes}}</nowiki>

;For alphabetical only

<nowiki>{{Compact ToC}}</nowiki>

;For common applications:

<nowiki>{{Compact ToC|center=yes|seealso=yes|refs=yes|further=yes}}</nowiki>

:or vertical:

<pre>
{{Compact ToC
|center = yes
|seealso = yes
|refs = yes
|further = yes
}}
</pre>

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

<pre>
{{Compact ToC
|name=
|side=yes
|center=yes
|right=
|align=center
|nobreak=yes
|top=yes
|num=yes
|sym=yes
|symnum=
|pre1=
|pre1name=
|pre1link=
...
|pre8=
|pre8name=
|pre8link=
|prebreak= 
|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> </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&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>==!&ndash;9==</nowiki></code> for the link to work)

*<code>sep=&middot;</code>: set the separator-text between word-headers (not between "ABCDEF") to "·"; could also be a vertical-bar or <code>&bull;</code> (•), etc.

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

*<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= </code>: set break-line after all pre-list headers; can include text to introduce "ABCDEF".

*<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: 
{{tlx|Compact ToC|side=yes|j=|q=}}
{| style="margin-left:3.0em"
|{{Compact ToC|side=yes|j=|q=}}
|}
Or it can be replaced with an unlinked letter by using that letter ('''upper-case'''):
{{tlx|Compact ToC|side=yes|j=J|q=Q}}
{| style="margin-left:3.0em"
|{{Compact ToC|side=yes|j=J|q=Q}}
|}
''Note:'' It is often better to create an empty placeholder span (e.g. <code><nowiki></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|Compact ToC|side=yes|x=<nowiki>[[#X-Z|X-Z]]</nowiki>|y=|z=}}
{| style="margin-left:3.0em"
|{{Compact ToC|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|Compact ToC|name=<nowiki>[[</nowiki><var>Articlename</var><nowiki>]]</nowiki>|side=yes|n=<nowiki>[[</nowiki><var>Articlename</var> (N–Z)#N|N<nowiki>]]</nowiki>|o=<nowiki>[[</nowiki><var>Articlename</var> (N–Z)#O|O<nowiki>]]</nowiki>|...|z=<nowiki>[[</nowiki><var>Articlename</var> (N–Z)#Z|Z<nowiki>]]</nowiki>}}

{| style="margin-left:3.0em"
|{{Compact ToC|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|Compact ToC|side=yes|n=<nowiki>[[</nowiki><var>Articlename</var> (N–Z)|&nbsp;N–Z (next page)<nowiki>]]</nowiki>|o=|p=|...|z=}}

{| style="margin-left:3.0em"
|{{Compact ToC|side=yes|n=[[Articlename (N–Z)| N–Z (next page)]]|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|Compact ToC|name=no|center=yes|top=yes|seealso=yes|notes=yes|custom1=New section|custom2=Additional section}}
{{Compact ToC|name=no|center=yes|top=yes|seealso=yes|notes=yes|custom1=New section|custom2=Additional section}}

{{tlx|Compact ToC|name=no|center=yes|top=yes|seealso=yes|notes=yes|custom1=New section|custom1name=Custom section name|custom2=Outside page|custom2link=Main Page}}
{{Compact ToC|name=no|center=yes|top=yes|seealso=yes|notes=yes|custom1=New section|custom1name=Custom section name|custom2=Outside page|custom2link=Main Page}}

 Headers can be listed before & after "ABCDEF" using pre1 & custom1:
: {{tlx|Compact ToC|center=yes|align=center|top=yes|seealso=yes |pre1=Scope of list|pre2=Abbreviations used|prebreak= |custom1=Popular entries|custom2=Excluded entries|notes=yes}}
{{Compact ToC|center=yes|align=center|top=yes|seealso=yes|pre1=Scope of list|pre2=Abbreviations used|prebreak= |custom1=Popular entries|custom2=Excluded entries|notes=yes}}

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

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

{{tlx|Compact ToC|short1}}

{{Compact ToC|short1}}

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

==Examples==
{{tlx|Compact ToC|top=yes}} 
{| style="margin-left:2.0em"
|{{Compact ToC|top=yes}}
|}

{{tlx|Compact ToC|side=yes|sym=yes|num=yes|refs=yes|seealso=yes|custom1=Other}}
{| style="margin-left:2.0em"
|{{Compact ToC|side=yes|sym=yes|num=yes|refs=yes|custom1=Other}}
|}

{{tlx|Compact ToC|name=Directory|top=no|refs=yes|notes=yes|extlinks=yes}}
{| style="margin-left:2.0em"
|{{Compact ToC|name=Directory|top=no|refs=yes|notes=yes|extlinks=yes}}
|}

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

{{tlx|Compact ToC|short1|num=yes|sym=yes|seealso=yes|notesfirst=yes|further=yes|extlinks=yes}}
{{Compact ToC|short1|num=yes|sym=yes|seealso=yes|notesfirst=yes|further=yes|extlinks=yes}}

== See also ==
* [[Help:Section#Table of contents (TOC)]]
* [[Help:Magic words#Behavior switches]] for more help on:
**<nowiki>__NOTOC__</nowiki>
**<nowiki>__TOC__</nowiki>

<includeonly>
[[Category:Exclude in print]]
[[Category:List templates]]
[[Category:Wikipedia table of contents templates]]

[[fa:الگو:فهرست فارسی]]
[[ca:Template:Índex]]
[[de:Vorlage:TOC]]
[[es:Plantilla:Índice]]
[[eo:Ŝablono:Indekso]]
[[hi:साँचा:CompactTOC8]]
[[id:Templat:CompactTOC8]]
[[it:Template:Indice]]
[[ja:template:TOC]]
[[pt:Predefinição:Peqind]]
[[ru:Шаблон:CompactTOC8]]
[[sl:Predloga:CompactTOC3]]
[[sv:Mall:Alfabetisk]]
[[nl:Sjabloon:CompactTOC8]]
</includeonly>

94.95.134.30 at 13:28, 22 January 2011

2011-01-22T13:28:13Z

← Older revision		Revision as of 13:28, 22 January 2011
Line 192:		Line 192:
	[[Category:Wikipedia table of contents templates\|{{PAGENAME}}]]		[[Category:Wikipedia table of contents templates\|{{PAGENAME}}]]
	[[Category:List templates\|{{PAGENAME}}]]		[[Category:List templates\|{{PAGENAME}}]]
	[[fa:الگو:فهرست ~~انگلیسی~~]]		[[fa:الگو:فهرست فارسی]]
	[[ca:Template:Índex]]		[[ca:Template:Índex]]
	[[de:Vorlage:TOC]]		[[de:Vorlage:TOC]]

94.95.134.30 at 09:54, 22 January 2011

2011-01-22T09:54:17Z

← Older revision		Revision as of 09:54, 22 January 2011
Line 192:		Line 192:
	[[Category:Wikipedia table of contents templates\|{{PAGENAME}}]]		[[Category:Wikipedia table of contents templates\|{{PAGENAME}}]]
	[[Category:List templates\|{{PAGENAME}}]]		[[Category:List templates\|{{PAGENAME}}]]
			[[fa:الگو:فهرست انگلیسی]]
	[[ca:Template:Índex]]		[[ca:Template:Índex]]
	[[de:Vorlage:TOC]]		[[de:Vorlage:TOC]]

79.204.101.111: /* See also */ wikified

2011-01-18T18:11:47Z

79.204.101.111: Please wikify.

2011-01-18T18:08:49Z

Please wikify.

New page

{{Documentation subpage}}

{{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.
The template has all features of [[Template:CompactTOC7]], plus some from [[Template:CompactTOC2]], such as optional "Top" "0-9" sections, ''and'' allows selecting other sections.

==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)

<nowiki>{{</nowiki>'''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= 
|custom1=
|custom1name=
|custom1link=
...
|custom8=
|custom8name=
|custom8link=
|seealso=yes
|notesfirst=
|refs=yes
|notes=yes
|extlinks=yes
|a=
...
|z=
}}</code>

===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> </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&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>==!&ndash;9==</nowiki></code> for the link to work)

*<code>sep=&middot;</code> — set the separator-text between word-headers (not between "ABCDEF") to "·"; could also be a vertical-bar or <code>&bull;</code> (•), etc.

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

*<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= </code> — set break-line after all pre-list headers; can include text to introduce "ABCDEF".

*<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>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: 
{{tlx|CompactTOC8|side=yes|j=|q=}}
{| 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=yes|j=J|q=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></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=yes|x=<nowiki>[[#X-Z|X-Z]]</nowiki>|y=|z=}}
{| 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=<nowiki>[[</nowiki><var>Articlename</var><nowiki>]]</nowiki>|side=yes|n=<nowiki>[[</nowiki><var>Articlename</var> (N–Z)#N|N<nowiki>]]</nowiki>|o=<nowiki>[[</nowiki><var>Articlename</var> (N–Z)#O|O<nowiki>]]</nowiki>|...|z=<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=yes|n=<nowiki>[[</nowiki><var>Articlename</var> (N–Z)|&nbsp;N–Z (next page)<nowiki>]]</nowiki>|o=|p=|...|z=}}

{| style="margin-left:3.0em"
|{{CompactTOC8|side=yes|n=[[Articlename (N–Z)| N–Z (next page)]]|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=no|center=yes|top=yes|seealso=yes|notes=yes|custom1=New section|custom2=Additional section}}
{{CompactTOC8|name=no|center=yes|top=yes|seealso=yes|notes=yes|custom1=New section|custom2=Additional section}}

{{tlx|CompactTOC8|name=no|center=yes|top=yes|seealso=yes|notes=yes|custom1=New section|custom1name=Custom section name|custom2=Outside page|custom2link=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}}

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

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

====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=yes}} 
{| style="margin-left:2.0em"
|{{CompactTOC8|top=yes}}
|}

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

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

{{tlx|CompactTOC8|name=no|side=yes|right=yes|symnum=yes|seealso=yes}}
{{CompactTOC8|name=no|side=yes|right=yes|symnum=yes|seealso=yes}} 

{{tlx|CompactTOC8|short1|num=yes|sym=yes|seealso=yes|notesfirst=yes|extlinks=yes}}
{{CompactTOC8|short1|num=yes|sym=yes|seealso=yes|notesfirst=yes|extlinks=yes}}

<includeonly>
[[Category:Exclude in print]]
[[Category:Wikipedia table of contents templates|{{PAGENAME}}]]
[[Category:List templates|{{PAGENAME}}]]

[[ca:Template:Índex]]
[[de:Vorlage:TOC]]
[[es:Plantilla:TOC]]
[[eo:Ŝablono:Indekso]]
[[hi:साँचा:CompactTOC8]]
[[id:Templat:CompactTOC8]]
[[it:Template:Indice]]
[[ja:template:TOC]]
[[pt:Predefinição:Peqind]]
[[sl:Predloga:CompactTOC3]]
[[sv:Mall:Alfabetisk]]
[[nl:Sjabloon:CompactTOC8]]
</includeonly>
== See also ==
*<nowiki>__NOTOC__</nowiki>
*<nowiki>__TOC__</nowiki>

190.21.209.76 at 01:47, 20 May 2008

2008-05-20T01:47:22Z

New page

{{Documentation subpage}}

{{Intricate template}}
__TOC__
==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==

'''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)

<nowiki>{{</nowiki>'''CompactTOC8'''
|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=
}}</code>

===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> </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&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>==!&ndash;9==</nowiki></code> for the link to work)
*<code>custom1</code>, <code>custom2</code> and <code>custom3</code> — add up to 3 extra "custom" sections at the end of the list (alternatively <code>Sec1, Sec2, Sec3</code>)
*<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>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 this 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 deleted (i.e. because it has no entries in the list) by adding it as a '''lower case''' blank parameter
{{tlx|CompactTOC8|side=yes|j=|q=}}
{{CompactTOC8|side=yes|j=|q=}}

Or it can be replaced with an unlinked letter by using that letter ('''upper case'''):
{{tlx|CompactTOC8|side=yes|j=J|q=Q}}

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

''Note:'' It is often better to create an empty placeholder span (e.g. <code><nowiki></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.

This feature can also be used to create range links:

{{tlx|CompactTOC8|side=yes|x=<nowiki>[[#X-Z|X-Z]]</nowiki>|y=|z=}}

{{CompactTOC8|side=yes|x=[[#X-Z|X-Z]]|y=|z=}}

====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=yes}}
{{CompactTOC8|top=yes}}

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

{{tlx|CompactTOC8|side=yes|sym=yes|num=yes|refs=yes|seealso=yes|sec1=Other}}
{{CompactTOC8|side=yes|sym=yes|num=yes|refs=yes|Sec1=Other}}

{{tlx|CompactTOC8|name=Directory|top=no|refs=yes|notes=yes|extlinks=yes}}
{{CompactTOC8|name=Directory|top=no|refs=yes|notes=yes|extlinks=yes}}

{{tlx|CompactTOC8|name=no|side=yes|right=yes|symnum=yes|seealso=yes}}
{{CompactTOC8|name=no|side=yes|right=yes|symnum=yes|seealso=yes}} 

<code><nowiki>{{</nowiki>'''CompactTOC8'''<nowiki>|short1|num=yes|sym=yes|seealso=yes|notesfirst=yes|extlinks=yes}}</nowiki></code>
{{CompactTOC8|short1|num=yes|sym=yes|seealso=yes|notesfirst=yes|extlinks=yes}}

<includeonly>

[[Category:TOC templates]]
[[Category:Templates using ParserFunctions]]

[[nl:Sjabloon:CompactTOC8]]
[[sl:Predloga:CompactTOC3]]
[[es:Plantilla:TOC]]
</includeonly>

← Older revision		Revision as of 18:11, 18 January 2011
Line 207:		Line 207:
	</includeonly>		</includeonly>
	== See also ==		== See also ==
	*<nowiki>__NOTOC__</nowiki>		* [[Help:Magic words#Behavior switches]] for help on:
	*<nowiki>__TOC__</nowiki>		**<nowiki>__NOTOC__</nowiki>
			**<nowiki>__TOC__</nowiki>