Changes between Version 9 and Version 10 of TracKeywordsPlugin


Ignore:
Timestamp:
May 14, 2011 3:51:25 PM (3 years ago)
Author:
AdrianFritz
Comment:

Add usage section, maintainer tag (current: rjollos), known issues.

Legend:

Unmodified
Added
Removed
Modified
  • TracKeywordsPlugin

    v9 v10  
    66This plug-in allows you to add entries to the Keywords entry field from a configured list of keywords by clicking on them. 
    77 
    8 See also KeywordSuggestPlugin. 
     8Allows to define a tip for every keyword, which is shown when you cross over the mouse on the keyword from "Add keywords" section. 
     9 
     10== Usage == 
     11 
     12From the "Add keywords" section, click once on any of the keywords you want to be inserted on (your specified) "Keywords" field. To remove click again on it. 
     13 
     14You can also continue to add manually other keywords weren't listed. 
     15 
     16[[Image(TracKeywordsPlugin-atTicket.png)]] 
    917 
    1018== Bugs/Feature Requests ==  
     
    1624[http://trac-hacks.org/newticket?component=TracKeywordsPlugin&owner=thomasvs new ticket]. 
    1725 
    18 == Download == 
    19  
    20 Download the zipped source from [download:trackeywordsplugin here]. 
    21  
    22 == Source == 
    23  
    24 You can check out TracKeywordsPlugin from [http://trac-hacks.org/svn/trackeywordsplugin here] using Subversion, or [source:trackeywordsplugin browse the source] with Trac. 
    25  
    2626== Install/Configuration == 
    2727  
    2828  1. Proceed with normal installation of plugins. 
    29   1. Update the ticket template page to include this plugin page section `keywords.html`.[[BR]] 
    30       * You can do this by including the following line somewhere in the ''html'' code: 
     29  1. Update the ticket template page to include this plugin page section ("Add keywords").[[BR]] 
     30      * You can do this by including the following line somewhere in the `keywords.html` file: 
    3131{{{ 
    3232<xi:include href="keywords.html" /> 
    3333}}}  
    34           * Suggested place: right before `</body>`.  
    35       * Trac 0.12 files: 
    36           * `<trac_egg>/trac/ticket/templates/ticket.html` 
    37           * `<trac_egg>/trac/wiki/templates/wiki_edit.html` (For a slight integration with TagsPlugin, see #8799) 
    38       * Trac 0.10 `ticket.cs` file: 
     34          * Suggested place: right before `</body>` tag.  
     35          * Where to locate files @ Trac 0.12: 
     36            * `<trac_egg>/trac/ticket/templates/ticket.html` 
     37            * `<trac_egg>/trac/wiki/templates/wiki_edit.html` (For a slight integration with TagsPlugin, see #8799) 
     38          * Trac 0.10 `ticket.cs` file: 
    3939{{{ 
    4040... 
     
    4343<?cs include "keywords.cs" ?> 
    4444 
    45  <?cs if:ticket.actions.accept || ticket.actions.reopen || 
    46          ticket.actions.resolve || ticket.actions.reassign ?> 
     45<?cs if:ticket.actions.accept || ticket.actions.reopen || 
     46        ticket.actions.resolve || ticket.actions.reassign ?> 
    4747... 
    4848}}} 
    49   1. In `trac.ini` file, set up the keywords like: 
     49  1. '''Configure''' `trac.ini` file, with you required keywords: 
     50     * Format `<name> = <description>`, where description will shown as a tip. 
     51     * Example: 
    5052{{{ 
    5153[keywords] 
     
    5456backport = ask for a decision on whether to backport 
    5557}}} 
    56      * The format is `name = description` 
     58  1. '''Restart''' web server: 
     59{{{ 
     60#!sh 
     61$ sudo /etc/init.d/apache2 restart 
     62}}} 
    5763 
    58 == Recent Changes == 
     64== Source & Download == 
     65 
     66You can check out TracKeywordsPlugin from [http://trac-hacks.org/svn/trackeywordsplugin here] using Subversion, or [source:trackeywordsplugin browse the source] with Trac. 
     67 
     68Download the zipped source from [download:trackeywordsplugin here]. 
     69 
     70=== Recent Changes === 
    5971 
    6072[[ChangeLog(trackeywordsplugin, 3)]] 
     
    6375 
    6476'''Author:''' [wiki:thomasvs] [[BR]] 
    65 '''Maintainer:''' [wiki:thomasvs] [[BR]] 
     77'''Maintainer:''' [wiki:rjollos] [[BR]] 
    6678'''Contributors:''' rea 
     79 
     80== See also == 
     81 
     82 KeywordSuggestPlugin.