Changes between Version 80 and Version 81 of TagsPlugin

Timestamp:

May 23, 2015, 8:10:27 AM (9 years ago)

Author:

figaro

Comment:

Cosmetic changes

TagsPlugin

@@ -1 +1 @@
 [[PageOutline(2-5,Contents,pullout)]]
 
-{{{
-#!NewsFlash
-= News =
- 2014-04-06:: '''`tractags-0.7` release'''
- 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 =
- * work towards release `tractags-0.8`
-}}}
-
 = A Tagging System for Trac
 
-The TagsPlugin 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.
-
-The TagsPlugin was originally created by [wiki:muness Muness Alrubaie] but has since been completely rewritten by [wiki:athomas Alec Thomas], and now maintained by hasienda.
+== Description
+
+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.
+
+This 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.
 
 Have a look at [wiki:TagsPlugin/RelatedHacks some other hacks], that may fit well and complement your !TagsPlugin installation nicely.
@@ -37 +30 @@
 
  1. Go to the wiki entry you want to tag.
- 2. Click on ''Edit This Page''
+ 2. Click on ''Edit This Page''.
  3. Under ''Change information'', ''Tag under:'', enter the tags you want to categorize the entry under. Separate tags with spaces.
  4. Click ''Save changes''.
@@ -50 +43 @@
 
  1. Go to the wiki entry you want to ''untag''.
- 2. Click on ''Edit This Page''
+ 2. Click on ''Edit This Page''.
  3. Under ''Change information'', ''Tag under:'', remove the tag from the list.
  4. Click ''Save changes''.
@@ -71 +64 @@
 ||`realm:<realm>`||Restrict to tags in `<realm>` where realm is `wiki`, `ticket`, etc.||
  3. Sub-expressions can be grouped inside parentheses `(`, `)`.
- 4. Expressions and individual tags can be quoted with single `'` or double `"` quotes. (check #3624)
+ 4. Expressions and individual tags can be quoted with single `'` or double `"` quotes (#3624).
 
  Examples::
@@ -80 +73 @@
 ==== /tags handler
 
-Going to /tags under your project will show a list of all tags in the wiki.  /tags/?q=<query> will show all the objects matching ''<query>''.  e.g. [http://trac-hacks.org/tags/?q=plugin]. This accepts all the parameters that the !ListTagged macro does.  e.g. [http://trac-hacks.org/tags?q=plugin%20or%20macro].
+Going to /tags under your project will show a list of all tags in the wiki. /tags/?q=<query> will show all the objects matching ''<query>'', eg [http://trac-hacks.org/tags/?q=plugin]. This accepts all the parameters that the !ListTagged macro does, eg [http://trac-hacks.org/tags?q=plugin%20or%20macro].
 
 ==== `tag:<tag>` or `tagged:<query>`
@@ -103 +96 @@
  Examples::
   * Intersection of `macro` and `plugin` tags:  `[[ListTagged(macro plugin)]]`
-  * All resources tagged  `macro` but not `plugin`:     `[[ListTagged(macro -plugin)]]`
+  * All resources tagged `macro` but not `plugin`:      `[[ListTagged(macro -plugin)]]`
   * Tickets tagged with `macro`:         `[[ListTagged(realm:ticket macro)]]`
   * Pages tagged with `macro`:         `[[ListTagged(realm:wiki macro)]]`
@@ -120 +113 @@
 
 Generic installation guidelines are troubleshooting can be found at TracPlugins.
- Note before upgrading:: older !TagsPlugin configuration '''must be removed'''. In  particular `trac.wiki.web_ui.wikimodule = disabled` and `default_handler = TagsWikiModule`.
+ 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:
@@ -131 +124 @@
          2. [trac:wiki:TracPlugins Build and install an egg] from this source.
       1. With `easy_install`:
-         {{{
-         #!sh
+         {{{#!sh
          $ sudo easy_install https://trac-hacks.org/svn/tagsplugin/tags/0.7
          }}}
@@ -142 +134 @@
     * Ticket fields from which to gather tags. Defaults to `keywords`. Custom fields are currently not supported.
   * Example:
-{{{
-#!ini
+{{{#!ini
 [tags]
 ignore_closed_tickets = true
@@ -150 +141 @@
   * 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
+{{{#!ini
 [tags]
 revisable_realms = wiki
 }}}
- 1. '''Enable'''
-    * Update your TracIni file (`..../trac.ini`) with:
-{{{
-#!ini
+ 1. '''Enable''' plugin by updating your TracIni file (`..../trac.ini`) with:
+{{{#!ini
 [components]
 tractags.* = enabled
 }}}
- 1. '''Run''' on your Trac environment
-    {{{
-    #!sh
+ 1. '''Run''' on your Trac environment:
+    {{{#!sh
     $ trac-admin <env> upgrade
     }}}
  1. '''Restart''' web server:
-    {{{
-    #!sh
+    {{{#!sh
     $ 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 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''.
+ 1. '''Test''' the plugin 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
 
-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
+Since 0.7 this plugin is prepared for localization, and English message texts are still the (POSIX) default. If this isn't your preferred language, you can
  1. check if it's already available from the [TracPluginTranslation Trac plugin l10n project] at [http://www.transifex.net/projects/p/Trac_Plugin-L10N/c/tractags Transifex] or
- 1. do it yourself (see the [http://trac.edgewall.org/wiki/CookBook/PluginL10N#Dotranslatorswork l10n cookbook page for Trac plugins] for more details).
+ 1. do it yourself, see the [http://trac.edgewall.org/wiki/CookBook/PluginL10N#Dotranslatorswork l10n cookbook page for Trac plugins] for more details.
 
 You've done a new translation? Superb! Contributing your translation is highly appreciated.
@@ -193 +177 @@
 
 Preparing the plugin from source requires '''no additional steps''' for compiling message catalog files. Only to include translations marked as `# fuzzy` by the translator, you'll want to do a manual message catalog compilation with the extra `-f` argument before packaging:
-{{{
+{{{#!sh
 cd tagsplugin/
 python ./setup.py compile_catalog -f
 python ./setup.py bdist_egg
-}}} 
+}}}
+
 Due to a known Trac issue ''Babel has to be installed prior to Trac'', to get it all working as expected.[[BR]]
 Again, for more details see the [t:wiki:CookBook/PluginL10N#Compileanduseit l10n cookbook page for Trac plugins].