Changes between Version 18 and Version 19 of TagsPlugin


Ignore:
Timestamp:
Jan 20, 2008, 2:51:12 AM (9 years ago)
Author:
athomas
Comment:

Updated docs for 0.6.

Legend:

Unmodified
Added
Removed
Modified
  • TagsPlugin

    v18 v19  
    55The 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.
    66
    7 The TagsPlugin was created by [wiki:muness Muness Alrubaie], with contributions from [wiki:athomas Alec Thomas].
     7The TagsPlugin was originally created by [wiki:muness Muness Alrubaie] but has since been completely rewritten by [wiki:athomas Alec Thomas].
    88
    99== Bugs/Feature Requests ==
     
    4747
    4848== Using the tags ==
     49
    4950Querying is implemented through the /tags uri handler, `the tag:<tag>` syntax or [http://projects.edgewall.com/trac/wiki/WikiMacros Trac Macros] as follows
    5051
    5152=== /tags handler ===
    52 Going 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].
    5353
    54 == `tagged:<tag>` Usage ==
    55 Using `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>.
     54Going 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].
    5655
    57 e.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 .
     56
     57
     58== `tag:<tag>` or `tagged:<expr>` Usage ==
     59
     60Both forms are identical and will link to a Wiki page. If that doesn't exist, it will instead link to a listing of all the objects tagged <tag>.
     61
     62e.g. `tagged:todo` or `tagged:"plugin macro"`.
    5863
    5964== Tag expressions ==
     
    6166Both the `ListTagged` macro and the `/tags` handler use a basic expression language for filtering tagged objects.
    6267
     68Space-separating terms logically `AND`s them together.
     69
    6370Operators supported by the language are:
    6471||'''Operator'''||'''Function'''||
    65 ||`+` or `,`||Logical `and`||
    66 ||`-`||Logical `and not`
    67 ||unary `-`||Not||
    68 ||`|`||Logical `or`||
     72||`or`||Logical `or`||
     73||`not`||Logical `not`||
     74||`realm:<realm>`||Restrict to tags in `<realm>` where realm is `wiki`, `ticket`, etc.||
    6975
    7076Sub-expressions can be grouped inside parentheses `(`, `)`.
    7177
    72 Tags can be quoted with single `'` or double `''` quotes, in case they contain characters that are operators.
     78Expressions and individual tags can be quoted with single `'` or double `"` quotes.
    7379
    7480=== Examples ===
    7581
    76 Intersection of `Java` and `Examples` tags:
    77         tagged:Java+Examples
     82Intersection of `macro` and `plugin` tags:
     83        `tagged:"macro plugin"`
    7884
    79 Union of `Java` and `Examples` tags:
    80         tagged:Java|Examples
     85Union of `macro` and `plugin` tags:
     86        `tagged:"macro or plugin"`
    8187
    82 Objects tagged `Java` or `Python`, ''and'' `Examples`
    83         tagged:(Java|Python)+Examples
     88Objects tagged `macro` or `plugin`, ''and'' `example`
     89        `tagged:"(macro or plugin) example"`
    8490
    8591== Macro Usage ==
     92
    8693=== !ListTagged ===
    87 [[MacroList(ListTagged)]]
    8894
    89 === !ListTags ===
    90 [[MacroList(ListTags)]]
     95`[[ListTagged(<expr>)]]`
    9196
    92 === !TagCloud ===
    93 [[MacroList(TagCloud)]]
    94 
    95 Note that the macro argument defaults can be customized site-wide.  See the [wiki:TagsPlugin/Installation installation instructions] and [wiki:TagsPlugin/TagCloud examples] for details.
     97This will display a list of resources whose tags match `<expr>`.