Changes between Version 88 and Version 89 of TagsPlugin


Ignore:
Timestamp:
Jan 18, 2017, 7:46:05 PM (7 years ago)
Author:
figaro
Comment:

Further cosmetic changes

Legend:

Unmodified
Added
Removed
Modified
  • TagsPlugin

    v88 v89  
    55== Description
    66
    7 This plugin implements both a generic tagging engine, and front ends for the Wiki and ticket systems. An extra text entry box is added to the Wiki edit page for tagging Wiki pages, and ticket fields (you can configure which ones) are treated as tags for the ticket system.
     7This plugin implements both a generic tagging engine and front ends for the Wiki and ticket systems. An extra text entry box is added to the Wiki edit page for tagging Wiki pages, and ticket fields (you can configure which ones) are treated as tags for the ticket system.
    88
    99This plugin was originally created by [wiki:muness Muness Alrubaie], but has since been completely rewritten by [wiki:athomas Alec Thomas], and now maintained by hasienda.
    1010
    11 Have a look at [wiki:TagsPlugin/RelatedHacks some other hacks], that may fit well and complement your !TagsPlugin installation nicely.
     11Have a look at [wiki:TagsPlugin/RelatedHacks some other plugins], that may fit well and complement your !TagsPlugin installation nicely.
    1212
    1313=== What are tags?
    1414
    15 Tags allow you to organize wiki entries under multiple categories, not just under one hierarchy. You can then search for wiki entries categorized under a tag or a collection of tags. In other words, tags provide a [http://en.wikipedia.org/wiki/Faceted_classification faceted classification system] for the Trac wiki.
     15Tags allow you to organize wiki entries under multiple categories, not just under one hierarchy. You can then search for wiki entries categorized under a tag or a collection of tags. In other words, tags provide a [wikipedia:Faceted_classification faceted classification system] for the Trac wiki.
    1616
    1717As an added bonus, tags are linked to the wiki entry of the same name, allowing you to describe them explicitly under the wiki entry of the same name. This allows for a flexible means for establishing the context of wiki entries. Besides this, tags also make it incredibly easy to create todo lists or indexes.
     
    8585
    8686This will display a list of resources whose tags match `<query>`.
    87  * v0.6 -> `[[ListTagged([realm:<realm> ]<query>)]]`
    88  * v0.7 -> `[[ListTagged([realm:<realm> ]<query>[,format=...][,cols=...])]]`
     87 * v0.6: `[[ListTagged([realm:<realm> ]<query>)]]`
     88 * v0.7: `[[ListTagged([realm:<realm> ]<query>[,format=...][,cols=...])]]`
    8989
    9090||'''Argument''' || '''Version''' || '''Description & Details''' || '''Default''' ||
    9191|| `realm:<realm>` || 0.6 ||''Optional.'' Restrict tags search to a specific `<realm>` where `<realm>` is `wiki` or `ticket` (accepts only one realm). ||`realm:ticket` ||
    92 || `<query>`         || 0.6 ||Displays a list of resources whose tags match `<query>`|| `None` ||
    93 || `format`        || 0.7 ||''Rendering Option.'' `oldlist` or `short` list in known !ListTagged style; `compact` - list with results shortend to just the description; `table` - table view similar to !TicketQuery with 'table' option || `short` ||
    94 || `cols`          || 0.7 ||''Rendering Option.'' A pipe (`|`) separated list of columns to show when used `format=table` option. Available options are:[[BR]] * `realm` - identifies to which realm the resource is (wiki or ticket);[[BR]] * `id` - shows the name of the wiki page (if resource is a wiki) or ticket number (if resource is a ticket); [[BR]] * `description` - first title (if resource is a wiki) or ticket summary (if resource is a ticket);[[BR]] * `tags` - all applied tags for such resource || `cols=id|description|tags` ||
     92|| `<query>` || 0.6 ||Displays a list of resources of which the tags match `<query>`|| `None` ||
     93|| `format` || 0.7 ||''Rendering Option.'' `oldlist` or `short` list in known !ListTagged style; `compact` - list with results shortend to just the description; `table` - table view similar to !TicketQuery with 'table' option || `short` ||
     94|| `cols` || 0.7 ||''Rendering Option.'' A pipe (`|`) separated list of columns to show when used `format=table` option. Available options are:[[BR]] * `realm` - identifies to which realm the resource is (wiki or ticket);[[BR]] * `id` - shows the name of the wiki page (if resource is a wiki) or ticket number (if resource is a ticket); [[BR]] * `description` - first title (if resource is a wiki) or ticket summary (if resource is a ticket);[[BR]] * `tags` - all applied tags for such resource || `cols=id|description|tags` ||
    9595
    9696 Examples::
     
    146146         }}}
    147147 1. '''Configure'''
    148   * Tags v0.6 vastly simplified the configuration to the point where there are only two options under the `[tags]` section:
     148  * Tags v0.6 has two options under the `[tags]` section of your TracIni file (`../conf/trac.ini`):
    149149   1. `ignore_closed_tickets = <bool>`
    150150    * Whether to gather tags from closed tickets.
     
    158158}}}
    159159  * For v0.7, after install see the TracIni page for the available configuration options.
    160    * Especially you may want to alter the following list of realms, you enable tag change records (default: ''wiki-only'' as shown here):
     160   * In particular, to alter the following list of realms enable the tag change records (default: ''wiki-only'' as shown here):
    161161 {{{#!ini
    162162[tags]
    163163revisable_realms = wiki
    164164}}}
    165  1. '''Enable''' plugin by updating your TracIni file (`../conf/trac.ini`) with:
     165 1. '''Enable''' plugin by updating your TracIni file with:
    166166 {{{#!ini
    167167[components]