Aloha Editor

Aloha Editor Guides

These guides help you to make your content editable and to develop Aloha Editor.

Abbr Plugin

The Abbr Plugin will wrap selected contents within an <abbr> tag. You can then specify a title text to describe the abbreviation.

1 Functional Description

To create an abbreviation highlight some text and click the abbreviation icon from the format tab. Now you can enter the description of the abbreviation which will be shown when hovering over the annotated word. For editing an abbreviation just click on the entered abbreviation and edit the text in the FloatingMenu. To delete an abbreviation just move the cursor to the abbreviation and click on the abbreviation button at the Aloha Editor again.

2 Configuration settings

To enable or disable the abbr plugin for single editables refere the following example. All editables have the abbr plugin activated. The abbr plugin is deactivated for the editable with the ID ‘two’.

Use a single array with the value [ 'abbr' ] to activate or an empty array [ ] to deactivate the plugin.


	Aloha.settings.plugins = {
		abbr: {
			config: [ 'abbr' ],

			editables: {
				'#one': [ 'abbr' ],
				'#two': [ ]
			}
		}
	};

3 Components

  • formatAbbr – format selection as an abbreviation
  • createAbbr – insert new abbreviation
  • editAbbr – edit existing abbreviation
  • abbrText – UIAttributeField for text input
  • removeAbbr – remove abbreviation from selection