Template:TOC - Revision history

Sunjammer: Adding anchored headings to sample

2011-08-17T21:34:05Z

Adding anchored headings to sample

Sunjammer at 21:21, 14 August 2011

2011-08-14T21:21:30Z

Sunjammer at 16:25, 14 August 2011

2011-08-14T16:25:29Z

Sunjammer: Cleaning up template

2011-08-14T16:13:18Z

Cleaning up template

Sunjammer: Fixing table, fixing examples, adding category

2011-08-13T16:53:11Z

Fixing table, fixing examples, adding category

Sunjammer: Created (based on Wikipedia's CompactTOC8)

2011-08-13T16:45:27Z

Created (based on Wikipedia's CompactTOC8)

New page

{| id="toc" class="toc" summary="Contents" {{

#ifeq:{{{center|}}}|yes|align="center"|}}{{#ifeq:{{{right|}}}|yes|align="right"|}}
{{

#ifeq:{{{name|}}}|no||! {{{name|{{MediaWiki:Toc}}}}}{{#ifeq:{{{side|}}}|yes|:|}}
{{#ifeq:{{{side|}}}|yes|{{!}}|{{!}}-}}}}
|{{#ifeq:{{{nobreak|}}}|yes||<div style="text-align:{{{align|left}}};">}}{{

#ifeq:{{{top|}}}|yes|[[#top{{!}}Top]] {{{sep| }}}|}} {{

#ifeq:{{{sym|}}}|yes|[[#!$@|!$@]]|}} {{

#ifeq:{{{num|}}}|yes|[[#0–9|0–9]]|}} {{#ifeq:{{{symnum|}}}|yes|[[#!–9|!–9]]|

}} {{{a|[[#A|A]]}}} {{{b|[[#B|B]]}}} {{{c|[[#C|C]]}}} {{{d|[[#D|D]]}}} {{{e|[[#E|E]]}}} {{{f|[[#F|F]]}}} {{{g|[[#G|G]]}}} {{{h|[[#H|H]]}}} {{{i|[[#I|I]]}}} {{{j|[[#J|J]]}}} {{{k|[[#K|K]]}}} {{{l|[[#L|L]]}}} {{{m|[[#M|M]]}}} {{{n|[[#N|N]]}}} {{{o|[[#O|O]]}}} {{{p|[[#P|P]]}}} {{{q|[[#Q|Q]]}}} {{{r|[[#R|R]]}}} {{{s|[[#S|S]]}}} {{{t|[[#T|T]]}}} {{{u|[[#U|U]]}}} {{{v|[[#V|V]]}}} {{{w|[[#W|W]]}}} {{{x|[[#X|X]]}}} {{{y|[[#Y|Y]]}}} {{{z|[[#Z|Z]]}}} {{#ifeq:{{{nobreak|{{#ifeq:{{{1}}}|short1|yes|}}}}}|yes| |<br />}}{{

#ifeq:{{{seealso|}}}|yes|{{{sep| }}} [[#See also{{!}}See also]] |}}
</div>
|}__NOTOC__<noinclude>
== Description ==
This is a replacement '''Table of Contents''' for alphabetical lists:
:* The "Contents" or a custom heading can go on top (default) or the side (side=yes).
:* [[#Letters|Letters]] can be omitted and/or ranges set instead of 26 individual letters: A B C-F G H-K L ...
:* Other options include: center=yes, num=yes, top=yes, seealso=yes, etc.

== Usage ==
=== Typical ===

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

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

=== Complete ===

<pre>
{{TOC
|name =
|side = yes
|center = yes
|right =
|align = center
|nobreak = yes
|top = yes
|num = yes
|sym = yes
|symnum =
|seealso = yes
|a =
:
|z =
}}</pre>

=== Parameters ===
{| class="wikitable"
! Parameter !! Description
| <code>name</code>
| replaces the "Contents" heading with an alternative name, or hide it completely by entering <code>name=no</code>
|-
| <code>side</code>
| places the "Contents" heading on the left side with a colon, instead of the top without one
|-
| <code>align</code>
| centres to TOC in the horizontal middle of the page, instead of floated left
|-
| <code>right</code>
| aligns 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</code>
| no linebreak between the letters and the "See also" link (note: does not affect the heading; use <code>side</code> for that)
|-
| <code>top</code>
| enables 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
|-
| <code>sym</code>
| enables the "!$@" link for symbolic entries section
|-
|-
| <code>num</code>
| enables 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</code>
| enables 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>seealso</code>
| enables link to the "See also" 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: 
<code>{{TOC|side=yes|j=|q=}}</code>
{| style="margin-left:3.0em"
|{{TOC|side=yes|j=|q=}}
|}
Or it can be replaced with an unlinked letter by using that letter ('''upper-case'''):
<code>{{TOC|side=yes|j=J|q=Q}}</code>
{| style="margin-left:3.0em"
|{{TOC|side=yes|j=J|q=Q}}
|}
''Note:'' It is often better to create an empty place-holder 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:

<code>{{|TOC|side=yes|x=<nowiki>[[#X-Z|X-Z]]</nowiki>|y=|z=}}</code>
{| style="margin-left:3.0em"
|{{TOC|side=yes|x=[[#X-Z|X-Z]]|y=|z=}}
|}
</noinclude>

@@ Line 40: / Line 40: @@
+:
 |z       =
-}}</pre>
+}}
+<!-- === <span id="A">A</span> ===
 === Parameters ===

@@ Line 12: / Line 12: @@
 #ifeq:{{{sym|}}}|yes|[[#!$@|!$@]]|}} {{
 <!-- numbers -->
-#ifeq:{{{num|}}}|yes|[[#0–9|0–9]]|}} {{#ifeq:{{{symnum|}}}|yes|[[#!–9|!–9]]|
+#ifeq:{{{num|}}}|yes|[[#0-9|0-9]]|}} {{#ifeq:{{{symnum|}}}|yes|[[#!-9|!-9]]|
 <!-- letters -->
 }} {{{a|[[#A|A]]}}} {{{b|[[#B|B]]}}} {{{c|[[#C|C]]}}} {{{d|[[#D|D]]}}} {{{e|[[#E|E]]}}} {{{f|[[#F|F]]}}} {{{g|[[#G|G]]}}} {{{h|[[#H|H]]}}} {{{i|[[#I|I]]}}} {{{j|[[#J|J]]}}} {{{k|[[#K|K]]}}} {{{l|[[#L|L]]}}} {{{m|[[#M|M]]}}} {{{n|[[#N|N]]}}} {{{o|[[#O|O]]}}} {{{p|[[#P|P]]}}} {{{q|[[#Q|Q]]}}} {{{r|[[#R|R]]}}} {{{s|[[#S|S]]}}} {{{t|[[#T|T]]}}} {{{u|[[#U|U]]}}} {{{v|[[#V|V]]}}} {{{w|[[#W|W]]}}} {{{x|[[#X|X]]}}} {{{y|[[#Y|Y]]}}} {{{z|[[#Z|Z]]}}} {{#ifeq:{{{nobreak|{{#ifeq:{{{1}}}|short1|yes|}}}}}|yes|&nbsp;|<br />}}{{
@@ Line 60: / Line 60: @@
 |-
 | <code>top</code>
-|   enables 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
+| enables 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
 |-
 | <code>sym</code>
 | enables the "!$@" link for symbolic entries section
 |-
 | <code>num</code>
-| enables 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)
+| enables 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</code>
-| enables 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)
+| enables 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)
 |-
 | <code>seealso</code>
@@ Line 76: / Line 78: @@
 |-
 | <code>a</code> to <code>z</code>
-| disables individual letters that have no entries or creates range links,  for example, "X-Z".  ''Use with caution'' and check regularly to make sure that new entries do not require the removal of these parameters.
+| disables individual letters that have no entries or creates range links,  for example, "X-Z".  Use with caution and check regularly to make sure that new entries do not require the removal of these parameters.
 |}

@@ Line 1: / Line 1: @@
 {| id="toc" class="toc" summary="Contents" {{
 <!-- center/right -->
-#ifeq:{{{align|}}}|center|align="center"|}}{{#ifeq:{{{align|}}}|right|align="right"|}} {{
+#ifeq:{{{align|}}}|center|align="center"|}}{{#ifeq:{{{align|}}}|right|align="right"|}}
 <!-- name/side -->
 #ifeq:{{{name|}}}|no||! {{{name|{{MediaWiki:Toc}}}}}{{#ifeq:{{{side|}}}|yes|&#58;|}}

@@ Line 1: / Line 1: @@
 {| id="toc" class="toc" summary="Contents" {{
 <!-- center/right -->
-#ifeq:{{{center|}}}|yes|align="center"|}}{{#ifeq:{{{right|}}}|yes|align="right"|}}
+#ifeq:{{{align|}}}|center|align="center"|}}{{#ifeq:{{{align|}}}|right|align="right"|}} {{
 {{
 <!-- name/side -->
 #ifeq:{{{name|}}}|no||! {{{name|{{MediaWiki:Toc}}}}}{{#ifeq:{{{side|}}}|yes|&#58;|}}
@@ Line 15: / Line 14: @@
 <!-- letters -->
 }} {{{a|[[#A|A]]}}} {{{b|[[#B|B]]}}} {{{c|[[#C|C]]}}} {{{d|[[#D|D]]}}} {{{e|[[#E|E]]}}} {{{f|[[#F|F]]}}} {{{g|[[#G|G]]}}} {{{h|[[#H|H]]}}} {{{i|[[#I|I]]}}} {{{j|[[#J|J]]}}} {{{k|[[#K|K]]}}} {{{l|[[#L|L]]}}} {{{m|[[#M|M]]}}} {{{n|[[#N|N]]}}} {{{o|[[#O|O]]}}} {{{p|[[#P|P]]}}} {{{q|[[#Q|Q]]}}} {{{r|[[#R|R]]}}} {{{s|[[#S|S]]}}} {{{t|[[#T|T]]}}} {{{u|[[#U|U]]}}} {{{v|[[#V|V]]}}} {{{w|[[#W|W]]}}} {{{x|[[#X|X]]}}} {{{y|[[#Y|Y]]}}} {{{z|[[#Z|Z]]}}} {{#ifeq:{{{nobreak|{{#ifeq:{{{1}}}|short1|yes|}}}}}|yes|&nbsp;|<br />}}{{
-<!-- see also-->
+<!-- see also -->
 #ifeq:{{{seealso|}}}|yes|{{{sep|&nbsp;}}} [[#See also{{!}}See also]]&nbsp;|}}
 </div>
 |}__NOTOC__<noinclude>
-== Description ==
+The [[Template:TOC|TOC]] template creates a replacement '''Table of Contents''' for alphabetical lists:
-This is a replacement '''Table of Contents''' for alphabetical lists:
 :* The "Contents" or a custom heading can go on top (default) or the side (side=yes).
-:* [[#Letters|Letters]] can be omitted and/or ranges set instead of 26 individual letters: A B C-F G H-K L ...
+:* letters can be omitted and/or merged into ranges: A B C-F G H-K L ...
-:* Other options include: center=yes, num=yes, top=yes, seealso=yes, etc.
+:* Other options include: align=center, num=yes, top=yes, seealso=yes, etc.
 == Usage ==
 <pre>
@@ Line 43: / Line 29: @@
 |name    =
 |side    = yes
 |align   = center
 |nobreak = yes
@@ Line 58: / Line 42: @@
 === Parameters ===
 {| class="wikitable"
 ! Parameter !! Description
@@ Line 68: / Line 53: @@
 |-
 | <code>align</code>
-| centres to TOC in the horizontal middle of the page, instead of floated left
+| <code>align=center</code> aligns the TOC horizontal to the middle of the page; <code>align=right</code> aligns 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)
-|-
-| <code>right</code>
-| aligns 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</code>
@@ Line 77: / Line 59: @@
 |-
 | <code>top</code>
-| enables 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
+|   enables 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
 |-
 | <code>sym</code>
@@ Line 92: / Line 74: @@
 | enables link to the "See also" section
 |-
-| <code>a</code> through <code>z</code>
+| <code>a</code> to <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.)''
+| disables individual letters that have no entries or creates range links,  for example, "X-Z".  ''Use with caution'' and check regularly to make sure that new entries do not require the removal of these parameters.
 |}
-== Letters ==
+Any letter can be omitted (i.e. when it has no entries in the list) by using its ''lower-case'' parameter unset, for example, <code>q=</code>, or it can be replaced with an unlinked letter by using its ''lower-case'' parameter set to its ('''upper-case''') self, for example, <code>q=Q</code>.
-Any letter can be omitted (i.e. when it has no entries in the list) by specifying it as a ''lower-case'' blank parameter: <code><nowiki>{{TOC|side=yes|j=|q=}}</nowiki></code>
-{| style="margin-left:3.0em"
+It is sometimes better to create an empty place-holder 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.
 |{{TOC|side=yes|j=|q=}}
 |}
-Or it can be replaced with an unlinked letter by using that letter ('''upper-case'''): <code><nowiki>{{TOC|side=yes|j=J|q=Q}}</nowiki></code>
-{| style="margin-left:3.0em"
+<code><nowiki>{{TOC|side=yes|j=J|q=Q}}</nowiki></code>
 |{{TOC|side=yes|j=J|q=Q}}
 |}
-The letter-assignment feature can also be used to create range links: <code><nowiki>{{TOC|side=yes|x=[[#X-Z|X-Z]]|y=|z=}}</nowiki></code>
-{| style="margin-left:3.0em"
+<code><nowiki>{{TOC|side=yes|x=[[#X-Z|X-Z]]|y=|z=}}</nowiki></code>
 |{{TOC|side=yes|x=[[#X-Z|X-Z]]|y=|z=}}
 |}
 [[Category:Navigational templates]]
 </noinclude>