Version 40 (modified by 14 years ago) (diff) | ,
---|
A Tagging System for Trac
The TagsPlugin implements both a generic tagging engine, and frontends 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 Muness Alrubaie but has since been completely rewritten by Alec Thomas.
See also: KeywordSuggestPlugin
Bugs/Feature Requests
Check the existing bugs and feature requests. If you have additional issues, create a new ticket.
Installing TagsPlugin
- install
- By hand:
- Download tags: [download:tagsplugin/tags/0.6 tags-0.6.zip] or grab the source from SVN.
- Build and install an egg from this source.
- Using easy_install:
easy_install http://trac-hacks.org/svn/tagsplugin/tags/0.6
- By hand:
- Configure appropriately for your version of Trac.
Update your trac.ini with this:
[components] tractags.* = enabled
Be sure to remove any previous TagsPlugin configuration changes. In particulartrac.wiki.web_ui.wikimodule = disabled
anddefault_handler = TagsWikiModule
must be removed. - Run
trac-admin <env> upgrade
on your Trac environment. - Restart your web server.
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. (If you don't, check your anonymous and authenticated users for TAGS_* permisions.)
Configuring TagsPlugin
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:
ignore_closed_tickets = <bool>
Whether to gather tags from closed tickets.
ticket_fields = <field>[, <field> ...]
eg.
ticket_fields = component, keywords
.
Ticket fields from which to gather tags. Defaults to
keywords
. Custom fields are currently not supported.
What are tags?
Tags are like hierarchically organized wiki entries, however with them you can categorize a wiki entry under multiple tags and not just under one hierarchy. You can then search for wiki entries categorized under a tag or a collection of tags. In other words, tags provide a faceted classification system for the Trac wiki.
As an added bonus, tags are linked to the wiki entry of the same name, allowing you to describe them explicitly under the wiki entry of the same name. This allows for a flexible means for establishing the context of wiki entries. Besides this, tags also make it incredibly easy to create todo? lists or indexes?.
Tags don't have to be predefined. As long as there are wiki entries categorized under a tag, it'll be automatically created.
Tags are similar to labels in gmail, tags in the social bookmark manager del.icio.us and Flickr. They are substantially different from Wikipedia categories, because tags are associated with wiki entries of the same name, whereas WikiMedia Categories are just indexes.
This implementation of wiki tagging is specific to Trac. To stay consistent with the way Trac names wiki entries, tags are case sensitive. Trac Hacks itself makes extensive use of tagging and is a good example of their use.
How do I apply tags?
To create a tag, follow these steps:
- Go to the wiki entry you want to tag.
- Click on Edit This Page
- Under Change information, Tag under:, enter the tags you want to categorize the entry under. Separate tags with spaces.
- Click Save changes.
The wiki entry you edit is now categorized under the tags you specified.
How do I remove a tag from a wiki entry?
To remove a tag from a wiki entry
- Go to the wiki entry you want to untag.
- Click on Edit This Page
- Under Change information, Tag under:, remove the tag from the list.
- Click Save changes.
Using the tags
Querying is implemented through the /tags uri handler, the tag:<tag>
syntax or Trac Macros as follows
/tags handler
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.
tag:<tag>
or tagged:<expr>
Usage
Both forms are identical and link to the tag search results for the expression.
e.g. tagged:todo
or tagged:"plugin macro"
.
Tag expressions
Both the ListTagged
macro and the /tags
handler use a basic expression language for filtering tagged objects.
Space-separating terms logically AND
s them together.
Operators supported by the language are:
Operator | Function |
or | Logical or
|
not | Logical not
|
realm:<realm> | Restrict to tags in <realm> where realm is wiki , ticket , etc.
|
Sub-expressions can be grouped inside parentheses (
, )
.
Expressions and individual tags can be quoted with single '
or double "
quotes.
Examples
Intersection of macro
and plugin
tags:
tagged:"macro plugin"
Union of macro
and plugin
tags:
tagged:"macro or plugin"
Objects tagged macro
or plugin
, and example
tagged:"(macro or plugin) example"
Macro Usage
ListTagged
[[ListTagged(<expr>)]]
This will display a list of resources whose tags match <expr>
.
Examples
Intersection of macro
and plugin
tags:
[[ListTagged(macro plugin)]]
Pages tagged macro
but not plugin
:
[[ListTagged(macro -plugin)]]
TagCloud
[[TagCloud(-Dummy)]]
Display a cloud of all tags, assuming you do not use the Dummy tag.
Change Log
Author/Contributors
Attachments (2)
-
transifex_top-translations_tractags-0.7_chart.png (13.8 KB) - added by 10 years ago.
coverage of translations per language for v0.7
-
tags_example.png (69.7 KB) - added by 3 years ago.
Screenshot of tags from a wiki page
Download all attachments as: .zip