Changes between Version 73 and Version 74 of TagsPlugin


Ignore:
Timestamp:
Mar 30, 2014, 7:48:24 PM (6 years ago)
Author:
Steffen Hoffmann
Comment:

improve and update towards 0.7 features

Legend:

Unmodified
Added
Removed
Modified
  • TagsPlugin

    v73 v74  
    44#!NewsFlash
    55= News =
    6  2014-03-09:: current trunk is `tags-0.7rc` now after fixing annoying tag wiki link issues (#9630)
     6 2014-03-30:: current trunk is `tags-0.7rc` now after addressing wiki link issues (#9630) and wiki macro issues (#10636)
    77 2013-11-01:: Add tag change records, by default ''for wiki pages only'' (#2429)
    88 2013-05-20:: performance issues addressed in several ways (#4503)
     
    1010 2011-07-06:: Version 0.6 is a complete rewrite for Trac 0.11. This page documents that version. Refer to ["TagsPlugin/0.5"] for information on older versions of the plugin. Also works on Trac 0.12.
    1111= !ToDo =
    12  * release `tags-0.7`
     12 * release `tags-0.7` - scheduled for 07-May-2014
    1313}}}
    1414
     
    114114`[[TagCloud]]`
    115115
    116 Display a cloud of all tags. Note that for v0.7 you needed a work-around like `[[TagCloud(-Dummy)]]`, assuming you did not use the ''Dummy'' tag.
    117 
     116Display a cloud of all tags. Optional keyword arguments:
     117 caseless_sort:: Whether the tag cloud should be sorted case-sensitive.
     118 mincount:: Optional integer threshold to hide tags with smaller count.
     119
     120Optional query expressions including realm selection are supported as shown for `ListTagged`. Between v0.6 and v0.7 something like `[[TagCloud(-Dummy)]]` was strictly required as work-around, assuming you did not use the ''Dummy'' tag.
    118121
    119122== Install ==
    120123
    121124Generic installation guidelines are troubleshooting can be found at TracPlugins.
    122 
    123 Steps to install and configure this plugin are:
    124 
     125 Note before upgrading:: older !TagsPlugin configuration '''must be removed'''. In  particular `trac.wiki.web_ui.wikimodule = disabled` and `default_handler = TagsWikiModule`.
     126
     127Steps to install and configure this plugin:
    125128 1. '''Install'''
    126    * Dependencies:
    127       1. None:
    128    * Plugin:
     129   * Dependencies: none
     130   * Plugin: tags-0.6 is still stable, but obsoleted, and tags-0.7rc is even required for Trac >= 1.0 (see #9521)
    129131      1. Manually:
     132{{{#!comment
    130133         1. Download tags: [download:tagsplugin/tags/0.6 tags-0.6.zip] or grab
    131134            [/svn/tagsplugin/tags/0.6 the source] from SVN.
     135}}}
     136         1. Download tags: [download:tagsplugin/trunk/ tags-trunk.zip] or grab
     137            [/svn/tagsplugin/trunk the source] from SVN.
    132138         2. [trac:wiki:TracPlugins Build and install an egg] from this source.
    133139      1. with easy_install:
     
    137143         }}}
    138144 1. '''Configure'''
    139     * '''Note''':: older !TagsPlugin configuration '''must be removed'''. In  particular `trac.wiki.web_ui.wikimodule = disabled` and `default_handler = TagsWikiModule`.
    140     * Tags 0.6 has vastly simplified the configuration to the point where there are only two options, both of which are under the `[tags]` section:
    141       1. `ignore_closed_tickets = <bool>`
    142           * Whether to gather tags from closed tickets.
    143       1. `ticket_fields = <field>[, <field> ...]`
    144           * Ticket fields from which to gather tags. Defaults to `keywords`. Custom fields are currently not supported.
    145     * For v0.7, after install see the TracIni page for the available configuration options.
    146     * Example:
     145  * Tags v0.6 vastly simplified the configuration to the point where there are only two options under the `[tags]` section:
     146   1. `ignore_closed_tickets = <bool>`
     147    * Whether to gather tags from closed tickets.
     148   1. `ticket_fields = <field>[, <field> ...]`
     149    * Ticket fields from which to gather tags. Defaults to `keywords`. Custom fields are currently not supported.
     150  * Example:
    147151{{{
    148152#!ini
     
    151155ticket_fields = component, keywords, milestone
    152156}}}
    153 
     157  * For v0.7, after install see the TracIni page for the available configuration options.
     158   * Especially you may want to alter the following list of realms, you enable tag change records (default: ''wiki-only'' as shown here):
     159{{{
     160#!ini
     161[tags]
     162revisable_realms = wiki
     163}}}
    154164 1. '''Enable'''
    155165    * Update your TracIni file (`..../trac.ini`) with:
     
    169179    $ sudo /etc/init.d/apache2 restart
    170180    }}}
    171  1. '''Grant''' `TAGS_VIEW` and `TAGS_MODIFY` permissions to your users according to the policies that you'd like to implement. Permissions are assigned sinc v0.7 for a new install to anonymous and authenticated users respectively, and you'll only need to adjust that to your needs.
    172  1. '''Test'''   At this stage the plugin should be working and you should see a text control for tags in your Wiki edit page. You should also see an entry in the main navigation bar labeled ''Tags''.
     181 1. '''Grant''' `TAGS_VIEW` and `TAGS_MODIFY` permissions to your users according to the policies that you'd like to implement. Permissions are assigned since v0.7 for a new install to anonymous and authenticated users respectively, and you'll only need to adjust that to your needs.
     182 1. '''Test''' At this stage the plugin should be working and you should see a text control for tags in your Wiki edit page. You should also see an entry in the main navigation bar labeled ''Tags''.
    173183
    174184=== About i18n/l10n support ===
    175185
    176 The development version of this plugin is prepared for localization.
     186Since 0.7 this plugin is prepared for localization.
    177187
    178188But English message texts are still the (POSIX) default. If this isn't your preferred language, you can
     
    215225=== Most Recent Changes ===
    216226
    217 [[ChangeLog(/tagsplugin, 2)]]
     227[[ChangeLog(/tagsplugin, 3)]]
    218228
    219229[log:tagsplugin See more]