Low Alphabet Documentation

Tags

These terms are used throughout the documentation:
required: This parameter/field is required for this tag to function.
form only: This can only be set as a field in the form and not as a parameter in the tag.
param only: This parameter can only be set in the tag and not as a field in the form.
fixed value: This field cannot be edited and is set with a fixed value.
recurring only: This parameter/field only applies to recurring charges.
one-time only: This parameter/field only applies to one-time charges.
added in X.X.X: This parameter/field is only available from this version forward.
logged in: This tag is only available if the user is logged in.
Low Alphabet has the following front-end tags:
{exp:low_alphabet:azlist}
This will generate a list of letters and/or numbers. Targeted entries are filed under these letters/numbers. *Please Note: This is a tag Pair*
{exp:low_alphabet:entries}
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. *Please Note: This is a tag Pair*
{exp:low_alphabet:entry_ids}
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 are 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:
{exp:low_alphabet:file_under}
Use the {exp:low_alphabet:file_under} tag pair to return the letter or letter group under which the given text is filed.
{exp:low_alphabet:uppercase}
Use this single tag to transform text from lowercase to uppercase.
{exp:low_alphabet:lowercase}
Use this single tag to transform text from uppercase to lowercase.
{exp:low_alphabet:azlist}
This will generate a list of letters and/or numbers. Targeted entries are filed under these letters/numbers. *Please Note: This is a tag Pair*
Parameters
alpha_field
string
(Custom) field to use for alphabetical list. Defaults to title.
Default: title
{exp:low_alphabet:azlist alpha_field="title"}
alpha_groups
list as string
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.
Default: title
{exp:low_alphabet:azlist alpha_groups="a-h|i-p|q-z"}
alpha_ignore
list as string
Pipe separated list of words to ignore for sorting.
{exp:low_alphabet:azlist alpha_ignore="the|a"}
author_id
integer
Author id to filter by.
{exp:low_alphabet:azlist author_id="1"}
category
integer
Category ids to filter by.
{exp:low_alphabet:azlist category="1"}
channel
string
Channel to filter by.
{exp:low_alphabet:azlist channel="products"}
entry_id
integer
Entry IDs to filter by.
{exp:low_alphabet:azlist entry_id="1"}
group_numbers
yes or no
Set to yes if you want to display all numbers as one item.
{exp:low_alphabet:azlist group_numbers="yes"}
numbers
before | after | no
Either before, after or no, to display the numbers before or after the letters, or not at all. Defaults to before.
Default: before
{exp:low_alphabet:azlist numbers="no"}
numbers_label
The label used for the grouped numbers. Defaults to 0-9.
Default: 0-9
{exp:low_alphabet:azlist numbers_label="#"}
search
string
Filter entries by any channel field
{exp:low_alphabet:azlist search="searchTerm"}
show_empty
yes or no
Set to yes if you want to display the items that do not have matching entries.
{exp:low_alphabet:azlist show_empty="yes"}
show_expired
yes or no
Set to yes if you want to include expired entries.
{exp:low_alphabet:azlist show_expired="yes"}
show_future_entries
yes or no
Set to yes if you want to include future entries.
{exp:low_alphabet:azlist show_future_entries="yes"}
status
Avialable Statuses
Statuses to filter by. Defaults to open.
Default: open
{exp:low_alphabet:azlist status="closed"}
Variables
low_alphabet_url
The url-safe character, or lowercase letter.
{low_alphabet_url}
low_alphabet_label
The character label, or uppercase letter.
{low_alphabet_label}
low_alphabet_entries
Number of entries matching the letter and tag parameters.
{low_alphabet_entries}
count
The row count.
{count}
total_results
Total rows returned.
{total_results}
{exp:low_alphabet:entries}
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. *Please Note: This is a tag Pair*
Parameters
alpha_field
string
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.
Default: first field
{exp:low_alphabet:entries alpha_field="field"}
alpha_filter
character OR x-y format
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.
{exp:low_alphabet:entries alpha_filter="a"}
alpha_groups
list
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. Note: using the alpha_groups parameter will limit the entries to only those that belong to one of those groups.
{exp:low_alphabet:entries alpha_groups="a-h|i-p|q-z"}
alpha_ignore
list
Pipe separated list of words to ignore for sorting.
{exp:low_alphabet:entries alpha_ignore="the|a"}
auto_limit
yes or no
Set to yes to ensure all entries will be displayed, instead of a limited/paginated list.
{exp:low_alphabet:entries auto_limit="yes"}
group_numbers
yes or no
Set to yes if you want to display all numbers as one group.
{exp:low_alphabet:entries group_numbers="yes"}
numbers
before OR after OR no
Either before, after or no, to display the numbers before or after the letters, or not at all. Defaults to before.
Default: before
{exp:low_alphabet:entries numbers="no"}
numbers_label
The label used for the grouped numbers. Defaults to 0-9.
Default: 0-9
{exp:low_alphabet:entries numbers_label="#"}
numeric_fields
If you are 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.
{exp:low_alphabet:entries numeric_fields="1"}
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.
Default: title
{exp:low_alphabet:entries orderby="title"}
Variables
low_alphabet_field
The modified field used for sorting the entries, derived from the first field entered in the orderby parameter.
{low_alphabet_field}
low_alphabet_url
The url-safe character (lowercase letter) the entry is grouped by.
{low_alphabet_url}
low_alphabet_label
The character label (uppercase letter) the entry is grouped by.
{low_alphabet_label}
low_alphabet_heading
Returns y if the entry is the first in its group.
{low_alphabet_heading}
low_alphabet_footer
Returns y if the entry is the last in its group.
{low_alphabet_footer}
{exp:low_alphabet:entry_ids}
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 are 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:
Tag Parameters
separator
character
The character used to separate the entry IDs. Defaults to |
Default: |
{exp:low_alphabet:entry_ids separator=","}
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 no_results="yes"}
{exp:low_alphabet:file_under}
Use the {exp:low_alphabet:file_under} tag pair to return the letter or letter group under which the given text is filed.
Tag Parameters
alpha_groups
list
A pipe-separated list of custom grouped letters to use, eg. a-h|i-p|q-z.
{exp:low_alphabet:file_under alpha_groups="a-l"|"x-z"}
alpha_ignore
list
Pipe separated list of words to ignore for classifying.
{exp:low_alphabet:file_under alpha_ignore="the|a"}
group_numbers
yes or no
Set to yes if you want to display all numbers as one group.
{exp:low_alphabet:file_under group_numbers="yes"}
numbers_label
The label used for the grouped numbers. Defaults to 0-9.
Default: 0-9
{exp:low_alphabet:file_under numbers_label="0-5"}
text
The input text used to determine the alphabetical classification.
{exp:low_alphabet:file_under text="input"}
Variables
low_alphabet_url
The url-safe character (lowercase letter) the text is filed under.
{low_alphabet_url}
low_alphabet_label
The character label (uppercase letter) the text is filed under.
{low_alphabet_label}
{exp:low_alphabet:uppercase}
Use this single tag to transform text from lowercase to uppercase.
Tag Parameters
numbers_label
If the text parameter equals the grouped numbers url marker (0-9), use this parameter to override the output.
{exp:low_alphabet:uppercase numbers_label="#"}
text
required
Text to transform. Required parameter.
{exp:low_alphabet:uppercase text="inputText"}
word
yes or no
Set to yes to transform the complete text in the text parameter. Otherwise only the first letter is returned.
{exp:low_alphabet:uppercase word="yes"}
{exp:low_alphabet:lowercase}
Use this single tag to transform text from uppercase to lowercase.
Tag Parameters
numbers_label
If the text parameter equals the grouped numbers url marker (0-9), use this parameter to override the output.
{exp:low_alphabet:lowercase numbers_label="#"}
text
required
Text to transform. Required parameter.
{exp:low_alphabet:lowercase text="inputText"}
word
yes or no
Set to yes to transform the complete text in the text parameter. Otherwise only the first letter is returned.
{exp:low_alphabet:lowercase word="yes"}

Support

Having problems setting up and/or using Low Alphabet? Support is offered from 10am to 4pm EST weekdays. Send us an email at help@eeharbor.com and we will respond as quickly as we can.

loading