[[PageOutline(2-5,Contents,pullout)]]

{{{#!NewsFlash
'''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.

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
{{{
#!text/html
	<a href="http://www.ietf.org/rfc.html">
	 <acronym title="Request For Comment">
	  RFC
	 </acronym>
	</a>
}}}

`RFC2315` becomes
{{{
#!text/html
	<a href="http://www.ietf.org/rfc/rfc2315.txt">
	 <acronym title="Request For Comment 2315">
	  RFC 2315
	 </acronym>
	</a>
}}}

`RFC2316` becomes
{{{
#!text/html
	<a href="Rfc2316">
	 <acronym title="Request For Comment 2316">
	  RFC2316
	 </acronym>
	</a>
}}}

See also: TracTerminologyPlugin, AbbrMacro

== Bugs/Feature Requests

Existing bugs and feature requests for AcronymsPlugin are 
[report:9?COMPONENT=AcronymsPlugin here].

If you have any issues, create a 
[/newticket?component=AcronymsPlugin new ticket].

[[TicketQuery(component=AcronymsPlugin&group=type,format=progress)]]

== Download

Download the zipped source from [export:acronymsplugin here].

== Source

You can check out AcronymsPlugin from [/svn/acronymsplugin here] using Subversion, or [source:acronymsplugin browse the source] with Trac.

== Installation

General instructions on installing Trac plugins can be found on the [TracPlugins#InstallingaTracplugin 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:

{{{#!ini
[acronym]
page = AcronymDefinitions
}}}

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

== Recent Changes

[[ChangeLog(acronymsplugin, 3)]]

== Author/Contributors

'''Author:''' [wiki:athomas] [[BR]]
'''Maintainer:''' [[Maintainer]] [[BR]]
'''Contributors:'''