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

= Keyword replace plugin

== Description

This plugin allows you to replace keywords with any wiki format from a table in a Wiki page (Default as KeywordReplace). It can be time consuming to input units, links, etc. where a mapping would be easier to use. This plugin makes typewriting simpler. 

This plugin is based on the AcronymsPlugin.

== Bugs/Feature Requests

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

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

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

== Download

Download the zipped source from [download:keywordreplaceplugin here].

== Source

You can check out KeywordReplacePlugin from [http://trac-hacks.org/svn/keywordreplaceplugin here] using Subversion, or [source:keywordreplaceplugin browse the source] with Trac.

== Configuration

Create a Wiki page holding your keyword definitions (default as KeywordReplace).

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

{{{#!ini
[replace]
page = KeywordReplace
}}}

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

== Example

The following keyword definition table. The first column is defied keywords and the second column is values. The any wiki format could be input in the second column.
{{{
||= keywords =||= replace =||
||CO2       ||CO,,2,,                         ||
||m-2_s-1   ||m^-2^ s^-1^                     ||
||Google    ||[http://www.google.com Google]  ||
||oC        ||^o^C                            ||
||m-2       ||m^-2^                           ||
||Wheat     ||[wiki:Wheat Wheat]              ||
||C3        ||C,,3,,                          ||
||t_ha-1    ||t ha^-1^                        ||
}}}

The keywords in the first column would be replaced by values in the second column.

[[Image(keywords.png, width=150px, nolink)]]

== Recent Changes

[[ChangeLog(keywordreplaceplugin, 3)]]

== Author/Contributors

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