Acronym 1.5.1 Usage
Within your Expression Engine Templates you use the {exp:acronym} tag. This tag is the core of this module. Here is an example showing you the tag in action:
{exp:acronym acronym_group_name="Medical"}
Your text using some acronyms like ICU or ER and stuff like that.
{/exp:acronym}
General Module Preferences
In the control panel you can set the number of acronyms to be displayed when viewing an acronym list.
Acronym Group Preferences
In the control panel you can set the preferences for each individual acronym group. Follow the 'Edit Acronym Group' link to set the preferences for this group.
Enable dollar $ sign use
When set to 'on' Acronyms wrapped between a pair of '$' will be ignored and the '$' get removed.
Case sensitive
When set to 'on' use case sensitivity to match acronyms.
Having defined the acronym ICU in capitals:
In the content ICU will work but icu will be ignored when using case sensitivity.
Replace string function
When set to 'on' acronyms get replaced by the full description.
In the content ICU will be rendered as Intensive Care Unit
Switch
When checked reverses the process using '$' wrapping. Only acronyms wrapped between a pair of dollar signs get parsed with acronym functionality.
Tips and Tricks
The acronym module can be used in many different ways that extend the use from just working with an acronym and its description.
Kurt Deutscher for example created a dynamic glossary system for a site with really tough vocabulary. The author has about 100 words listed, and now anytime one of them is used on the site, it dynamically becomes a link that calls a small pop-up window with a definition of the word (as within the context of this author's site). For an example and more information visit: NetRaising Web Development Services.
Using the ReplaceString function you can turn an acronym into a link. Simply enter as the acronym definition an html formatted link. Whenever the acronym is used in the content it will be replaced by the link.
Using Acronym and ReplaceString at the same time:
It is very easy to use the acronym and replacestring function at the same time. Per acronym group you either have it set to acronym or to replacestring. However, if you wish to use that functionality at the same time you can create two seperate acronym groups. One for the acronyms and one for the string replacements. In your template you simply call the Acronym Module twice:
{exp:acronym acronym_group_name='Standard'}
{exp:acronym acronym_group_name='links'}
...content...
{/exp:acronym}
{/exp:acronym}