xurion / acronymizer.js

Wraps text in HTML with an acronym element.

#acronymizer.js

Wraps text in HTML with an element (acron by default) whilst keeping any bound events intact.

Link

https://github.com/xurion/acronymizer.js

Examples

Simple

var div = document.getElementById('myDiv'),
    acron = new Acronymizer({
        element: div,
        pattern: 'CSS'
    });

acron.init();

Advanced

var div = document.getElementById('myDiv'),
    acron = new Acronymizer();

acron.setElement(div);
acron.setPattern('PHP');
acron.setWrapper('a');
acron.setAttribute('href', 'php.html');
acron.init();

Install

To use acronymizer.js, simply add it to your markup:

<script type="text/javascript" src="acronymizer/dist/acronymizer.min.js"></script>

Skipping elements

To have acronymizer ignore elements, simply apply the "acronymizer-skip" class to that element. That element, as well as all nested elements, will be skipped.

History

acronymizer.js initially started it's life as an easy way to wrap text patterns in markup with acron elements. This allowed me to acronym abbreviations, like CSS and PHP and provide a tooltip as you hovered over it.

It has since been modified to be a JSHint-covered, tested class to allow the wrapping of any pattern with any element, along with any attributes.

acronymizer.js's Issues

Add class to element to block acronymizer

Add ability for acronymizer to ignore elements (and child elements) that have the class "acronymizer-skip"

Refactor complexity of acronymizer.innerHighlight

The complexity and nesting of loops and if statements need to be refactored.

Better error messages required for Acronymizer.go() failure.

By executing the Acronymizer.go() function without first defining either an element or pattern, the generic Error "All options have not been defined correctly" is thrown.

This needs to be made to throw a more specific Error. For example: "Cannot Acronymize: an element has not be defined" or "Cannot Acronymize: a pattern has not be defined".