Difference between revisions of "Template:AlphaIndexStart/doc"

From Wazeopedia
(Added example to doc)
(Expanded doc information)
Line 4: Line 4:
  
 
Requires the {{tl|AlphaIndexEnd}} be placed at the end of the last heading section.
 
Requires the {{tl|AlphaIndexEnd}} be placed at the end of the last heading section.
 +
 +
Headings can be at any legitimate level. Missing headings have no link on the page, so selecting them will not move to anyplace on the page unless an {{tl|anchor}} is added to the prior heading.
  
 
== Parameters ==
 
== Parameters ==
Line 20: Line 22:
 
{{AlphaIndexEnd}}
 
{{AlphaIndexEnd}}
 
</pre>
 
</pre>
 +
 +
The page [[North Carolina/Cities and Towns]] uses this template.
  
 
<includeonly>{{#ifeq:{{SUBPAGENAME}}|sandbox||
 
<includeonly>{{#ifeq:{{SUBPAGENAME}}|sandbox||

Revision as of 22:50, 10 March 2014

This is a documentation subpage for Template:AlphaIndexStart.
It contains usage information, categories and other content that is not part of the original template page.

Usage

Creates the initial <div> style to add a horizontal alphabetical index to a page of headers with just alphabetical entries.

Requires the {{AlphaIndexEnd}} be placed at the end of the last heading section.

Headings can be at any legitimate level. Missing headings have no link on the page, so selecting them will not move to anyplace on the page unless an {{anchor}} is added to the prior heading.

Parameters

The only parameter is optional and determines how many columns are used for the page. The default is 3.

Example

{{AlphaIndexStart}}
=== A ===
* Apple

=== B ===
* Baker

=== Z ===
* Zebra
{{AlphaIndexEnd}}

The page North Carolina/Cities and Towns uses this template.