Acronym Definitions Plugin

A plugin to wrap acronyms in an HTML "acronym" element with "title" attribute

This plugin allows to create an "acronym definitions topic", containing a dot-point list of acronyms together with their definitions:

  • GNU - GNU's not Unix
  • FSF - Free Software Foundation

which the plugin will then use to wrap all instances of those acronyms in an HTML <acronym> tag, with the acronym definition as the tag's 'title' text. Web browsers such as Chromium then display the definition text as a popup when one hovers the mouse pointer over the acronym.

The dot-point list must be in the above format, i.e. each line must be of the form:

  • [acronym] - [definition]

with three leading spaces.

The plugin considers an 'acronym' to be a series of at least three upper-case letters.

Learn how to create your own plugin in DevelopingPlugins.

Preferences

Specify the acronym definition topic using the ACRONYMDEFINITIONSPLUGIN_ACRONYMDEFINITIONS preference in your SitePreferences topic, e.g.:

ACRONYMDEFINITIONSPLUGIN_ACRONYMDEFINITIONS = AcronymDefinitions

Installation

You do not need to install anything in the browser to use this extension. The following instructions are for the administrator who installs the extension on the server.

Open configure, and open the "Extensions" section. Use "Find More Extensions" to get a list of available extensions. Select "Install".

If you have any problems, or if the extension isn't available in configure, then you can still install manually from the command-line. See http://foswiki.org/Support/ManuallyInstallingExtensions for more help.

Info

Author: AlexisHazell
Copyright: © 2011, Foswiki Contributors
License: GPL (GNU General Public License)
Release: 0.1
Version: 14686 (2012-05-04)
Change History:  
1.0.0 (XX Mmm 20XX): Initial version
Home: http://foswiki.org/Extensions/AcronymDefinitionsPlugin
Support: http://foswiki.org/Support/AcronymDefinitionsPlugin

This topic: System > Category > AdminDocumentationCategory > Plugins > AcronymDefinitionsPlugin
Topic revision: 14 Jun 2012, UnknownUser
This site is powered by FoswikiCopyright © by the contributing authors. All material on this site is the property of the contributing authors.
Ideas, requests, problems regarding Foswiki? Send feedback