/abbreviation-discourse-plugin

A plugin for discourse to create abbreviation tags

Primary LanguageJavaScriptGNU General Public License v2.0GPL-2.0

abbreviation-discourse-plugin


This plugin translates certain whitelisted words to a HTML <abbr> tag. Example: if you register the word IMHO with the title "In My Humble Opinion" it will be automatically translated as <abbr title="In My Humble Opinion">IMHO</abbr>

##Features

  • Create a list of abbreviations
  • Configurable through admin settings
  • Option to disable the plugin through the admin settings.

NOTE: It is required to type at least one space either before or after the acronym, so the plugin doesn't interfere with existing features of discourse.

##Initial Configuration

Modify the variable abbreviations_plugin_list in the file settings.yml so it contains couples of abbreviation and meaning separated by a pipe (|). The abbreviation/acronym and its meaning must be separated by a colon (:) . Example:

plugins:
  abbreviations_plugin_enabled:
    default: true
    client: true
  abbreviations_plugin_list:
    default: IMHO:In My Honest Opinion|YMMV:Your Mileage May Vary|lol:Laughing Out Loud
    client: true

You cannot use colons (:) or pipes (|) in the definition of your abbreviations.

You can keep adding more acronyms through the admin panel later on.

##Old posts

Old posts can take advantage of this feature by issuing the command:

rake posts:rebake

A moderator can use the "Rebuild HTML" feature on a single message, to get advantage of this plugin.