Changes between Version 80 and Version 81 of TagsPlugin
- Timestamp:
- May 23, 2015, 8:10:27 AM (9 years ago)
Legend:
- Unmodified
- Added
- Removed
- Modified
-
TagsPlugin
v80 v81 1 1 [[PageOutline(2-5,Contents,pullout)]] 2 2 3 {{{4 #!NewsFlash5 = News =6 2014-04-06:: '''`tractags-0.7` release'''7 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.8 = !ToDo =9 * work towards release `tractags-0.8`10 }}}11 12 3 = A Tagging System for Trac 13 4 14 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. 15 16 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. 5 == Description 6 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. 8 9 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. 17 10 18 11 Have a look at [wiki:TagsPlugin/RelatedHacks some other hacks], that may fit well and complement your !TagsPlugin installation nicely. … … 37 30 38 31 1. Go to the wiki entry you want to tag. 39 2. Click on ''Edit This Page'' 32 2. Click on ''Edit This Page''. 40 33 3. Under ''Change information'', ''Tag under:'', enter the tags you want to categorize the entry under. Separate tags with spaces. 41 34 4. Click ''Save changes''. … … 50 43 51 44 1. Go to the wiki entry you want to ''untag''. 52 2. Click on ''Edit This Page'' 45 2. Click on ''Edit This Page''. 53 46 3. Under ''Change information'', ''Tag under:'', remove the tag from the list. 54 47 4. Click ''Save changes''. … … 71 64 ||`realm:<realm>`||Restrict to tags in `<realm>` where realm is `wiki`, `ticket`, etc.|| 72 65 3. Sub-expressions can be grouped inside parentheses `(`, `)`. 73 4. Expressions and individual tags can be quoted with single `'` or double `"` quotes . (check #3624)66 4. Expressions and individual tags can be quoted with single `'` or double `"` quotes (#3624). 74 67 75 68 Examples:: … … 80 73 ==== /tags handler 81 74 82 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].75 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]. 83 76 84 77 ==== `tag:<tag>` or `tagged:<query>` … … 103 96 Examples:: 104 97 * Intersection of `macro` and `plugin` tags: `[[ListTagged(macro plugin)]]` 105 * All resources tagged 98 * All resources tagged `macro` but not `plugin`: `[[ListTagged(macro -plugin)]]` 106 99 * Tickets tagged with `macro`: `[[ListTagged(realm:ticket macro)]]` 107 100 * Pages tagged with `macro`: `[[ListTagged(realm:wiki macro)]]` … … 120 113 121 114 Generic installation guidelines are troubleshooting can be found at TracPlugins. 122 Note before upgrading:: older !TagsPlugin configuration '''must be removed'''. In particular`trac.wiki.web_ui.wikimodule = disabled` and `default_handler = TagsWikiModule`.115 Note before upgrading:: older !TagsPlugin configuration '''must be removed'''. In particular, `trac.wiki.web_ui.wikimodule = disabled` and `default_handler = TagsWikiModule`. 123 116 124 117 Steps to install and configure this plugin: … … 131 124 2. [trac:wiki:TracPlugins Build and install an egg] from this source. 132 125 1. With `easy_install`: 133 {{{ 134 #!sh 126 {{{#!sh 135 127 $ sudo easy_install https://trac-hacks.org/svn/tagsplugin/tags/0.7 136 128 }}} … … 142 134 * Ticket fields from which to gather tags. Defaults to `keywords`. Custom fields are currently not supported. 143 135 * Example: 144 {{{ 145 #!ini 136 {{{#!ini 146 137 [tags] 147 138 ignore_closed_tickets = true … … 150 141 * For v0.7, after install see the TracIni page for the available configuration options. 151 142 * Especially you may want to alter the following list of realms, you enable tag change records (default: ''wiki-only'' as shown here): 152 {{{ 153 #!ini 143 {{{#!ini 154 144 [tags] 155 145 revisable_realms = wiki 156 146 }}} 157 1. '''Enable''' 158 * Update your TracIni file (`..../trac.ini`) with: 159 {{{ 160 #!ini 147 1. '''Enable''' plugin by updating your TracIni file (`..../trac.ini`) with: 148 {{{#!ini 161 149 [components] 162 150 tractags.* = enabled 163 151 }}} 164 1. '''Run''' on your Trac environment 165 {{{ 166 #!sh 152 1. '''Run''' on your Trac environment: 153 {{{#!sh 167 154 $ trac-admin <env> upgrade 168 155 }}} 169 156 1. '''Restart''' web server: 170 {{{ 171 #!sh 157 {{{#!sh 172 158 $ sudo /etc/init.d/apache2 restart 173 159 }}} 174 160 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. 175 1. '''Test''' At this stage the plugin should be workingand 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''.161 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''. 176 162 177 163 === About i18n/l10n support 178 164 179 Since 0.7 this plugin is prepared for localization. 180 181 But English message texts are still the (POSIX) default. If this isn't your preferred language, you can 165 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 182 166 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 183 1. do it yourself (see the [http://trac.edgewall.org/wiki/CookBook/PluginL10N#Dotranslatorswork l10n cookbook page for Trac plugins] for more details).167 1. do it yourself, see the [http://trac.edgewall.org/wiki/CookBook/PluginL10N#Dotranslatorswork l10n cookbook page for Trac plugins] for more details. 184 168 185 169 You've done a new translation? Superb! Contributing your translation is highly appreciated. … … 193 177 194 178 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: 195 {{{ 179 {{{#!sh 196 180 cd tagsplugin/ 197 181 python ./setup.py compile_catalog -f 198 182 python ./setup.py bdist_egg 199 }}} 183 }}} 184 200 185 Due to a known Trac issue ''Babel has to be installed prior to Trac'', to get it all working as expected.[[BR]] 201 186 Again, for more details see the [t:wiki:CookBook/PluginL10N#Compileanduseit l10n cookbook page for Trac plugins].