Ignore:
Timestamp:
01/29/09 13:35:57 (3 years ago)
Author:
CrawfordCurrie
Message:

Item455: port to foswiki Item5974: correct CSS for search results table Item5938: load CSS for ACTIONSEARCH Item5606: Item5915: respect global settings for time format

Location:
trunk/ActionTrackerPlugin/data/System
Files:
1 edited
1 moved

Legend:

Unmodified
Added
Removed

  • trunk/ActionTrackerPlugin/data/System/ActionTrackerPlugin.txt

    r1340 r2226  
    1414It takes the skills of a juggler to keep track of all the demands that modern life makes on us. Wouldn't it be great if we could capture what we have to do _at the time we think of it_, and be able to get a to-do list on demand? No more fighting with post-it notes, no more forgetting actions from the minutes of obscure meetings, and remember your partners birthday every year into the bargain!  
    1515 
    16 This plugin provides support for tracking actions embedded in TWiki topics. Actions captured this way can then be tracked from anywhere you want. 
     16This plugin provides support for tracking actions embedded in topics. Actions captured this way can then be tracked from anywhere you want. 
    1717 
    1818This is particularly useful for [[http://en.wikipedia.org/wiki/Minutes][meeting minutes]]. As you write the minutes during the meeting, you simply enter the actions into the text and as soon as the topic is saved, the actions "go live". For example, at a recent meeting of the British Cabinet: 
    … …  
    2929Actions are nicely formatted for display, and automatic notification of actions is supported using 'cron'. 
    3030 
    31 <div class="twikiBroadcastMessage" style="background-color:#ffc;">WARNING: TWiki-4 only. If you want to use this plugin with an earlier version of TWiki, please use [[http://twiki.org/cgi-bin/attach/Plugins/ActionTrackerPlugin?filename=ActionTrackerPlugin.zip&revInfo=1][revision 22 of the zip]].</div> 
    32  
    3331%TOC% 
    3432 
    3533---+ Features 
    36         * Actions can be embedded in TWiki topics. 
     34        * Actions can be embedded in topics. 
    3735        * Actions can be listed using searches. 
    3836        * Automatic action state e-mail notification. 
    … …  
    4745__Note:__ if you have previously used this plugin you will note that the syntax of actions has changed. The plugin still recognises the old syntax, and will automatically upgrade topics when you edit them. 
    4846 
    49 Write the command =%<nop>ACTION{= _attributes_ =}% ...  %<nop>ENDACTION%= anywhere in a TWiki topic, where =...= represents the action description. Standard attributes are 
     47Write the command =%<nop>ACTION{= _attributes_ =}% ...  %<nop>ENDACTION%= anywhere in a topic, where =...= represents the action description. Standard attributes are 
    5048        | *Name* | *Value* | *Description* | *Auto-completed* | 
    5149        | =who= | See [[#PeopleAnchor][People]] | The person or team responsible for completing the action. | current user | 
    … …  
    7674---++ Action searches 
    7775 
    78 Write the command =%<nop>ACTIONSEARCH{= _attributes_ =}%= anywhere in a TWiki topic. Standard attributes are 
     76Write the command =%<nop>ACTIONSEARCH{= _attributes_ =}%= anywhere in a topic. Standard attributes are 
    7977        | *Name* | *Value* | *Description* | 
    8078        | =who= | See [[#PeopleAnchor][People]] | Person responsible for closing the action. | 
    … …  
    160158E-mail addresses of people are found by the process [[#TranslatingNamesToEmailAddresses][described below]]. 
    161159 
    162 You can also use the shorthand =me= for the currently logged-in user (this is =TWiki<nop>Guest= unless you have been prompted for a username and password). In actions, this will automatically be expanded when the topic is saved, and in searches it will match the currently logged in user.  
     160You can also use the shorthand =me= for the currently logged-in user (this is the guest user unless you have been prompted for a username and password). In actions, this will automatically be expanded when the topic is saved, and in searches it will match the currently logged in user.  
    163161 
    164162---++++ Groups 
    165163 
    166 You can assign an action to a group defined using a TWiki group topic (see %SYSTEMWEB%.CompleteDocumentation). Alternatively you can give a list of people as the value of the attribute. For example, 
     164You can assign an action to a group. Alternatively you can give a list of people as the value of the attribute. For example, 
    167165<pre> 
    168166%ACTION<nop>{who=AdminGroup ...}% 
    … …  
    176174---+++ UIDs 
    177175_For administrators only_: 
    178 Each action is assigned a Unique Identifier (UID) when it is created. This UID is a six-digit number, and is generated when the action is first saved by incrementing a number in a special file (<code>pub/_work_areas/ActionTrackerPlugin/UIDRegister</code> under the TWiki installation). If this file is accidentally deleted, or is not writable, then you will have problems and you may get duplicate UIDs. Normally this won't matter a hoot, as UIDs only _have_ to be unique within a single topic, but if the file is persistantly inaccessible it could be a bit of a nuisance. 
     176Each action is assigned a Unique Identifier (UID) when it is created. This UID is a six-digit number, and is generated when the action is first saved by incrementing a number in a special file (<code>pub/_work_areas/ActionTrackerPlugin/UIDRegister</code> under the installation). If this file is accidentally deleted, or is not writable, then you will have problems and you may get duplicate UIDs. Normally this won't matter a hoot, as UIDs only _have_ to be unique within a single topic, but if the file is persistantly inaccessible it could be a bit of a nuisance. 
    179177 
    180178#NotiFication 
    … …  
    190188For example: 
    191189<pre> actionnotify "header=\"| Assigned to | Due ||\"" format=\"'| $who | $due | $edit |'\" state="open" </pre> 
    192 Note that the =actionnotify= script must be run from the =bin= directory. This is so it can pick up the TWiki path configuration file, =setlib.cfg=. 
     190Note that the =actionnotify= script must be run from the =bin= directory. This is so it can pick up the path configuration file, =setlib.cfg=. 
    193191 
    194192For example, you could set up the cron jobs as follows: 
    … …  
    339337        * Set SHORTDESCRIPTION = Adds support for action tags in topics, and automatic notification of action statuses 
    340338--> 
    341 You can override the defaults for these values in %USERSWEB%.<nop>SitePreferences, the Web<nop>Preferences topic of the current web, or in individual topics. Use the standard TWiki 'Set' syntax e.g: 
     339You can override the defaults for these values in %USERSWEB%.<nop>SitePreferences, the Web<nop>Preferences topic of the current web, or in individual topics. Use the standard 'Set' syntax e.g: 
    342340<pre> 
    343341   *<nop> Set ACTIONTRACKERPLUGIN_EDITORIENT = rows 
    … …  
    400398---+ Plugin Info 
    401399 
    402 Another great TWiki extension from the <a style="text-decoration:none" href="http://wikiring.com"><img src="%ATTACHURLPATH%/wikiringlogo20x20.png" alt="" /> *WikiRing* </a> - __Working together to improve your wiki experience__! 
     400Another great Foswiki extension from the <a style="text-decoration:none" href="http://wikiring.com"><img src="%ATTACHURLPATH%/wikiringlogo20x20.png" alt="" /> *WikiRing* </a> - __Working together to improve your wiki experience__! 
    403401 
    404402Thanks are due to the following sponsors, who have helped make this plugin possible: 
    … …  
    409407|  Author: | [[http://c-dot.co.uk][CrawfordCurrie]] | 
    410408|  Version: | %$VERSION% | 
    411 |  Copyright | Copyright &copy; 2002-2003 Motorola. All Rights Reserved.%BR% Copyright &copy; 2004-2008 Crawford Currie | 
     409|  Copyright | Copyright &copy; 2002-2003 Motorola. All Rights Reserved.%BR% Copyright &copy; 2004-2009 Crawford Currie | 
    412410|  License: | GPL ([[http://www.gnu.org/copyleft/gpl.html][GNU General Public License]]) | 
    413411|  Change History: | | 
    414 |  5 Dec 2008 | | 
     412|  29 Jan 2009 | Foswikitask:Item455: port to foswiki Foswikitask:Item5974: correct CSS for search results table Foswikitask:Item5938: load CSS for ACTIONSEARCH Foswikitask:Item5606: Foswikitask:Item5915: respect global settings for time format | 
    415413|  7 May 2008 | TWikibug:Item5607: http: was being doubled up on URLs in mail due to a core bug | 
    416414|  13 Apr 2008 | TWikibug:Item4649: merged TWiki:Main.JoaquinBuendia's fix for AJAX updates on IE. TWikibug:Item4760: fixed WYSIWYG editing of topics containing actions TWikibug:Item5531: added simple button option for state changes | 
Note: See TracChangeset for help on using the changeset viewer.