[[PageOutline(2-5,Contents,pullout)]]
[[html(
)]]
'''Known (Confirmed) Issues'''
'''Priority Enhancements'''
'''News'''
* 07-Jan-2011: Plugin is being actively maintained for Trac 0.11 and Trac 0.12. Older versions are not maintained, including the 0.9 branch, however patches will be accepted.
[[html(
)]]
= 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 `[]` 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 `` 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 ``.
Rows starting with `||'` are ignored.
== Bugs/Feature Requests ==
Existing bugs and feature requests for AcronymsPlugin are
[report:9?COMPONENT=AcronymsPlugin here].
If you have any issues, create a
[http://trac-hacks.org/newticket?component=AcronymsPlugin&owner=rjollos new ticket].
== Download ==
Download the zipped source from [download:acronymsplugin here].
== Source ==
You can check out AcronymsPlugin from [http://trac-hacks.org/svn/acronymsplugin here] using Subversion, or [source:acronymsplugin 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 = Acronyms
}}}
== 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
{{{
#!text/html
RFC
}}}
`RFC2315` becomes
{{{
#!text/html
RFC 2315
}}}
`RFC2316` becomes
{{{
#!text/html
RFC2316
}}}
== Recent Changes ==
[[ChangeLog(acronymsplugin, 3)]]
== Author/Contributors ==
'''Author:''' [wiki:athomas] [[BR]]
'''Maintainer:''' [wiki:rjollos] [[BR]]
'''Contributors:'''