18 | | == Bugs/Feature Requests == |
19 | | Check the |
20 | | [query:?status=new&status=assigned&status=reopened&group=&component=TagsPlugin&order=priority existing bugs and feature requests]. If you have additional issues, create a |
21 | | [/newticket?component=TagsPlugin&owner=hasienda new ticket]. |
22 | | |
23 | | == Download == |
24 | | |
25 | | Download the zipped source from [download:tagsplugin here]. |
26 | | |
27 | | == Source == |
28 | | |
29 | | You can check out TagsPlugin from [http://trac-hacks.org/svn/tagsplugin here] using Subversion, or [source:tagsplugin browse the source] with Trac. |
30 | | |
31 | | == Installing == |
32 | | |
33 | | 1. install |
34 | | * By hand: |
35 | | 1. Download tags: [download:tagsplugin/tags/0.6 tags-0.6.zip] or grab |
36 | | [/svn/tagsplugin/tags/0.6 the source] from SVN. |
37 | | 2. [trac:wiki:TracPlugins Build and install an egg] from this source. |
38 | | * Using easy_install: |
39 | | {{{ |
40 | | easy_install http://trac-hacks.org/svn/tagsplugin/tags/0.6 |
41 | | }}} |
42 | | 4. Configure appropriately for your version of Trac. |
43 | | Update your [wiki:TracIni trac.ini] with this: |
44 | | {{{ |
45 | | [components] |
46 | | tractags.* = enabled |
47 | | }}} |
48 | | Be sure to remove any previous TagsPlugin configuration changes. In particular `trac.wiki.web_ui.wikimodule = disabled` and `default_handler = TagsWikiModule` '''must be removed'''. |
49 | | 5. Run `trac-admin <env> upgrade` on your Trac environment. |
50 | | 6. Restart your web server. |
51 | | 7. Grant `TAGS_VIEW` and `TAGS_MODIFY` permissions to your users according to the policies that you'd like to implement. |
52 | | |
53 | | At this stage the plugin should be working and you should see a text control for |
54 | | tags in your Wiki edit page. You should also see an entry in the main navigation |
55 | | bar labeled ''Tags''. |
56 | | |
57 | | == Configuring TagsPlugin == |
58 | | |
59 | | 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: |
60 | | |
61 | | `ignore_closed_tickets = <bool>` |
62 | | Whether to gather tags from closed tickets. |
63 | | |
64 | | `ticket_fields = <field>[, <field> ...]` |
65 | | eg. `ticket_fields = component, keywords`. |
66 | | |
67 | | Ticket fields from which to gather tags. Defaults to `keywords`. Custom fields are currently not supported. |
68 | | |
69 | | |
70 | | == What are tags? == |
| 18 | === What are tags? === |
| 19 | |
99 | | == Using the tags == |
100 | | |
101 | | Querying is implemented through the /tags uri handler, `the tag:<tag>` syntax or [http://projects.edgewall.com/trac/wiki/WikiMacros Trac Macros] as follows |
102 | | |
103 | | === /tags handler === |
104 | | |
105 | | Going to /tags under your project will show a list of all tags in the wiki. /tags/?q=<expression> will show all the objects matching ''<expression>''. 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]. |
106 | | |
107 | | |
108 | | |
109 | | == `tag:<tag>` or `tagged:<expr>` Usage == |
110 | | |
111 | | Both forms are identical and link to the tag search results for the expression. |
112 | | |
113 | | e.g. `tagged:todo` or `tagged:"plugin macro"`. |
114 | | |
115 | | == Tag expressions == |
| 51 | === Searching tags === |
| 52 | |
| 53 | Querying is implemented through the /tags uri handler, `the tag:<tag>` syntax or [http://projects.edgewall.com/trac/wiki/WikiMacros Trac Macros] as follows. |
| 54 | |
| 55 | ==== Tags expressions ==== |
131 | | === Examples === |
132 | | |
133 | | Intersection of `macro` and `plugin` tags: |
134 | | `tagged:"macro plugin"` |
135 | | |
136 | | Union of `macro` and `plugin` tags: |
137 | | `tagged:"macro or plugin"` |
138 | | |
139 | | Objects tagged `macro` or `plugin`, ''and'' `example` |
140 | | `tagged:"(macro or plugin) example"` |
141 | | |
142 | | == Macro Usage == |
143 | | |
144 | | === !ListTagged === |
145 | | |
146 | | `[[ListTagged(<expr>)]]` |
147 | | |
148 | | This will display a list of resources whose tags match `<expr>`. |
149 | | |
150 | | ==== Examples ==== |
151 | | |
152 | | Intersection of `macro` and `plugin` tags: |
153 | | `[[ListTagged(macro plugin)]]` |
154 | | |
155 | | All resources tagged `macro` but not `plugin`: |
156 | | `[[ListTagged(macro -plugin)]]` |
157 | | |
158 | | Tickets tagged with `macro`: |
159 | | `[[ListTagged(realm:ticket macro)]]` |
160 | | |
161 | | Pages tagged with `macro`: |
162 | | `[[ListTagged(realm:wiki macro)]]` |
163 | | |
164 | | === !TagCloud === |
| 71 | Examples:: |
| 72 | 1. Intersection of `macro` and `plugin` tags: `tagged:"macro plugin"` |
| 73 | 1. Union of `macro` and `plugin` tags: `tagged:"macro or plugin"` |
| 74 | 1. Objects tagged `macro` or `plugin`, ''and'' `example` `tagged:"(macro or plugin) example"` |
| 75 | |
| 76 | ==== /tags handler ==== |
| 77 | |
| 78 | Going to /tags under your project will show a list of all tags in the wiki. /tags/?q=<expression> will show all the objects matching ''<expression>''. 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]. |
| 79 | |
| 80 | ==== `tag:<tag>` or `tagged:<expression>` Usage ==== |
| 81 | |
| 82 | Both forms are identical and link to the tag search results for the expression. |
| 83 | |
| 84 | Example:: |
| 85 | * `tagged:todo` or `tagged:"plugin macro"`. |
| 86 | |
| 87 | ==== !ListTagged macro ==== |
| 88 | |
| 89 | `[[ListTagged(<expression>)]]` |
| 90 | |
| 91 | This will display a list of resources whose tags match `<expression>`. |
| 92 | |
| 93 | Examples:: |
| 94 | * Intersection of `macro` and `plugin` tags: `[[ListTagged(macro plugin)]]` |
| 95 | * All resources tagged `macro` but not `plugin`: `[[ListTagged(macro -plugin)]]` |
| 96 | * Tickets tagged with `macro`: `[[ListTagged(realm:ticket macro)]]` |
| 97 | * Pages tagged with `macro`: `[[ListTagged(realm:wiki macro)]]` |
| 98 | |
| 99 | ==== !TagCloud macro ==== |
| 105 | |
| 106 | == Install == |
| 107 | |
| 108 | Generic installation guidelines are troubleshooting can be found at TracPlugins. |
| 109 | |
| 110 | Steps to install and configure this plugin are: |
| 111 | |
| 112 | 1. '''Install''' |
| 113 | * Dependencies: |
| 114 | 1. None: |
| 115 | * Plugin: |
| 116 | 1. Manually: |
| 117 | 1. Download tags: [download:tagsplugin/tags/0.6 tags-0.6.zip] or grab |
| 118 | [/svn/tagsplugin/tags/0.6 the source] from SVN. |
| 119 | 2. [trac:wiki:TracPlugins Build and install an egg] from this source. |
| 120 | 1. with easy_install: |
| 121 | {{{ |
| 122 | #!sh |
| 123 | $ sudo easy_install https://trac-hacks.org/svn/tagsplugin/tags/0.6 |
| 124 | }}} |
| 125 | 1. '''Configure''' |
| 126 | * 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: |
| 127 | 1. `ignore_closed_tickets = <bool>` |
| 128 | * Whether to gather tags from closed tickets. |
| 129 | 1. `ticket_fields = <field>[, <field> ...]` |
| 130 | * eg. `ticket_fields = component, keywords`. |
| 131 | * Ticket fields from which to gather tags. Defaults to `keywords`. Custom fields are currently not supported. |
| 132 | * Note:: Be sure to remove any previous TagsPlugin configuration changes. In particular `trac.wiki.web_ui.wikimodule = disabled` and `default_handler = TagsWikiModule` '''must be removed'''. |
| 133 | 1. '''Enable''' |
| 134 | * Update your TracIni file (`..../trac.ini`) with: |
| 135 | {{{ |
| 136 | [components] |
| 137 | tractags.* = enabled |
| 138 | }}} |
| 139 | 1. '''Run''' on your Trac environment |
| 140 | {{{ |
| 141 | #!sh |
| 142 | $ trac-admin <env> upgrade |
| 143 | }}} |
| 144 | 1. '''Restart''' web server: |
| 145 | {{{ |
| 146 | #!sh |
| 147 | $ sudo /etc/init.d/apache2 restart |
| 148 | }}} |
| 149 | 1. '''Grant''' `TAGS_VIEW` and `TAGS_MODIFY` permissions to your users according to the policies that you'd like to implement. |
| 150 | |
| 151 | |
| 152 | At this stage the plugin should be working and you should see a text control for |
| 153 | tags in your Wiki edit page. You should also see an entry in the main navigation |
| 154 | bar labeled ''Tags''. |
| 155 | |
194 | | === Change Log === |
195 | | |
196 | | [[ChangeLog(/tagsplugin, 3)]] |
197 | | |
198 | | === Author/Contributors === |
| 182 | == Bugs & Feature Requests == |
| 183 | |
| 184 | Check the [query:?status=new&status=assigned&status=reopened&group=&component=TagsPlugin&order=priority existing bugs and feature requests]. If you have additional issues, create a [/newticket?component=TagsPlugin&owner=hasienda new ticket]. |
| 185 | |
| 186 | == Source & Download == |
| 187 | |
| 188 | You can check out !TagsPlugin from [http://trac-hacks.org/svn/tagsplugin here] using Subversion, or [source:tagsplugin browse the source] with Trac. |
| 189 | |
| 190 | You can also download the zipped source from [download:tagsplugin here]. |
| 191 | |
| 192 | === Most Recent Changes === |
| 193 | |
| 194 | [[ChangeLog(/tagsplugin, 2)]] |
| 195 | |
| 196 | == Author/Contributors == |