wiki:AcronymsPlugin

Known (Confirmed) Issues

  • Valid acronyms with underlined wiki markup are not tagged as acronyms (#8377)
  • Character subsets of words are matched as acronyms (#8429)

Priority Enhancements

  • Allow multiple acronym definition pages to be specified (#8420)
  • Allow for a common Acronyms file for multiple projects (#8404)
  • Allow CamelCase words to be acronyms (#8267)

Auto-generated acronyms from a table in a Wiki page

Description

This plugin automatically generates HTML acronyms from definitions in tables in a Wiki page. These are AcronymDefinitions by default.

Acronyms are in the form <acronym>[<id>] and are defined in a table with four columns:

Acronym, Description [, URL [, ID URL]]

Only the first two columns are required.

URL can be the name of a wiki page, the name of which does not have to be CamelCase and can even be a subpage (e.g. MyPage/MySubPage), or an external resource. If an <id> is provided, the ID URL is used and any occurrences of the symbol $1 in the description and the ID URL are substituted with the <id>.

Rows starting with ||' are ignored.

See also: TracTerminologyPlugin, AbbrMacro

Bugs/Feature Requests

Existing bugs and feature requests for AcronymsPlugin are here.

If you have any issues, create a new ticket.

defect

13 / 17

enhancement

3 / 7

task

1 / 1

Download

Download the zipped source from here.

Source

You can check out AcronymsPlugin from here using Subversion, or browse the source with Trac.

Installation

General instructions on installing Trac plugins can be found on the TracPlugins page.

Configuration

Create a Wiki page holding your acronym definitions in the way described above, for example Acronyms.

In your trac.ini file add the following section to make the plugin aware of this storage page:

[acronym]
page = AcronymDefinitions

The storage page is AcronymDefinitions by default if not specified in trac.ini.

Example

The following acronym definition table:

||'''Acronym'''||'''Description'''        ||'''URL'''                    ||'''ID URL'''||
||RFC          ||Request For Comment $1   ||http://www.ietf.org/rfc.html ||http://www.ietf.org/rfc/rfc$1.txt||
||RFC2316      ||Request For Comment 2316 ||Rfc2316                      || ||

Has the following effect:

RFC becomes

    <a href="http://www.ietf.org/rfc.html">
     <acronym title="Request For Comment">
      RFC
     </acronym>
    </a>

RFC2315 becomes

    <a href="http://www.ietf.org/rfc/rfc2315.txt">
     <acronym title="Request For Comment 2315">
      RFC 2315
     </acronym>
    </a>

RFC2316 becomes

    <a href="Rfc2316">
     <acronym title="Request For Comment 2316">
      RFC2316
     </acronym>
    </a>

Recent Changes

14820 by rjollos on 2015-07-20 06:38:06
0.2: Require Trac >= 0.11.
14749 by rjollos on 2015-06-25 23:30:18
0.2: Define option using Option class.
14748 by rjollos on 2015-06-25 23:24:39
0.2: Release 0.2. Added unit tests.
(more)

Author/Contributors

Author: athomas
Maintainer: Ryan J Ollos
Contributors:

Last modified 5 weeks ago Last modified on Aug 17, 2016, 11:01:20 PM