Changeset 2227

Timestamp:

01/29/09 15:09:14 (3 years ago)

Author:

CrawfordCurrie

Message:

Item4312: support for header, footer etc. Item412: added =reverse= sort for searches

Location:

trunk/ActionTrackerPlugin

Files:

• data/System/ActionTrackerPlugin.txt (modified) (5 diffs)
• lib/Foswiki/Plugins/ActionTrackerPlugin.pm (modified) (4 diffs)
• lib/Foswiki/Plugins/ActionTrackerPlugin/ActionSet.pm (modified) (3 diffs)
• lib/Foswiki/Plugins/ActionTrackerPlugin/Format.pm (modified) (5 diffs)
• lib/Foswiki/Plugins/ActionTrackerPlugin/MANIFEST (modified) (1 diff)
• pub/System/ActionTrackerPlugin/juggle.gif (deleted)
• pub/System/ActionTrackerPlugin/logo.png (added)
• test/unit/ActionTrackerPlugin/ActionTests.pm (modified) (1 diff)

trunk/ActionTrackerPlugin/data/System/ActionTrackerPlugin.txt

@@ -10 +10 @@
 -->
 <div style="float:right">
-<a href="http://wikiring.com"><img src="%ATTACHURLPATH%/juggle.gif" title="WikiRing: Professional Wiki Innovation and Support" /></a>
+<a href="http://wikiring.com"><img src="%ATTACHURLPATH%/logo.png" title="WikiRing: Professional Wiki Innovation and Support" /></a>
 </div>
-It 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! 
-
-This plugin provides support for tracking actions embedded in topics. Actions captured this way can then be tracked from anywhere you want.
-
-This 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:
+This plugin provides support for tracking actions embedded in topics. Actions captured this way can then be searched from any topic in the wiki.
+
+---+ Features
+   * Actions are be embedded in topics.
+   * List actions using searches.
+   * Automatic e-mail notification of changes.
+   * Assign actions to individuals, or to predefined groups.
+   * Pop-up action editor.
+   * Fully configurable - add your own action attributes.
+
+This plugin 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:
 <verbatim>
 GordonBrown agreed to a zero tax rate for all self-employed software engineers, to make up for past unfair treatment.
@@ -29 +36 @@
 Actions are nicely formatted for display, and automatic notification of actions is supported using 'cron'.
 
+Actions are _embedded into topics_ so you can easily edit them, and even process them with other tools. No separate database to worry about!
+
 %TOC%
-
----+ Features
-        * Actions can be embedded in  topics.
-        * Actions can be listed using searches.
-        * Automatic action state e-mail notification.
-        * Actions can be assigned to individuals, or to predefined groups.
-        * Fully configurable.
 
 ---
@@ -342 +344 @@
 </pre>
 ---++ Formatting how actions are displayed
-The format of an action output. The following fields can be output: =web=, =topic=, =text=, =who=, =due=, =notify=, =uid=, =creator=, =state=, =edit=, and any =ACTIONTRACKERPLUGIN_EXTRAS= you may have. These settings can be overridden in an =ACTIONSEARCH= command using the =format= and =header= attributes. =TABLEHEADER= defines the column headings, =TABLEFORMAT= defines the contents of the columns, and if =TABLEORIENT= is set to =rows=, action tables will be aligned as rows of values instead of the default columns of values.
+The default format of an action output, unless overridden by =format=, =header= etc. The following fields can be output: =web=, =topic=, =text=, =who=, =due=, =notify=, =uid=, =creator=, =state=, =edit=, and any =ACTIONTRACKERPLUGIN_EXTRAS= you may have. =TABLEHEADER= defines the column headings, =TABLEFORMAT= defines the contents of the columns, and if =TABLEORIENT= is set to =rows=, action tables will be aligned as rows of values instead of the default columns of values.
    * ACTIONTRACKERPLUGIN_TABLEHEADER =| Assigned to | Due date | Description | State | Notify ||=
    * ACTIONTRACKERPLUGIN_TABLEFORMAT =| $who | $due | $text $link | $state | $notify | $edit |=
