Changes between Version 79 and Version 80 of TagsPlugin


Ignore:
Timestamp:
Mar 25, 2015, 4:13:16 PM (9 years ago)
Author:
figaro
Comment:

Cosmetic changes, tagged with license

Legend:

Unmodified
Added
Removed
Modified

  • TagsPlugin

    v79 v80  
    1010}}}
    1111
    12 = A Tagging System for Trac =
     12= A Tagging System for Trac
    1313
    1414The TagsPlugin implements both a generic tagging engine, and front ends 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.
    … …  
    1818Have a look at [wiki:TagsPlugin/RelatedHacks some other hacks], that may fit well and complement your !TagsPlugin installation nicely.
    1919
    20 === What are tags? ===
    21 
    22 Tags allow you to organize wiki entries under multiple categories, 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.
    23 
    24 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.
    25 
    26 Tags don't have to be predefined.  As long as there are wiki entries categorized under a tag, it'll be automatically created.
    27 
    28 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 [http://meta.wikimedia.org/wiki/Categories WikiMedia Categories] are just indexes.
     20=== What are tags?
     21
     22Tags allow you to organize wiki entries under multiple categories, 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.
     23
     24As 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.
     25
     26Tags don't have to be predefined. As long as there are wiki entries categorized under a tag, it'll be automatically created.
     27
     28Tags are similar to labels in gmail, tags in the social bookmark manager del.icio.us and Flickr. They are substantially different from [http://meta.wikimedia.org/wiki/Categories Wikipedia categories], because tags are associated with wiki entries of the same name, whereas WikiMedia Categories are just indexes.
    2929
    3030This implementation of wiki tagging is specific to [wiki:TracGuide 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.
    3131
    32 == Usage ==
    33 
    34 === Apply tags ===
     32== Usage
     33
     34=== Create and Apply tags
    3535
    3636To create a tag, follow these steps:
    … …  
    4343The wiki entry you edit is now categorized under the tags you specified.
    4444
    45 Almost equivalent steps for tag entry at tickets, usually under `keywords` field.
    46 
    47 === Remove tags ===
     45The tagging process for tickets is similar, and can be found under the `keywords` field.
     46
     47=== Remove tags
    4848
    4949To remove a tag from a wiki entry, follow these steps:
    … …  
    5454 4. Click ''Save changes''.
    5555
    56 Almost equivalent steps for tag removing at tickets, usually under `keywords` field.
    57 
    58 === Searching tags ===
     56The tag removal process for tickets is similar, and can be found under the `keywords` field.
     57
     58=== Search tags
    5959
    6060Querying is implemented through the `/tags` uri handler, `the tag:<tag>` syntax or WikiMacros as follows.
    6161
    62 ==== Tags query ====
     62==== Tags query
    6363
    6464Both 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:
    … …  
    7878   1. Objects tagged `macro` or `plugin`, ''and'' `example`     `tagged:"(macro or plugin) example"`
    7979
    80 ==== /tags handler ====
     80==== /tags handler
    8181
    8282Going 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].
    8383
    84 ==== `tag:<tag>` or `tagged:<query>` ====
     84==== `tag:<tag>` or `tagged:<query>`
    8585
    8686Both forms are identical and link to the tag search results for the query.
    … …  
    8989  * `tagged:todo` or `tagged:"plugin macro"`.
    9090
    91 ==== !ListTagged macro ====
     91==== !ListTagged macro
    9292
    9393This will display a list of resources whose tags match `<query>`.
    … …  
    107107  * Pages tagged with `macro`:         `[[ListTagged(realm:wiki macro)]]`
    108108
    109 ==== !TagCloud macro ====
     109==== !TagCloud macro
    110110
    111111`[[TagCloud]]`
    … …  
    117117Optional query expressions including realm selection are supported as shown for `ListTagged`. Between v0.6 and v0.7 something like `[[TagCloud(-Dummy)]]` was strictly required as work-around, assuming you did not use the ''Dummy'' tag.
    118118
    119 == Install ==
     119== Installation
    120120
    121121Generic installation guidelines are troubleshooting can be found at TracPlugins.
    … …  
    130130            [/svn/tagsplugin/tags/0.7 the source] from SVN.
    131131         2. [trac:wiki:TracPlugins Build and install an egg] from this source.
    132       1. with easy_install:
     132      1. With `easy_install`:
    133133         {{{
    134134         #!sh
    … …  
    175175 1. '''Test''' 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''.
    176176
    177 === About i18n/l10n support ===
     177=== About i18n/l10n support
    178178
    179179Since 0.7 this plugin is prepared for localization.
    180180
    181181But English message texts are still the (POSIX) default. If this isn't your preferred language, you can
    182  1. look, if it's already available from the [TracPluginTranslation Trac plugin l10n project] at [http://www.transifex.net/projects/p/Trac_Plugin-L10N/c/tractags Transifex] or
    183  2. do it yourself (see the [http://trac.edgewall.org/wiki/CookBook/PluginL10N#Dotranslatorswork l10n cookbook page for Trac plugins] for more details).
     182 1. check if it's already available from the [TracPluginTranslation Trac plugin l10n project] at [http://www.transifex.net/projects/p/Trac_Plugin-L10N/c/tractags Transifex] or
     183 1. do it yourself (see the [http://trac.edgewall.org/wiki/CookBook/PluginL10N#Dotranslatorswork l10n cookbook page for Trac plugins] for more details).
    184184
    185185You've done a new translation? Superb! Contributing your translation is highly appreciated.
    … …  
    201201Again, for more details see the [t:wiki:CookBook/PluginL10N#Compileanduseit l10n cookbook page for Trac plugins].
    202202
    203 == Bugs & Feature Requests ==
    204 
    205 total issue record:
    206 [[TicketQuery(component=TagsPlugin,format=progress)]]
    207 open issues by type:
    208  [[TicketQuery(component=TagsPlugin,status!=closed&group=type,format=progress)]]
    209 
    210 Check [query:?status=new&status=assigned&status=reopened&group=&component=TagsPlugin&order=priority existing bugs and feature requests] first, please. If you have additional issues, you're welcome to ask at our mailing-list to confirm proper local install and configuration. Only create a [/newticket?component=TagsPlugin new ticket], if you're reasonably sure, that it will be a valid defect report or a generally useful enhancement. Thanks for taking care.
    211 
    212 == Source & Download ==
     203== Bugs/Feature Requests
     204
     205Existing bugs and feature requests for TagsPlugin are
     206[query:status!=closed&component=TagsPlugin here].
     207
     208If you have any issues, create a
     209[http://trac-hacks.org/newticket?component=TagsPlugin&owner=hasienda new ticket].
     210
     211[[TicketQuery(component=TagsPlugin&group=type,format=progress)]]
     212
     213== Source & Download
    213214
    214215You can check out !TagsPlugin from [http://trac-hacks.org/svn/tagsplugin here] using Subversion, or [source:tagsplugin browse the source] with Trac.
    … …  
    216217You can also download the zipped source from [download:tagsplugin here].
    217218
    218 === Most Recent Changes ===
     219== Recent Changes
    219220
    220221[[ChangeLog(/tagsplugin, 3)]]
    … …  
    222223[log:tagsplugin See more]
    223224
    224 == Author/Contributors ==
     225== Author/Contributors
    225226
    226227'''Author:''' athomas [[BR]]