Changes between Version 66 and Version 67 of TagsPlugin


Ignore:
Timestamp:
Jun 16, 2013, 2:33:28 PM (19 months ago)
Author:
hasienda
Comment:

some clean-up and corrections

Legend:

Unmodified
Added
Removed
Modified
  • TagsPlugin

    v66 v67  
    44#!NewsFlash
    55= News =
     6 2013-05-20:: performance issues addressed in several ways (#4503)
    67 2012-09-28:: Getting nearer to `tags-0.7` now: #9521 has been addressed - Trac 1.0 support in `trunk`.
    78 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.
    89= !ToDo =
    9  * resolve performance issues, i.e. #4503
    1010 * release `tags-0.7`
    1111}}}
     
    1717The 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.
    1818
    19 See also: KeywordSuggestPlugin, LoomingCloudsPlugin, TracKeywordsPlugin
     19Have a look at [wiki:TagsPlugin/RelatedHacks some other hacks], that may fit well and complement your !TagsPlugin installation nicely.
    2020
    2121=== What are tags? ===
     
    9393
    9494This will display a list of resources whose tags match `<query>`.
    95  * Version 0.6 -> `[[ListTagged([realm:<realm> ]<query>)]]`
    96  * Version 0.7dev -> `[[ListTagged([realm:<realm> ]<query>[,format=...][,cols=...])]]`
     95 * v0.6 -> `[[ListTagged([realm:<realm> ]<query>)]]`
     96 * v0.7 -> `[[ListTagged([realm:<realm> ]<query>[,format=...][,cols=...])]]`
    9797
    9898||'''Argument''' || '''Version''' || '''Description & Details''' || '''Default''' ||
    9999|| `realm:<realm>` || 0.6 ||''Optional.'' Restrict tags search to a specific `<realm>` where `<realm>` is `wiki` or `ticket` (accepts only one realm). ||`realm:ticket` ||
    100100|| `<query>`         || 0.6 ||Displays a list of resources whose tags match `<query>`|| `None` ||
    101 || `format`        || 0.7dev ||''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` ||
    102 || `cols`          || 0.7dev ||''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` ||
     101|| `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` ||
     102|| `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` ||
    103103
    104104 Examples::
     
    110110==== !TagCloud macro ====
    111111
    112 `[[TagCloud(-Dummy)]]`
    113 
    114 Display a cloud of all  tags, assuming you do not use the  '''Dummy''' tag.
     112`[[TagCloud]]`
     113
     114Display 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.
    115115
    116116
     
    141141      1. `ticket_fields = <field>[, <field> ...]`
    142142          * Ticket fields from which to gather tags. Defaults to `keywords`. Custom fields are currently not supported.
    143     * For Tags 0.7dev, after install see the TracIni page for the available configuration options.
     143    * For v0.7, after install see the TracIni page for the available configuration options.
    144144    * Example:
    145145{{{
     
    167167    $ sudo /etc/init.d/apache2 restart
    168168    }}}
    169  1. '''Grant''' `TAGS_VIEW` and `TAGS_MODIFY` permissions to your users according to the policies that you'd like to implement.
     169 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.
    170170 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''.
    171171
     
    193193python ./setup.py bdist_egg
    194194}}}
    195 Due to a know Trac issue Babel has to be installed prior to Trac, to get it all working as expected.[[BR]]
     195Due to a known Trac issue ''Babel has to be installed prior to Trac'', to get it all working as expected.[[BR]]
    196196Again, for more details see the [t:wiki:CookBook/PluginL10N#Compileanduseit l10n cookbook page for Trac plugins].
    197197
     
    215215[[ChangeLog(/tagsplugin, 2)]]
    216216
     217[log:tagsplugin See more]
     218
    217219== Author/Contributors ==
    218220