Changes between Version 11 and Version 12 of TagsPlugin


Ignore:
Timestamp:
Nov 11, 2006, 11:10:13 AM (17 years ago)
Author:
Christian Aust
Comment:

Copied from Google's cache before it gets lost

Legend:

Unmodified
Added
Removed
Modified

  • TagsPlugin

    v11 v12  
    66
    77== Obtaining and Installing ==
     8Follow the [wiki:TagsPlugin/Installation installation instructions].
    89
     10== What are tags? ==
     11Tags 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 [http://en.wikipedia.org/wiki/Faceted_classification faceted classification system] for the Trac wiki.
    912
     13As 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 [wiki:todo todo] lists or [wiki:Index indexes].
    1014
    11 Follow the [http://72.14.235.104/search?q=cache:VxRCluBnv6IJ:muness.textdriven.com/trac/wiki/tags/Setup+trac+tags+installation&hl=en&lr=&strip=1 installation instructions].
     15Tags don't have to be predefined.  As long as there are wiki entries categorized under a tag, it'll be automatically created.
    1216
    13 Note that this is Google's cache of the original Wiki page, as Muness' Trac installation has been decommissioned. For now, use the SVN installation method.
     17Tags 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 [http://meta.wikimedia.org/wiki/Categories WikiMedia Categories] are just indexes.
     18
     19This implementation of wiki tagging is specific to [wiki:TracGuide Trac]. To stay consistent with the way Trac names wiki entries, tags are case sensitive.
     20
     21Also see the idea's [wiki:tags/Background background] and [wiki:tags/Improvements improvements] being implemented/considered.
     22
     23Don't forget to check out the [wiki:tags/Examples examples] of tags in action.  The excellent [http://trac-hacks.org/ Trac Hacks] makes extensive use of tagging and is a good example of their use.  Also, see http://lists.edgewall.com/archive/trac/2006-April/007646.html for an example of how Alec uses !ListTagged to query tickets.
     24
     25=== How do I apply tags? ===
     26To create a tag, follow these steps:
     27
     28 1. Go to the wiki entry you want to tag.
     29 2. Click on ''Edit This Page''
     30 3. Under ''Change information'', ''Tag under:'', enter the tags you want to categorize the entry under.  Separate the tags by commas.  Note that white spaces are currently not supported and will be replaced by commas.
     31 4. Click ''Save changes''.
     32
     33The wiki entry you edit is now categorized under the tags you specified.
     34
     35=== How do I remove a tag from a wiki entry? ===
     36
     37To remove a tag from a wiki entry
     38 1. Go to the wiki entry you want to ''untag''.
     39 2. Click on ''Edit This Page''
     40 3. Under ''Change information'', ''Tag under:'', remove the tag from the list.
     41 4. Click ''Save changes''.
     42
     43== Using the tags ==
     44Querying is implemented through the /tags uri handler, `the tag:<tag>` syntax or [http://projects.edgewall.com/trac/wiki/WikiMacros Trac Macros] as follows
     45
     46=== /tags handler ===
     47Going to /tags under your project will show a list of all tags in the wiki.  /tags/<tag> will show all the objects tagged ''<tag>''.  e.g. [http://muness.textdriven.com/trac/tags/Java,Examples].  This accepts all the parameters that the !ListTagged macro does.  e.g. [http://muness.textdriven.com/trac/tags/Java,Examples?operation=union&amp;amp;showheadings=true].
     48
     49== `tagged:<tag>` Usage ==
     50Using `tagged:<tag>` will link to the wiki <tag>.  If that doesn't exist, it will instead link to a listing of all the objects tagged <tag>.
     51
     52e.g. tagged:todo or tagged:Java,Examples .  This syntax accepts all the options that the !ListTagged macro does.  e.g. tagged:Java,Examples?operation=union .
     53
     54== Tag expressions ==
     55
     56Both the `ListTagged` macro and the `/tags` handler use a basic expression language for filtering tagged objects.
     57
     58Operators supported by the language are:
     59||'''Operator'''||'''Function'''||
     60||`+` or `,`||Logical `and`||
     61||`-`||Logical `and not`
     62||unary `-`||Not||
     63||`|`||Logical `or`||
     64
     65Sub-expressions can be grouped inside parentheses `(`, `)`.
     66
     67Tags can be quoted with single `'` or double `''` quotes, in case they contain characters that are operators.
     68
     69=== Examples ===
     70
     71Intersection of `Java` and `Examples` tags:
     72        tagged:Java+Examples
     73
     74Union of `Java` and `Examples` tags:
     75        tagged:Java|Examples
     76
     77Objects tagged `Java` or `Python`, ''and'' `Examples`
     78        tagged:(Java|Python)+Examples
     79
     80== Macro Usage ==
     81=== !ListTagged ===
     82[[MacroList(ListTagged)]]
     83
     84=== !ListTags ===
     85[[MacroList(ListTags)]]
     86
     87=== !TagCloud ===
     88[[MacroList(TagCloud)]]
     89
     90Note that the macro argument defaults can be customized site-wide.  See the [wiki:TagsPlugin/Installation installation instructions] for details.