Changes between Version 73 and Version 74 of TagsPlugin

Timestamp:

Mar 30, 2014, 7:48:24 PM (10 years ago)

Author:

Steffen Hoffmann

Comment:

improve and update towards 0.7 features

TagsPlugin

@@ -4 +4 @@
 #!NewsFlash
 = News =
- 2014-03-09:: current trunk is `tags-0.7rc` now after fixing annoying tag wiki link issues (#9630)
+ 2014-03-30:: current trunk is `tags-0.7rc` now after addressing wiki link issues (#9630) and wiki macro issues (#10636)
  2013-11-01:: Add tag change records, by default ''for wiki pages only'' (#2429)
  2013-05-20:: performance issues addressed in several ways (#4503)
@@ -10 +10 @@
  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.
 = !ToDo =
- * release `tags-0.7`
+ * release `tags-0.7` - scheduled for 07-May-2014
 }}}
 
@@ -114 +114 @@
 `[[TagCloud]]`
 
-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.
-
+Display a cloud of all tags. Optional keyword arguments:
+ caseless_sort:: Whether the tag cloud should be sorted case-sensitive.
+ mincount:: Optional integer threshold to hide tags with smaller count.
+
+Optional 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.
 
 == Install ==
 
 Generic installation guidelines are troubleshooting can be found at TracPlugins.
-
-Steps to install and configure this plugin are:
-
+ Note before upgrading:: older !TagsPlugin configuration '''must be removed'''. In  particular `trac.wiki.web_ui.wikimodule = disabled` and `default_handler = TagsWikiModule`.
+
+Steps to install and configure this plugin:
  1. '''Install'''
-   * Dependencies:
-      1. None:
-   * Plugin:
+   * Dependencies: none
+   * Plugin: tags-0.6 is still stable, but obsoleted, and tags-0.7rc is even required for Trac >= 1.0 (see #9521)
       1. Manually:
+{{{#!comment
          1. Download tags: [download:tagsplugin/tags/0.6 tags-0.6.zip] or grab
             [/svn/tagsplugin/tags/0.6 the source] from SVN.
+}}}
+         1. Download tags: [download:tagsplugin/trunk/ tags-trunk.zip] or grab
+            [/svn/tagsplugin/trunk the source] from SVN.
          2. [trac:wiki:TracPlugins Build and install an egg] from this source.
       1. with easy_install:
@@ -137 +143 @@
          }}}
  1. '''Configure'''
-    * '''Note''':: older !TagsPlugin configuration '''must be removed'''. In  particular `trac.wiki.web_ui.wikimodule = disabled` and `default_handler = TagsWikiModule`.
-    * 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:
-      1. `ignore_closed_tickets = <bool>`
-          * Whether to gather tags from closed tickets.
-      1. `ticket_fields = <field>[, <field> ...]`
-          * Ticket fields from which to gather tags. Defaults to `keywords`. Custom fields are currently not supported.
-    * For v0.7, after install see the TracIni page for the available configuration options.
-    * Example:
+  * Tags v0.6 vastly simplified the configuration to the point where there are only two options under the `[tags]` section:
+   1. `ignore_closed_tickets = <bool>`
+    * Whether to gather tags from closed tickets.
+   1. `ticket_fields = <field>[, <field> ...]`
+    * Ticket fields from which to gather tags. Defaults to `keywords`. Custom fields are currently not supported.
+  * Example:
 {{{
 #!ini
@@ -151 +155 @@
 ticket_fields = component, keywords, milestone
 }}}
-
+  * For v0.7, after install see the TracIni page for the available configuration options.
+   * Especially you may want to alter the following list of realms, you enable tag change records (default: ''wiki-only'' as shown here):
+{{{
+#!ini
+[tags]
+revisable_realms = wiki
+}}}
  1. '''Enable'''
     * Update your TracIni file (`..../trac.ini`) with:
@@ -169 +179 @@
     $ sudo /etc/init.d/apache2 restart
     }}}
- 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.
- 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''.
+ 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.
+ 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''.
 
 === About i18n/l10n support ===
 
-The development version of this plugin is prepared for localization.
+Since 0.7 this plugin is prepared for localization.
 
 But English message texts are still the (POSIX) default. If this isn't your preferred language, you can
@@ -215 +225 @@
 === Most Recent Changes ===
 
-[[ChangeLog(/tagsplugin, 2)]]
+[[ChangeLog(/tagsplugin, 3)]]
 
 [log:tagsplugin See more]