User:Gorgon/Sandbox/Sandbox Charlie

This is a user sandbox of Gorgon. A user sandbox is a subpage of the user's user page. It serves as a testing spot and page development space for the user, and is not an Avlis wiki article.

Template:CategoryTOC

This template is based on Template:CategoryTOC.

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 documentation sub-pages. MediaWiki 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 original template documentation 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. It is generally used for categories containing at least 200 total pages.

Usage

{{CategoryTOC
 | align     = center / left / right
 | top       = yes / no
 | numerals  = group / separate / no
 | uppercase = yes / no
 | lowercase = no / yes
 | float     = no / yes
}}

Parameters

align - Specifies the position. Default is center:

• center (default)
• left
• right

top - Specifies if a link to the top of the category is included. Default is yes:

• yes (default)
• no

numerals - Specifies if numerals are included Default is group:

• group (default): There is one link for 0-9.
• separate: Each numeral 0, 1, ..., 9 has a separate link.
• no: No numeral link.

uppercase - Specifies if a link for each uppercase letter (A, B, ..., Z) is included. Default is yes:

• yes (default)
• no

lowercase - Specifies if a link for each lowercase letter (a, b, ..., z) is included. Default is no:

• no (default)
• yes

float - This specifies if the TOC should float around the next element (the default align = center does not float). See Notes for more details. Default is no:

• no (default)
• yes

Notes

• Parameter values in this template are not case sensitive, so either uppercase or lowercase values will work,
  • Parameter names are case sensitive, and always lowercase!

• The MediaWiki version of Template:CategoryTOC (what this is based on), will float around the next element (usually the first Subcategories header) when align = left or align = right 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 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 float parameter. The default value is no (like Wikipedia's version that doesn't float), and setting the value to yes 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 float parameter is entirely optional.