Low Alphabet

• A-Z list tag pair
• Entries tag pair
• Entry IDs tag
• File Under tag
• Uppercase tag
• Lowercase tag

A-Z list tag pair

The {exp:low_alphabet:azlist} tag will generate a list of letters and/or numbers. Targeted entries are filed under these letters/numbers.

Parameters for low_alphabet:azlist tag pair

Parameter	Description
alpha_field	(Custom) field to use for alphabetical list. Defaults to title.
alpha_groups	A pipe-separated list of custom grouped letters to use for the A-Z list, eg. a-h|i-p|q-z. Note: make sure the same parameter is set on the Entries tag.
alpha_ignore	Pipe separated list of words to ignore for sorting.
author_id	Author id to filter by.
category	Category ids to filter by.
channel	Channel to filter by.
entry_id	Entry IDs to filter by.
group_numbers	Set to yes if you want to display all numbers as one item.
numbers	Either before, after or no, to display the numbers before or after the letters, or not at all. Defaults to before.
numbers_label	The label used for the grouped numbers. Defaults to 0-9.
search:field_name	Filter entries by any channel field, like the native search: parameters.
show_empty	Set to yes if you want to display the items that do not have matching entries.
show_expired	Set to yes if you want to include expired entries.
show_future_entries	Set to yes if you want to include future entries.
status	Statuses to filter by. Defaults to open.

Variables for the low_alphabet:azlist tag pair

Variable	Description
{low_alphabet_url}	The url-safe character, or lowercase letter.
{low_alphabet_label}	The character label, or uppercase letter.
{low_alphabet_entries}	Number of entries matching the letter and tag parameters.
{count}	The row count.
{total_results}	Total rows returned.

{exp:low_alphabet:azlist
  channel="products"
  alpha_field="title"
  alpha_ignore="the|a"
  numbers="after"
  group_numbers="yes"
  numbers_label="#"
}
  {if count == 1}<ol>{/if}
    <li>
      <a href="{path="products/list/{low_alphabet_url}"}" title="Products: {low_alphabet_entries}">
        {low_alphabet_label}
      </a>
    </li>
  {if count == total_results}</ol>{/if}
{/exp:low_alphabet:azlist}

Entries tag pair

The {exp:low_alphabet:entries} tag works identically to the {exp:channel:entries} tag, but has a couple of extra parameters and variables available. The dynamic parameter is automatically set to no, unless explicitly given.

Parameters for the low_alphabet:entries tag pair

Parameter	Description
alpha_field	By default, the first field in the orderby parameter is treated as alpha field. If you define this parameter, only the given field will be treated.
alpha_filter	Letter or number to filter entries by, for displaying entries starting with a given character. This parameter only accepts a single character or a x-y format, depending on alpha_groups.
alpha_groups	A pipe-separated list of custom grouped letters to use, eg. a-h|i-p|q-z. Note: make sure the same parameter is set on the A-Z list tag.
alpha_ignore	Pipe separated list of words to ignore for sorting.
auto_limit	Set to yes to ensure all entries will be displayed, instead of a limited/paginated list.
group_numbers	Set to yes if you want to display all numbers as one group.
numbers	Either before, after or no, to display the numbers before or after the letters, or not at all. Defaults to before.
numbers_label	The label used for the grouped numbers. Defaults to 0-9.
numeric_fields	If you’re using more than one field to order the entries by, and some of those are numeric fields instead of strings, add the numeric fields in this parameter.
orderby	All fields entered in the orderby parameter will be treated as though they were alpha fields. Setting this value will also default the sort parameter value to asc if not explicitly given. Defaults to title.

Note: using the alpha_groups parameter will limit the entries to only those that belong to one of those groups.

Variables for the low_alphabet:entries tag pair

