Dmarcadmin: 27 revisions imported

2015-07-17T16:47:38Z

27 revisions imported

New page

{{Documentation subpage}}


{{tl|Alphanumeric TOC}} is a customizable substitute for the (formerly) growing zoo of variants of {{tl|Compact ToC}}. Rather than have dozens of stylistic varieties, it is preferable to have a single template which can be adjusted to fit the editor's wishes.

== Usage ==
Insert the following at the point in the article where you want the TOC to appear: If using with a list, many editors have found it helpful to insert a TOC at both the beginning and end of the list (remember to add <code>|top=yes</code> to the bottom template to quickly get back to the top).

<pre>
{{alphanumeric TOC}}
</pre>

Whenever multiple TOCs will be used on a page, and this template will '''not''' be the primary one at the top of the page, add <code><nowiki>|primary=false</nowiki></code> (this prevents multiple TOCs from showing up in each other's listings):

<pre>
{{alphanumeric TOC
|primary=false
}}
</pre>

== Options ==
=== Alignment ===
The natural state of the TOC is to appear along the left side of the page without any alignment. To align to the center of the page, add the parameter <code>align</code> with a value of 'center':

<pre>
{{alphanumeric TOC|align=center}}
</pre>

{{alphanumeric TOC|align=center}}

The TOC may also be aligned to the right or the left, causing the article text to wrap around it, but floating the TOC is generally discouraged. Guidelines may be found at [[Help:Section#Floating the TOC]].

=== Prefixing or suffixing links or link descriptions ===
The template includes the ability to add a prefix to the link with or without displaying it in the TOC. This can also be accomplished with this template by using the parameters <code>prefixLink</code> and <code>prefixDesc</code>; the former adds the prefix to the actual link, and the latter adds the prefix to the text displayed on the page. The <code>suffixLink</code> and <code>suffixDesc</code> parameters work the same way. Examples:

<pre>
{{alphanumeric TOC|prefixLink=1.}}
</pre>

{{alphanumeric TOC|prefixLink=1.}}

<pre>
{{alphanumeric TOC|prefixLink=hidden|prefixDesc=visible}}
</pre>

{{alphanumeric TOC|prefixLink=hidden|prefixDesc=visible}}

<pre>
{{alphanumeric TOC|prefixDesc=+}}
</pre>

{{alphanumeric TOC|prefixDesc=+}}

<pre>
{{alphanumeric TOC|suffixDesc=+}}
</pre>

{{alphanumeric TOC|suffixDesc=+}}

=== Standard and custom sections ===
One of the reasons for having so many different versions of CompactTOC has been that some articles do not have a 'References' section, or the TOC is being used for a list contained within a larger article. This template solves the problem by providing a parameter for each link to be shown. They are as follows:

; <code>|numbers=yes</code>: shows the numbers link
; <code>|a=</code>, <code>|b=</code>, etc.: shows the link for that letter; alternatively it can be used to create unlinked letters (see example below)
; <code>|top=yes</code>: shows the link to the 'Top of Page'
; <code>|seealso=yes</code>: shows the link to the 'See also' section
; <code>|references=yes</code>: shows the link to the 'References' section
; <code>|externallinks=yes</code>: shows the link to the 'External links' section

Some examples:

<pre>
{{alphanumeric TOC|numbers=yes|i=|n=|x=|z=|references=yes}}
</pre>

{{alphanumeric TOC|numbers=yes|i=|n=|x=|z=|references=yes}}

<pre>
{{alphanumeric TOC|numbers=yes|i=I|j=J|v=V|x=X|top=yes}}
</pre>

{{alphanumeric TOC|numbers=yes|i=I|j=J|v=V|x=X|top=yes}}

<pre>
{{alphanumeric TOC| style="text-align:center;" |g=|seealso=yes|externallinks=yes}}
</pre>

{{alphanumeric TOC| style="text-align:center;" |g=|seealso=yes|externallinks=yes}}

=== Optional user defined section links ===
Optional section links may be defined using the parameters <code>|sec1=</code>, <code>|sec2=</code>, <code>|sec3=</code>, <code>|sec4=</code>, and <code>|sec5=</code>, as follows:

<pre>
{{alphanumeric TOC|numbers=yes|seealso=yes|externallinks=yes|sec1=Added section|sec2=Plus one}}
</pre>

{{alphanumeric TOC|numbers=yes|seealso=yes|externallinks=yes|sec1=Added section|sec2=Plus one}}

<includeonly>

[[Category:Wikipedia table of contents templates]]


[[ca:Plantilla:Índex i taula de contingut opcional]]
[[ka:თარგი:საძიებელი]]
</includeonly>

221.171.208.7: +ja

2010-09-21T09:48:18Z

+ja

New page

{{Documentation subpage}}

==Purpose==
This TOC template was created as a customizable substitute for the growing zoo of CompactTOCs. Rather than have dozens of stylistic varieties, it is preferrable to have a single template which can be adjusted to fit the editor's wishes.

==Usage==
Insert <code><nowiki>{{AlphanumericTOC}}</nowiki></code> at the point in the article where you want the TOC to appear. If using with a list, many editors have found it helpful to insert a TOC at both the beginning and end of the list.

===Parameters===
Toggling the style and display of elements within the TOC is accomplished by adding parameters with a null value (in the form <code>|''parameter''=|</code>). This is a short list which will be expanded upon further in the following text:
*block v. inline formatting: <code>multiline</code>, <code>nobreak</code>;
*table alignment: <code>align</code>;
*addition of prefixes to the links: <code>prefixLink</code>, <code>prefixDesc</code>;
*suppressing the automatic table of contents: <code>notoc</code>; and,
*each of the links also has its own parameter which when used suppresses the display of the link.

===Block and inline formatting===
When the template is used without any parameters, it appears as:
{{AlphanumericTOC}}
This replicates what you would see with a template like <code>{{[[:Template:CompactTOCrefs|CompactTOCrefs]]}}</code>. The templates <code>{{[[:Template:CompactTOC2|CompactTOC2]]}}</code>, <code>{{[[:Template:CompactTOC5T|CompactTOC5T]]}}</code>, and <code>{{[[:Template:CompactTOCrefs2|CompactTOCrefs2]]}}</code> display the text in a single inline list. To accomplish this, add the parameter <code>nobreak</code> to the template:
<pre>
{{AlphanumericTOC|
nobreak=|}}
</pre>
{{AlphanumericTOC|nobreak=|}}

For a TOC which displays in a block format, like <code>{{[[:Template:CompactTOC4|CompactTOC4]]}}</code> and <code>{{[[:Template:CompactTOC5|CompactTOC5]]}}</code>, add the parameter <code>multiline</code>:
<pre>
{{AlphanumericTOC|
multiline=|}}
</pre>
{{AlphanumericTOC|multiline=|}}

'''Note:''' If these parameters are used in combination, <code>multiline</code> will always override any effects from <code>nobreak</code>.

===Aligning the TOC===
As is apparent from the examples already given, the natural state of the TOC is to appear along the left side of the page without any alignment. Some of the existing TOCs, including <code>{{[[:Template:CompactTOC|CompactTOC]]}}</code>, <code>{{[[:Template:CompactTOC3|CompactTOC3]]}}</code>, and <code>{{[[:Template:CompactTOCrefs|CompactTOCrefs]]}}</code>, are aligned to the center of the page. This can be replicated by adding the parameter <code>align</code> with a value of 'center':
<pre>
{{AlphanumericTOC|
align=center|}}
</pre>
{{AlphanumericTOC|align=center|}}
The TOC may also be aligned to the right or the left, causing the article text to wrap around it, but floating the TOC is generally discouraged. Guidelines may be found at [[Wikipedia:Section#Floating the TOC]].

===Prefixing links or link descriptions===
The TOC templates <code>{{[[:Template:CompactTOCprefix|CompactTOCprefix]]}}</code> and <code>{{[[:Template:CompactTOC2wprefix|CompactTOC2wprefix]]}}</code> include the ability to add a prefix to the link with or without displaying it in the TOC. This can also be accomplished with this template by using the parameters <code>prefixLink</code> and <code>prefixDesc</code>; the former adds the prefix to the actual link, and the latter adds the prefix to the text displayed on the page. Examples:
<pre>
{{AlphanumericTOC|
prefixLink=1.|}}
</pre>
{{AlphanumericTOC|prefixLink=1.|}}
<pre>
{{AlphanumericTOC|
prefixLink=hidden|
prefixDesc=visible|}}
</pre>
{{AlphanumericTOC|prefixLink=hidden|prefixDesc=visible|}}
<pre>
{{AlphanumericTOC|
prefixDesc=+ |}}
</pre>
{{AlphanumericTOC|prefixDesc=+ |}}

===Suppression of the normal TOC===
By default this template suppresses the generation of the normal table of contents because it assumes that this is to be replaced by the alphanumericalTOC. However, in certain situations a TOC may be desirable in addition to the alphanumericalTOC, for example: where the alphanumericalTOC applies to only a section of the article and there are more than two sections.
If you want to overide the TOC suppression and allow the software to generate a table of contents in the normal way, use the parameter <code>notoc</code> as follows:
<pre>
{{AlphanumericTOC|
notoc=|}}
</pre>

===Selective link removal===
One of the reasons for having so many different versions of CompactTOC has been that some articles do not have a 'References' section, or the TOC is being used for a list contained within a larger article. This template solves the problem by providing a parameter for each link to be removed. They are as follows:
*<code>numbers</code>: removes the numbers link
*<code>a</code>, <code>b</code>, etc.: removes the link for that letter; alternatively it can be used to create unlinked letters (see example below)
*<code>sections</code>: removes all links appearing after the letters
*<code>top</code>: removes the link to the 'Top of Page'
*<code>seealso</code>: removes the link to the 'See also' section
*<code>references</code>: removes the link to the 'References' section
*<code>externallinks</code>: removes the link to the 'External links' section

Some examples:
<pre>
{{AlphanumericTOC|
numbers=|
sections=|}}
</pre>
{{AlphanumericTOC|numbers=|sections=|}}
<pre>
{{AlphanumericTOC|
numbers=|
i=|
n=|
x=|
z=|
references=|}}
</pre>
{{AlphanumericTOC|numbers=|i=|n=|x=|z=|references=|}}
<pre>
{{AlphanumericTOC|
numbers=|
i=I|
j=J|
v=V|
x=X|
nobreak=|
top=|}}
</pre>
{{AlphanumericTOC|numbers=|i=I|j=J|v=V|x=X|nobreak=|top=|}}
<pre>
{{AlphanumericTOC|
multiline=|
align=center|
g=|
seealso=|
externallinks=|}}
</pre>
{{AlphanumericTOC|multiline=|align=center|g=|seealso=|externallinks=|}}

===Optional user defined section links===
Optional section links may be defined using the parameters <code>sec1</code>, <code>sec2</code>, <code>sec3</code>, <code>sec4</code>, and <code>sec5</code>, as follows:

<pre>
{{AlphanumericTOC|
numbers=|
seealso=|
externallinks=|
sec1=Added section|
sec2=Plus one|}}
</pre>
{{AlphanumericTOC|numbers=|seealso=|externallinks=|sec1=Added section|sec2=Plus one|}}

==History==
Major revisions:
*Created & documented March 4, 2006 by [[User:Moverton|Moverton]]
*Changed to use #if [[m:ParserFunctions|ParserFunctions]] June 17, 2006 by [[User:Moverton|Moverton]] — This change should not impact the function or appearance of any existing usage.
*Added optional user defined section links November 17, 2006 by [[User:Moverton|Moverton]] — This change should not impact the function or appearance of any existing usage.
*Added optional <code>top</code> parameter December 27, 2006 by [[User:Moverton|Moverton]] — This allows for optional removal of the link to the 'Top of Page'; it should not impact the function of any existing usage.
<noinclude>[[Category:Template documentation|{{PAGENAME}}]]</noinclude><includeonly>


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


[[eu:Txantiloi:Aurkibide alfabetikoa]]
[[fr:Modèle:Sommaire compact]]
[[hr:Predložak:AlphanumericTOC]]
[[ja:Template:AlphanumericTOC]]
[[ru:Шаблон:ABC]]
</includeonly>

Template:Alphanumeric TOC/doc - Revision history

Dmarcadmin: 27 revisions imported

221.171.208.7: +ja