Changes between Version 9 and Version 10 of TracKeywordsPlugin

Timestamp:

May 14, 2011, 1:51:25 PM (13 years ago)

Author:

Adrian Fritz

Comment:

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

TracKeywordsPlugin

@@ -6 +6 @@
 This plug-in allows you to add entries to the Keywords entry field from a configured list of keywords by clicking on them.
 
-See also KeywordSuggestPlugin.
+Allows to define a tip for every keyword, which is shown when you cross over the mouse on the keyword from "Add keywords" section.
+
+== Usage ==
+
+From 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.
+
+You can also continue to add manually other keywords weren't listed.
+
+[[Image(TracKeywordsPlugin-atTicket.png)]]
 
 == Bugs/Feature Requests == 
@@ -16 +24 @@
 [http://trac-hacks.org/newticket?component=TracKeywordsPlugin&owner=thomasvs new ticket].
 
-== Download ==
-
-Download the zipped source from [download:trackeywordsplugin here].
-
-== Source ==
-
-You can check out TracKeywordsPlugin from [http://trac-hacks.org/svn/trackeywordsplugin here] using Subversion, or [source:trackeywordsplugin browse the source] with Trac.
-
 == Install/Configuration ==
  
   1. Proceed with normal installation of plugins.
-  1. Update the ticket template page to include this plugin page section `keywords.html`.[[BR]]
-      * You can do this by including the following line somewhere in the ''html'' code:
+  1. Update the ticket template page to include this plugin page section ("Add keywords").[[BR]]
+      * You can do this by including the following line somewhere in the `keywords.html` file:
 {{{
 <xi:include href="keywords.html" />
 }}} 
-          * Suggested place: right before `</body>`. 
-      * Trac 0.12 files:
-          * `<trac_egg>/trac/ticket/templates/ticket.html`
-          * `<trac_egg>/trac/wiki/templates/wiki_edit.html` (For a slight integration with TagsPlugin, see #8799)
-      * Trac 0.10 `ticket.cs` file:
+          * Suggested place: right before `</body>` tag. 
+          * Where to locate files @ Trac 0.12:
+            * `<trac_egg>/trac/ticket/templates/ticket.html`
+            * `<trac_egg>/trac/wiki/templates/wiki_edit.html` (For a slight integration with TagsPlugin, see #8799)
+          * Trac 0.10 `ticket.cs` file:
 {{{
 ...
@@ -43 +43 @@
 <?cs include "keywords.cs" ?>
 
- <?cs if:ticket.actions.accept || ticket.actions.reopen ||
-         ticket.actions.resolve || ticket.actions.reassign ?>
+<?cs if:ticket.actions.accept || ticket.actions.reopen ||
+        ticket.actions.resolve || ticket.actions.reassign ?>
 ...
 }}}
-  1. In `trac.ini` file, set up the keywords like:
+  1. '''Configure''' `trac.ini` file, with you required keywords:
+     * Format `<name> = <description>`, where description will shown as a tip.
+     * Example:
 {{{
 [keywords]
@@ -54 +56 @@
 backport = ask for a decision on whether to backport
 }}}
-     * The format is `name = description`
+  1. '''Restart''' web server:
+{{{
+#!sh
+$ sudo /etc/init.d/apache2 restart
+}}}
 
-== Recent Changes ==
+== Source & Download ==
+
+You can check out TracKeywordsPlugin from [http://trac-hacks.org/svn/trackeywordsplugin here] using Subversion, or [source:trackeywordsplugin browse the source] with Trac.
+
+Download the zipped source from [download:trackeywordsplugin here].
+
+=== Recent Changes ===
 
 [[ChangeLog(trackeywordsplugin, 3)]]
@@ -63 +75 @@
 
 '''Author:''' [wiki:thomasvs] [[BR]]
-'''Maintainer:''' [wiki:thomasvs] [[BR]]
+'''Maintainer:''' [wiki:rjollos] [[BR]]
 '''Contributors:''' rea
+
+== See also ==
+
+ KeywordSuggestPlugin.