Variable	Description
{low_alphabet_field}	The modified field used for sorting the entries, derived from the first field entered in the orderby parameter.
{low_alphabet_url}	The url-safe character (lowercase letter) the entry is grouped by.
{low_alphabet_label}	The character label (uppercase letter) the entry is grouped by.
{low_alphabet_heading}	Returns y if the entry is the first in its group.
{low_alphabet_footer}	Returns y if the entry is the last in its group.

{exp:low_alphabet:entries
    channel="products"
    alpha_ignore="the|a"
    numbers="after"
    group_numbers="yes"
    numbers_label="#"
    alpha_filter="{segment_3}"
    orderby="title"
    sort="asc"
    disable="categories|member_data|pagination"
}
  {if count == 1}<h2>Our Products</h2>{/if}
  {if low_alphabet_heading}
    <h3>{low_alphabet_label}</h3>
    <ul>
  {/if}
      <li><a href="{url_title_path="products/view"}">{title}</a></li>
  {if low_alphabet_footer}
    </ul>
  {/if}
{/exp:low_alphabet:entries}

Entry IDs tag

The Entry IDs tag will return a pipe-separated list of entry IDs ordered alphabetically. You can use both the single tag syntax as the tag pair syntax. If you’re using it as a tag pair, use the variable {low_alphabet:entry_ids} to output the entry IDs. You can use all the parameters available in the Entries tag pair in addition to the following ones:

Parameters for Entry IDs tag

Parameter	Description
separator	The character used to separate the entry IDs. Defaults to |
no_results	If defined, the tag will return its value when there are no matching entry IDs. This value will override the {if no_results} conditional.

{exp:low_alphabet:entry_ids channel="products" separator=","}

{exp:low_alphabet:entry_ids channel="products"}
  {low_alphabet:entry_ids}
{/exp:low_alphabet:entry_ids}

File Under tag pair

Use the {exp:low_alphabet:file_under} tag pair to return the letter or letter group under which the given text is filed.

Parameters for the low_alphabet:file_under tag pair

Parameter	Description
alpha_groups	A pipe-separated list of custom grouped letters to use, eg. a-h|i-p|q-z.
alpha_ignore	Pipe separated list of words to ignore for classifying.
group_numbers	Set to yes if you want to display all numbers as one group.
numbers_label	The label used for the grouped numbers. Defaults to 0-9.
text	The input text used to determine the alphabetical classification.

Variables for the low_alphabet:file_under tag pair

Variable	Description
{low_alphabet_url}	The url-safe character (lowercase letter) the text is filed under.
{low_alphabet_label}	The character label (uppercase letter) the text is filed under.

{exp:low_alphabet:file_under
    alpha_ignore="the|a"
    group_numbers="yes"
    numbers_label="#"
    text="Hello World"
}
  Hello World is filed under <a href="#{low_alphabet_url}">{low_alphabet_label}</a>
{/exp:low_alphabet:file_under}

Using a fourth tag part

In adition to the tag pair, the label and url can be outputted separately, by using label or url as a fourth tag part. With this, you can also use the text inside the tag pair as the source for the input, rather than using the text parameter. For example:

{exp:low_alphabet:file_under:label
    alpha_ignore="the|a"
    group_numbers="yes"
    numbers_label="#"
}
  Hello World
{/exp:low_alphabet:file_under:label}

The above will output H.

Uppercase tag

Use this single tag to transform text from lowercase to uppercase.

Parameters for the low_alphabet:uppercase tag

Parameter	Description
numbers_label	If the text parameter equals the grouped numbers url marker (0-9), use this parameter to override the output.
text	Text to transform. Required parameter.
word	Set to yes to transform the complete text in the text parameter. Otherwise only the first letter is returned.

{exp:low_alphabet:uppercase text="{segment_3}" numbers_label="#"}

Lowercase tag

Use this single tag to transform text from uppercase to lowercase. Parameters are identical to the Uppercase tag.

{exp:low_alphabet:lowercase text="{segment_3}" numbers_label="#"}