discourse/abbreviation-discourse-plugin

Name: abbreviation-discourse-plugin

Owner: Discourse

Description: A plugin for discourse to create abbreviation tags

Forked from: PoloGT/abbreviation-discourse-plugin

Created: 2016-10-19 03:40:43.0

Updated: 2018-04-25 18:31:06.0

Pushed: 2017-07-06 02:28:54.0

Homepage: null

Size: 20

Language: JavaScript

GitHub Committers

UserMost Recent Commit# Commits

Other Committers

UserEmailMost Recent Commit# Commits

README

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

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:

ins:
breviations_plugin_enabled:
default: true
client: true
breviations_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:

 posts:rebake

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


This work is supported by the National Institutes of Health's National Center for Advancing Translational Sciences, Grant Number U24TR002306. This work is solely the responsibility of the creators and does not necessarily represent the official views of the National Institutes of Health.