Changes between Version 52 and Version 53 of TagsPlugin


Ignore:
Timestamp:
Nov 29, 2011, 11:35:22 AM (3 years ago)
Author:
AdrianFritz
Comment:

Standarize use of <query> instead of <expression> as is more common in the sense they are used. Other cosmetic changes.

Legend:

Unmodified
Added
Removed
Modified
  • TagsPlugin

    v52 v53  
    4141The wiki entry you edit is now categorized under the tags you specified.
    4242
     43Almost equivalent steps for tag entry at tickets, usually under `keywords` field.
     44
    4345=== Remove tags ===
    4446
     
    4951 4. Click ''Save changes''.
    5052
     53Almost equivalent steps for tag removing at tickets, usually under `keywords` field.
     54
    5155=== Searching tags ===
    5256
    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 ====
    56 
    57 Both the `ListTagged` macro and the `/tags` handler use a basic expression language for filtering tagged objects.
    58 
    59 Space-separating terms logically `AND`s them together.
    60 
    61 Operators supported by the language are:
     57Querying is implemented through the `/tags` uri handler, `the tag:<tag>` syntax or [http://projects.edgewall.com/trac/wiki/WikiMacros Trac Macros] as follows.
     58
     59==== Tags query ====
     60
     61Both the `ListTagged` macro and the `/tags` handler use a basic query language for filtering tagged objects. Query contains the terms to filter, can have some logical operators and have restrictions for where to search:
     62
     63 1. Space-separated terms logically `AND`s them together.
     64 2. Operators supported by the query language are:
    6265||'''Operator'''||'''Function'''||
    6366||`or`||Logical `or`||
    6467||`not`||Logical `not`||
    6568||`realm:<realm>`||Restrict to tags in `<realm>` where realm is `wiki`, `ticket`, etc.||
    66 
    67 Sub-expressions can be grouped inside parentheses `(`, `)`.
    68 
    69 Expressions and individual tags can be quoted with single `'` or double `"` quotes.
     69 3. Sub-expressions can be grouped inside parentheses `(`, `)`.
     70 4. Expressions and individual tags can be quoted with single `'` or double `"` quotes. (check #3624)
    7071
    7172 Examples::
     
    7677==== /tags handler ====
    7778
    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.
     79Going 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].
     80
     81==== `tag:<tag>` or `tagged:<query>` Usage ====
     82
     83Both forms are identical and link to the tag search results for the query.
    8384
    8485 Example::
     
    8788==== !ListTagged macro ====
    8889
    89 `[[ListTagged(<expression>)]]`
    90 
    91 This will display a list of resources whose tags match `<expression>`.
     90`[[ListTagged(<query>)]]`
     91
     92This will display a list of resources whose tags match `<query>`.
    9293
    9394 Examples::
     
    119120         2. [trac:wiki:TracPlugins Build and install an egg] from this source.
    120121      1. with easy_install:
    121 {{{
    122 #!sh
    123 $ sudo easy_install https://trac-hacks.org/svn/tagsplugin/tags/0.6
    124 }}}
     122         {{{
     123         #!sh
     124         $ sudo easy_install https://trac-hacks.org/svn/tagsplugin/tags/0.6
     125         }}}
    125126 1. '''Configure'''
     127    * '''Note''':: older !TagsPlugin configuration '''must be removed'''. In  particular `trac.wiki.web_ui.wikimodule = disabled` and `default_handler = TagsWikiModule`.
    126128    * 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:
    127129      1. `ignore_closed_tickets = <bool>`
     
    130132          * eg. `ticket_fields = component, keywords`.
    131133          * 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'''.
    133134 1. '''Enable'''
    134135    * Update your TracIni file (`..../trac.ini`) with: