Changes between Version 24 and Version 25 of TagsPlugin


Ignore:
Timestamp:
Jan 21, 2008, 2:31:37 PM (7 years ago)
Author:
athomas
Comment:

Consolidated docs into one page.

Legend:

Unmodified
Added
Removed
Modified
  • TagsPlugin

    v24 v25  
    2121[http://trac-hacks.org/newticket?component=TagsPlugin&owner=athomas new ticket].
    2222
    23 == Obtaining and Installing ==
    24 Follow the [wiki:TagsPlugin/Installation installation instructions].
     23== Installing TagsPlugin ==
     24
     25Note:  [http://peak.telecommunity.com/DevCenter/setuptools setuptools] must be installed on your system for this to work.
     26
     27  1. Install [http://projects.edgewall.com/trac/wiki/TracInstall Trac 0.11] and set up a [http://projects.edgewall.com/trac/wiki/TracInstall#CreatingaProjectEnvironment trac project].
     28  2. Download tags: [[download(/tagsplugin/tags/0.6, tags-0.6.zip)]] or grab
     29     [http://trac-hacks.org/svn/tagsplugin/tags/0.6 the source] from SVN.
     30  3. [trac:wiki:TracPlugins Build and install an egg] from this source.
     31  4. Configure appropriately for your version of Trac.
     32
     33    Update your [wiki:TracIni trac.ini] with this:
     34
     35    {{{
     36    [components]
     37    tractags.* = enabled
     38    }}}
     39
     40    ''Be sure to remove any previous TagsPlugin configuration changes. In  particular `trac.wiki.web_ui.wikimodule = disabled` and `default_handler = TagsWikiModule` '''must be removed'''.
     41
     42  5. Run `trac-admin <env> upgrade` on your Trac environment.
     43  6. Restart your web server.
     44
     45At this stage the plugin should be working and you should see a text control for
     46tags in your Wiki edit page. You should also see an entry in the main navigation
     47bar labeled ''Tags''.
     48
     49== Configuring TagsPlugin ==
     50
     51Tags 0.6 has vastly simplified the configuration to the point where there are only two options, both of which are under the `[tags]` section:
     52
     53`ignore_closed_tickets = <bool>`
     54  Whether to gather tags from closed tickets.
     55
     56`ticket_fields = <field>[, <field> ...]`
     57  eg. `ticket_fields = component, keywords`.
     58
     59  Ticket fields from which to gather tags. Defaults to `keywords`. Custom fields are currently not supported.
    2560
    2661== What are tags? ==