Gorgon: Template:CategoryTOC- adds a horizontal ''alphanumeric'' table of contents (TOC) to a category page.

2017-02-07T15:46:37Z

Template:CategoryTOC- adds a horizontal ''alphanumeric'' table of contents (TOC) to a category page.

New page

<table id="cattoc" class="toc plainlinks noprint" summary="Contents" style="border-collapse: separate; padding: 0 5px; white-space: pre;" align="{{#switch: {{lc: {{{align|center}}} }} | left | right = {{lc: {{{align}}} }} | #default = center}}">
<tr><th>{{MediaWiki:Toc}}:</th><td>{{#ifeq: {{lc: {{{top|yes}}} }} | no | |  [{{fullurl: {{FULLPAGENAME}} }} Top]}}{{#switch: {{lc: {{{numerals|group}}} }} | no = | separate = {{#ifeq: {{lc: {{{top|yes}}} }} | no | |  '''·''' }} [{{fullurl: {{FULLPAGENAME}} | from=0}} 0] [{{fullurl: {{FULLPAGENAME}} | from=1}} 1] [{{fullurl: {{FULLPAGENAME}} | from=2}} 2] [{{fullurl: {{FULLPAGENAME}} | from=3}} 3] [{{fullurl: {{FULLPAGENAME}} | from=4}} 4] [{{fullurl: {{FULLPAGENAME}} | from=5}} 5] [{{fullurl: {{FULLPAGENAME}} | from=6}} 6] [{{fullurl: {{FULLPAGENAME}} | from=7}} 7] [{{fullurl: {{FULLPAGENAME}} | from=8}} 8] [{{fullurl: {{FULLPAGENAME}} | from=9}} 9] | #default = {{#ifeq: {{lc: {{{top|yes}}} }} | no | |  '''·''' }} [{{fullurl: {{FULLPAGENAME}} | from=0}} 0–9]}}{{#ifeq: {{lc: {{{uppercase|yes}}} }} | no | |{{#ifeq: {{#ifeq: {{lc: {{{numerals|group}}} }} | no | no | ¬ }} | {{lc: {{{top|yes}}} }} | |  '''·''' }} [{{fullurl: {{FULLPAGENAME}} | from=A}} A] [{{fullurl: {{FULLPAGENAME}} | from=B}} B] [{{fullurl: {{FULLPAGENAME}} | from=C}} C] [{{fullurl: {{FULLPAGENAME}} | from=D}} D] [{{fullurl: {{FULLPAGENAME}} | from=E}} E] [{{fullurl: {{FULLPAGENAME}} | from=F}} F] [{{fullurl: {{FULLPAGENAME}} | from=G}} G] [{{fullurl: {{FULLPAGENAME}} | from=H}} H] [{{fullurl: {{FULLPAGENAME}} | from=I}} I] [{{fullurl: {{FULLPAGENAME}} | from=J}} J] [{{fullurl: {{FULLPAGENAME}} | from=K}} K] [{{fullurl: {{FULLPAGENAME}} | from=L}} L] [{{fullurl: {{FULLPAGENAME}} | from=M}} M] [{{fullurl: {{FULLPAGENAME}} | from=N}} N] [{{fullurl: {{FULLPAGENAME}} | from=O}} O] [{{fullurl: {{FULLPAGENAME}} | from=P}} P] [{{fullurl: {{FULLPAGENAME}} | from=Q}} Q] [{{fullurl: {{FULLPAGENAME}} | from=R}} R] [{{fullurl: {{FULLPAGENAME}} | from=S}} S] [{{fullurl: {{FULLPAGENAME}} | from=T}} T] [{{fullurl: {{FULLPAGENAME}} | from=U}} U] [{{fullurl: {{FULLPAGENAME}} | from=V}} V] [{{fullurl: {{FULLPAGENAME}} | from=W}} W] [{{fullurl: {{FULLPAGENAME}} | from=X}} X] [{{fullurl: {{FULLPAGENAME}} | from=Y}} Y] [{{fullurl: {{FULLPAGENAME}} | from=Z}} Z]}}{{#ifeq: {{lc: {{{lowercase|no}}} }} | yes | {{#ifeq: {{lc: {{{top|yes}}} }} | no | {{#ifeq: {{#ifeq: {{lc: {{{numerals|group}}} }} | no | no | ¬ }} | {{lc: {{{uppercase|yes}}} }} | |  '''·'''}} |  '''·'''}} [{{fullurl: {{FULLPAGENAME}} | from=a}} a] [{{fullurl: {{FULLPAGENAME}} | from=b}} b] [{{fullurl: {{FULLPAGENAME}} | from=c}} c] [{{fullurl: {{FULLPAGENAME}} | from=d}} d] [{{fullurl: {{FULLPAGENAME}} | from=e}} e] [{{fullurl: {{FULLPAGENAME}} | from=f}} f] [{{fullurl: {{FULLPAGENAME}} | from=g}} g] [{{fullurl: {{FULLPAGENAME}} | from=h}} h] [{{fullurl: {{FULLPAGENAME}} | from=i}} i] [{{fullurl: {{FULLPAGENAME}} | from=j}} j] [{{fullurl: {{FULLPAGENAME}} | from=k}} k] [{{fullurl: {{FULLPAGENAME}} | from=l}} l] [{{fullurl: {{FULLPAGENAME}} | from=m}} m] [{{fullurl: {{FULLPAGENAME}} | from=n}} n] [{{fullurl: {{FULLPAGENAME}} | from=o}} o] [{{fullurl: {{FULLPAGENAME}} | from=p}} p] [{{fullurl: {{FULLPAGENAME}} | from=q}} q] [{{fullurl: {{FULLPAGENAME}} | from=r}} r] [{{fullurl: {{FULLPAGENAME}} | from=s}} s] [{{fullurl: {{FULLPAGENAME}} | from=t}} t] [{{fullurl: {{FULLPAGENAME}} | from=u}} u] [{{fullurl: {{FULLPAGENAME}} | from=v}} v] [{{fullurl: {{FULLPAGENAME}} | from=w}} w] [{{fullurl: {{FULLPAGENAME}} | from=x}} x] [{{fullurl: {{FULLPAGENAME}} | from=y}} y] [{{fullurl: {{FULLPAGENAME}} | from=z}} z]}}
</td></tr></table>{{#ifeq: {{lc: {{{float|no}}} }} | yes | | <div style="clear: both"></div>}}<noinclude>

== Template:CategoryTOC ==

This template is based on <span class="plainlinks">[http://www.mediawiki.org/wiki/Template:CategoryTOC Template:CategoryTOC]</span>.

It uses a modified version of the original markup, with various improvements and fixes. The documentation below was copied to this template, since we do not use [[Wikipedia:Wikipedia:Template_documentation#How_to_create_a_documentation_subpage | documentation sub-pages]]. <span class="plainlinks">[http://www.mediawiki.org/wiki/MediaWiki MediaWiki]</span> specific information, links and sub-templates have either been removed, or modified for the Avlis wiki. It has been reformatted, and modified for current usage with improved clarity.

See the <span class="plainlinks">[http://www.mediawiki.org/wiki/Template:CategoryTOC/doc original template documentation]</span> for further details.

== Template documentation ==

This template adds a horizontal ''alphanumeric'' table of contents (TOC) to a category page. It should ''only'' be added to category pages (normally after any category description, so it is above the first '''Subcategories''' or '''Pages in category''' heading). It is generally used for categories containing at least 200 total pages.

=== Usage ===

<pre style="white-space: pre">
{{CategoryTOC
| align = center / left / right
| top = yes / no
| numerals = group / separate / no
| uppercase = yes / no
| lowercase = no / yes
| float = no / yes
}}
</pre>

=== Parameters ===

<code>'''align'''</code> - Specifies the position. Default "value" is <code>center</code>:
* <code>center</code> (default)
* <code>left</code>
* <code>right</code>

<code>'''top'''</code> - Specifies if a link to the top of the category is included. Default "value" is <code>yes</code>:
* <code>yes</code> (default)
* <code>no</code>

<code>'''numerals'''</code> - Specifies if numerals are included Default "value" is <code>group</code>:
* <code>group</code> (default): There is one link for 0-9.
* <code>separate</code>: Each numeral 0, 1, ..., 9 has a separate link.
* <code>no</code>: No numeral link.

<code>'''uppercase'''</code> - Specifies if a link for each uppercase letter (A, B, ..., Z) is included. Default "value" is <code>yes</code>:
* <code>yes</code> (default)
* <code>no</code>

<code>'''lowercase'''</code> - Specifies if a link for each lowercase letter (a, b, ..., z) is included. Default "value" is <code>no</code>:
* <code>no</code> (default)
* <code>yes</code>

<code>'''float'''</code> - This specifies if the TOC should float around the next element (the default <code>'''align''' = center</code> does not float). See [[#Notes | Notes]] for more details. Default "value" is <code>no</code>:
* <code>no</code> (default)
* <code>yes</code>

=== Notes ===

* Parameter "values" in this template are not case sensitive, so either uppercase or lowercase "values" will work.
*: E.g., <code>'''align''' = Left</code>, <code>'''align''' = LEFT</code> or <code>'''align''' = lEfT</code> are all valid "values".
** Parameter "'''names'''" '''are''' case sensitive, and '''always lowercase'''!
**: E.g., <code>'''Align''' = left</code> is '''not''' a valid parameter "'''name'''".

* Parameters that are assigned any "value", other than the ones listed in [[#Parameters | Parameters]] (above), will use their default "value".
*: E.g., <code>'''align''' = bottom</code>, <code>'''align''' = Foo</code> or <code>'''align''' = </code> (defined with an empty/blank "value") will all use the default <code>'''align''' = center</code> "value".

* The MediaWiki version of <span class="plainlinks">[http://www.mediawiki.org/wiki/Template:CategoryTOC Template:CategoryTOC]</span> (what this is based on), will float around the next element (usually the first '''Subcategories''' or '''Pages in category''' heading) when <code>'''align''' = left</code> or <code>'''align''' = right</code> are used. While this adds more flexibility to category page design, it also means basic usage requires adding some method to clear the float. The Wikipedia version of [[Wikipedia:Template:Category_TOC | Category TOC]] does not float, since this can easily be added to a floating container element instead.

: Rather than forcing users to do it one way or the other, this template has an extra <code>'''float'''</code> parameter. The default "value" is <code>no</code> (like Wikipedia's version that doesn't float), and setting the "value" to <code>yes</code> will restore floating (the behavior of MediaWiki's version). This is primarily a convenience option, so that basic usage doesn't require extra markup, without losing the original float functionality. As mentioned, a simple container element can be used to make this float as well (with more options), so using the <code>'''float'''</code> parameter is entirely optional.

{{ns detect | template = [[Category:Templates |{{PAGENAME}}]] }}</noinclude>

Template:CategoryTOC - Revision history

Gorgon: Template:CategoryTOC- adds a horizontal ''alphanumeric'' table of contents (TOC) to a category page.