@@ -410 +412 @@
 |  License: | GPL ([[http://www.gnu.org/copyleft/gpl.html][GNU General Public License]]) |
 |  Change History: | |
-|  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 |
+|  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 Foswikitask:Item4312: support for header, footer etc. Foswikitask:Item412: added =reverse= |
 |  7 May 2008 | TWikibug:Item5607: http: was being doubled up on URLs in mail due to a core bug |
 |  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 |
@@ -450 +452 @@
 
 %META:FILEATTACHMENT{name="styles.css" attr="" comment="Stylesheet for actions"}%
-%META:FILEATTACHMENT{name="juggle.gif" attr="h" comment="Logo"}%
+%META:FILEATTACHMENT{name="logo.png" attr="h" comment="Logo"}%
 %META:FILEATTACHMENT{name="wikiringlogo20x20.png" attr="h" comment="" version="1"}%

trunk/ActionTrackerPlugin/lib/Foswiki/Plugins/ActionTrackerPlugin.pm

@@ -132 +132 @@
 
     if( Foswiki::Func::getSkin() =~ /\baction\b/ ) {
-print STDERR "Action edit\n";
         return _beforeActionEdit(@_);
     } else {
-print STDERR "Noamrl edit\n";
         return _beforeNormalEdit(@_);
     }
@@ -411 +409 @@
     my $orient = $attrs->remove( 'orient' );
     my $sort = $attrs->remove( 'sort' );
+    my $reverse = $attrs->remove( 'reverse' );
     if ( defined( $fmts ) || defined( $hdrs ) || defined( $orient )) {
         $fmts = $defaultFormat->getFields() unless ( defined( $fmts ));
@@ -421 +420 @@
 
     my $actions = Foswiki::Plugins::ActionTrackerPlugin::ActionSet::allActionsInWebs( $web, $attrs, 0 );
-    $actions->sort( $sort );
+    $actions->sort( $sort, $reverse );
     return $actions->formatAsHTML( $fmt, 'href', $options->{USENEWWINDOW},
                                    'atpSearch' );
@@ -440 +439 @@
     };
     if ($@) {
+        print STDERR "ActionTrackerPlugin: init failed $@\n";
         Foswiki::Func::writeWarning("ActionTrackerPlugin: init failed $@");
         return 0;

trunk/ActionTrackerPlugin/lib/Foswiki/Plugins/ActionTrackerPlugin/ActionSet.pm

@@ -89 +89 @@
 # of attributes by string value
 sub sort {
-    my ( $this, $order ) = @_;
+    my ( $this, $order, $reverse ) = @_;
+    my @ordered;
     if ( defined( $order ) ) {
         $order =~ s/[^\w,]//g;
         @_sortfields = split( /,\s*/, $order );
-        @{$this->{ACTIONS}} = sort {
+        @ordered = sort {
             foreach my $sf ( @_sortfields ) {
                 return -1 unless ref($a);
@@ -115 +116 @@
         } @{$this->{ACTIONS}};
     } else {
-        @{$this->{ACTIONS}} =
+        @ordered =
           sort {
               my $x = $a->secsToGo();
@@ -121 +122 @@
               return $x <=> $y;
           } @{$this->{ACTIONS}};
+    }
+    if (Foswiki::Func::isTrue($reverse)) {
+        @{$this->{ACTIONS}} = reverse @ordered;
+    } else {
+        @{$this->{ACTIONS}} = @ordered;
     }
 }

trunk/ActionTrackerPlugin/lib/Foswiki/Plugins/ActionTrackerPlugin/Format.pm

@@ -145 +145 @@
     my $args = shift;
     my $asHTML = shift;
-    if ( defined( &{ref( $object ) . "::_formatField_$vbl"} ) ) {
+    my $fn = "_formatField_$vbl";
+    if ( $object->can($fn) ) {
         # special format for this field
-        my $fn = "_formatField_$vbl";
         return $object->$fn( $args, $asHTML, @_ );
     }
@@ -153 +153 @@
     if( $type ) {
         my $typename = $type->{type};
-        if ( defined( &{ref( $object ) . "::_formatType_$typename"} ) ) {
+        $fn = "_formatType_$typename";
+        if ( $object->can($fn) ) {
             # special format for this type
-            my $fn = "_formatType_$typename";
             return $object->$fn( $vbl, $args, $asHTML, @_ );
         }
@@ -169 +169 @@
         return '';
     }
-}
-
-# PRIVATE STATIC fill in variable expansions in simple text form
-sub _expandString {
-    my $object = shift;
-    my $var = shift;
-    my $args = shift;
-
-    if ( $var eq "dollar") {
-        return "\$";
-    } elsif ($var eq "nop") {
-        return "";
-    } elsif ($var eq "n") {
-        return "\n";
-    } elsif ($var eq "percnt") {
-        return "%";
-    } elsif ($var eq "quot") {
-        return "\"";
-    }
-    my $t = _expandVar( $object, $var, $args, @_ );
-    return $t;
-}
-
-# PUBLIC fill in the text template using values
-# extracted from the given object
-sub _formatAsString {
-    my $this = shift;
-    my $object = shift;
-
-    my $fmt = $this->{TEXTFORM} || '';
-    $fmt =~ s/\$(\w+\b)(?:\((.*?)\))?/
-      _expandString( $object, $1, $2, 0, @_ )/geos;
-
-    return $fmt;
-}
-
-# PRIVATE STATIC fill in variable expansions. If any of the expansions
-# returns a non-zero color, then fill in the passed-by-reference color
-# variable $col with the value returned.
-sub _expandHTML {
-    my $object = shift;
-    my $var = shift;
-    my $args = shift;
-
-    if ( $var eq "dollar") {
-        return "\$";
-    } elsif ($var eq "nop") {
-        return "";
-    } elsif ($var eq "n") {
-        return CGI::br();
-    } elsif ($var eq "percnt") {
-        return "%";
-    } elsif ($var eq "quot") {
-        return "\"";
-    }
-
-    my $t = _expandVar( $object, $var, $args, @_ );
-
-    return $t;
 }
 
@@ -249 +190 @@
             my $c;
             my $entry = $i;
+            $entry = Foswiki::Func::decodeFormatTokens($entry);
             $entry =~ s/\$(\w+)(?:\((.*?)\))?/
-              _expandHTML( $object, $1, $2, 1, $jump, $newWindow )/ges;
+              _expandVar( $object, $1, $2, 1, $jump, $newWindow )/ges;
             if( !$anchored ) {
                 $entry = CGI::a( { name=>$object->getAnchor() } ).$entry;
@@ -306 +248 @@
     my $text = '';
     foreach my $row ( @$data ) {
-        my $horzrow = $this->_formatAsString( $row, @_ );
-        $text .= $horzrow."\n";
+        my $fmt = $this->{TEXTFORM} || '';
+        $fmt = Foswiki::Func::decodeFormatTokens($fmt);
+        $fmt =~ s/\$(\w+\b)(?:\((.*?)\))?/
+          _expandVar( $row, $1, $2, 0, @_ )/geos;
+        $text .= $fmt."\n";
     }
     return $text;

trunk/ActionTrackerPlugin/lib/Foswiki/Plugins/ActionTrackerPlugin/MANIFEST

@@ -5 +5 @@
 pub/System/ActionTrackerPlugin/atp_src.js 0660 Javascript source
 pub/System/ActionTrackerPlugin/atp.js 0660 Javascript
-pub/System/ActionTrackerPlugin/juggle.gif 0660 Image
+pub/System/ActionTrackerPlugin/logo.png 0660 Image
 pub/System/ActionTrackerPlugin/wikiringlogo20x20.png 0660
 tools/actionnotify 0555 Mailer script

trunk/ActionTrackerPlugin/test/unit/ActionTrackerPlugin/ActionTests.pm

@@ -459 +459 @@
         "", "| \$n\$n()\$nop()\$quot\$percnt\$dollar |", "");
     $s = $fmt->formatHTMLTable([$action], "href", 0, 'atp');
-    $this->assert_html_matches("<td> <br /><br />\"%\$ </td>", $s );
+    $this->assert_html_matches("<td> \n\n\"%\$ </td>", $s );
 
     Foswiki::Plugins::ActionTrackerPlugin::Action::forceTime("1 Jun 2002");