wiki:AcronymsPlugin

Version 18 (modified by rjollos, 2 years ago) (diff)

Added wikiprocessor formatting.

Auto-generated acronyms from a table in a Wiki page

Description

Automatically generates HTML acronyms from definitions in tables in a Wiki page (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.

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)

News

  • 07-Jan-2011: Plugin is being actively maintained for Trac 0.11 and Trac 0.12. The older versions such as the 0.9 branch are not maintained, however patches will be accepted.

Bugs/Feature Requests

Existing bugs and feature requests for AcronymsPlugin are here.

If you have any issues, create a new ticket.

Download

Download the zipped source from here.

Source

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

Configuration

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

In trac.ini 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

[11777] by rjollos on 2012-07-25 09:46:39
Added setup.cfg.
[10459] by rjollos on 2011-07-12 08:07:15
Show plugin's svn revision on webadmin plugin panel.
[9773] by rjollos on 2011-01-19 03:01:41
Bumped plugin version number to 0.2dev and added minimum required version for Trac.

Author/Contributors

Author: athomas
Maintainer: rjollos
Contributors: