Menu
▾
▴
[TWiki-Dev] [SVN] PeterThoeny r19277 - in twiki/trunk/TimeSincePlugin: data/TWiki lib/TWiki/Plugins lib/TWiki/Plugins/TimeSincePlugin
|
From: <de...@de...> - 2010-07-27 08:36:37
|
Author: PeterThoeny Date: 2010-07-27 03:36:30 -0500 (Tue, 27 Jul 2010) New Revision: 19277 Trac url: http://develop.twiki.org/trac/changeset/19277 Modified: twiki/trunk/TimeSincePlugin/data/TWiki/TimeSincePlugin.txt twiki/trunk/TimeSincePlugin/lib/TWiki/Plugins/TimeSincePlugin.pm twiki/trunk/TimeSincePlugin/lib/TWiki/Plugins/TimeSincePlugin/Core.pm Log: Item6530: Doc fixes; changing TWIKIWEB to SYSTEMWEB Modified: twiki/trunk/TimeSincePlugin/data/TWiki/TimeSincePlugin.txt =================================================================== --- twiki/trunk/TimeSincePlugin/data/TWiki/TimeSincePlugin.txt 2010-07-27 08:23:22 UTC (rev 19276) +++ twiki/trunk/TimeSincePlugin/data/TWiki/TimeSincePlugin.txt 2010-07-27 08:36:30 UTC (rev 19277) @@ -1,24 +1,21 @@ -%META:TOPICINFO{author="TWikiContributor" date="1139390249" format="1.1" version="$Rev$"}% +%META:TOPICINFO{author="TWikiContributor" date="1280219405" format="1.1" version="$Rev$"}% +---+!! <nop>%TOPIC% <!-- - - PLEASE DO NOT EDIT THIS TOPIC - - It is automatically generated from the subversion repository, and any changes - you make will simply be overwritten the next time a release is generated. - - Instead, you could check your fix in, raise a bug in the Bugs web, or mail the author. + Contributions to this plugin are appreciated. Please update the plugin page at + http://twiki.org/cgi-bin/view/Plugins/TimeSincePlugin or provide feedback at + http://twiki.org/cgi-bin/view/Plugins/TimeSincePluginDev. + If you are a TWiki contributor please update the plugin in the SVN repository. --> ----+!! %TOPIC% +%SHORTDESCRIPTION% +<div style="float:right; background-color:#eeeeee; margin:0 0 20px 20px; padding: 0 10px 0 10px; width:380px"> +%TOC{title="Page contents"}% +</div> -This plugin is inspired by the <nop>WordPress <nop>TimeSince plugin. -It which can be used to display a time difference in a human readable way, for instance to tell you that a topic has been published "2 days, 3 hours ago". +---++ Introduction -There are some problems with the original [[http://binarybonsai.com/wordpress/time-since][TimeSince plugin for WordPress]]. For example, it was only able to display a time diff with at most two expressions: "1day, 2hours ago" or "1 week ago" but not "1 day, 2 hours and 3 minutes". -It even displays only one time expression if the difference does not occure in two adjacent time units (time units are year, month, week, day, hour, minute). -If a time interval differs in week and hour the <nop>TimeSince WP plugin will only display the week difference and not the hours as week and hour are not adjacent. This is fixed in the TimeSincePlugin for TWiki. Several other parameters have been added -to give a finer control of the format and the information displayed. +This plugin is inspired by the <nop>WordPress <nop>TimeSince plugin. It which can be used to display a time difference in a human readable way, for instance to tell you that a topic has been published "2 days, 3 hours ago". -%TOC% +There are some problems with the original [[http://binarybonsai.com/wordpress/time-since][TimeSince plugin for WordPress]]. For example, it was only able to display a time diff with at most two expressions: "1day, 2hours ago" or "1 week ago" but not "1 day, 2 hours and 3 minutes". It even displays only one time expression if the difference does not occure in two adjacent time units (time units are year, month, week, day, hour, minute). If a time interval differs in week and hour the <nop>TimeSince WP plugin will only display the week difference and not the hours as week and hour are not adjacent. This is fixed in the TimeSincePlugin for TWiki. Several other parameters have been added to give a finer control of the format and the information displayed. ---++ Syntax Rules @@ -41,6 +38,7 @@ | =negformat="<format-string>"= | use this format string if the time difference is negative | Time expressions can be specified in any of the following format: + * 31 Dec 2001 - 23:59 (TWiki date) * 31 Dec 2001 * 2001/12/31 23:59:59 (RCS date) %BR% @@ -54,6 +52,7 @@ * epoch seconds Format strings may contain the following: + * =$time= expands to the calculated time difference * =$percnt$= expands to a =%= char * =$dollar$= expands to a =$= char @@ -62,37 +61,38 @@ * =$nop= expands to the empty string ---++ Examples + | *You type* | *You get (simulated)* | *You get (if installed) *| -| %<nop>TIMESINCE% | 1 day, 3 hours | %TIMESINCE% | -| %<nop>TIMESINCE{format="topic was created $time ago" null="topic has just now been saved" units="4" }% | topic was created 1 day, 3 hours, 8 minutes ago \ +| =%<nop>TIMESINCE%= | 1 day, 3 hours | %TIMESINCE% | +| =%<nop>TIMESINCE{format="topic was created $time ago" null="topic has just now been saved" units="4" }%= | topic was created 1 day, 3 hours, 8 minutes ago \ | %TIMESINCE{format="topic was created $time ago" null="topic has just now been saved" units="4"}% | -| %<nop>TIMESINCE{"11 Sep 2001 - 8:45" units="7" seconds="on"}% \ +| =%<nop>TIMESINCE{"11 Sep 2001 - 8:45" units="7" seconds="on"}%= \ | 4 years, 2 months, 2 days, 5 hours, 50 minutes, 16 seconds \ | %TIMESINCE{"11 Sep 2001 - 8:45" units="7" seconds="on"}% | -| %<nop>TIMESINCE{from="1955/04/18" to="1979-03-14" units="3"}% | 23 years, 11 months, 6 days \ +| =%<nop>TIMESINCE{from="1955/04/18" to="1979-03-14" units="3"}%= | 23 years, 11 months, 6 days \ | %TIMESINCE{from="1955/04/18" to="1979-03-14" units="3"}% | - ---++ Plugin Installation Instructions - * [[http://twiki.org/p/pub/Plugins/%TOPIC%/%TOPIC%.zip][Download]] the ZIP file + * Download the ZIP file from the Plugin Home (see below) * Unzip it in your twiki installation directory. Content: | *File:* | *Description:* | | ==data/TWiki/%TOPIC%.txt== | plugin topic | | ==lib/TWiki/Plugins/%TOPIC%.pm== | plugin perl module | | ==lib/TWiki/Plugins/%TOPIC%/Core.pm== | plugin core | - * (Dakar) Visit =configure= in your TWiki installation, and enable the plugin in the {Plugins} section. + * Visit =configure= in your TWiki installation, and enable the plugin in the {Plugins} section. ---++ Plugin Info -<!-- provided for compatibility only + +<!-- * Set SHORTDESCRIPTION = Display time difference in a human readable way --> - | Plugin Author: | TWiki:Main.MichaelDaum | -| Copyright ©: | 2005-2008, Michael Daum http://michaeldaumconsulting.com | +| Copyright: | © 2005-2008 Michael Daum http://michaeldaumconsulting.com, %BR% © 2005-2010 TWiki:TWiki.TWikiContributor | | License: | GPL ([[http://www.gnu.org/copyleft/gpl.html][GNU General Public License]]) | -| Plugin Version: | v1.10 | +| Plugin Version: | %$VERSION% | | Change History: | <!-- versions below in reverse order --> | +| 2010-07-27: | TWikibug:Item6530 - doc fixes; changing TWIKIWEB to SYSTEMWEB | | 03 Jan 2008: | improved parsing time formats | | 13 Oct 2006: | added =negformat= parameter | | 31 Aug 2006: | added NO_PREFS_IN_TOPIC | @@ -102,9 +102,9 @@ | CPAN Dependencies: | CPAN:Time::Local | | Other Dependencies: | none | | Perl Version: | 5.005 | -| [[TWiki:Plugins/Benchmark][Benchmarks]]: | %TWIKIWEB%.GoodStyle nn%, %TWIKIWEB%.FormattedSearch nn%, %TOPIC% nn% | -| Plugin Home: | TWiki:Plugins/%TOPIC% | -| Feedback: | TWiki:Plugins/%TOPIC%Dev | -| Appraisal: | TWiki:Plugins/%TOPIC%Appraisal | +| TWiki:Plugins.Benchmark: | %SYSTEMWEB%.GoodStyle nn%, %SYSTEMWEB%.FormattedSearch nn%, %TOPIC% nn% | +| Plugin Home: | http://twiki.org/cgi-bin/view/Plugins/%TOPIC% | +| Feedback: | http://twiki.org/cgi-bin/view/Plugins/%TOPIC%Dev | +| Appraisal: | http://twiki.org/cgi-bin/view/Plugins/%TOPIC%Appraisal | --- TWiki:Main.MichaelDaum - 03 Jan 2008 +__Related Topics:__ %SYSTEMWEB%.TWikiPlugins, %SYSTEMWEB%.DeveloperDocumentationCategory, %SYSTEMWEB%.UserDocumentationCategory Modified: twiki/trunk/TimeSincePlugin/lib/TWiki/Plugins/TimeSincePlugin/Core.pm =================================================================== --- twiki/trunk/TimeSincePlugin/lib/TWiki/Plugins/TimeSincePlugin/Core.pm 2010-07-27 08:23:22 UTC (rev 19276) +++ twiki/trunk/TimeSincePlugin/lib/TWiki/Plugins/TimeSincePlugin/Core.pm 2010-07-27 08:36:30 UTC (rev 19277) @@ -1,6 +1,7 @@ # Plugin for TWiki Collaboration Platform, http://TWiki.org/ # # Copyright (C) 2005-2006 Michael Daum <mi...@na...> +# Copyright (C) 2005-2010 TWiki Contributors # # Adapted from WordPress plugin TimeSince by # Michael Heilemann (http://binarybonsai.com), Modified: twiki/trunk/TimeSincePlugin/lib/TWiki/Plugins/TimeSincePlugin.pm =================================================================== --- twiki/trunk/TimeSincePlugin/lib/TWiki/Plugins/TimeSincePlugin.pm 2010-07-27 08:23:22 UTC (rev 19276) +++ twiki/trunk/TimeSincePlugin/lib/TWiki/Plugins/TimeSincePlugin.pm 2010-07-27 08:36:30 UTC (rev 19277) @@ -1,6 +1,7 @@ # Plugin for TWiki Collaboration Platform, http://TWiki.org/ # # Copyright (C) 2005-2006 Michael Daum <mi...@na...> +# Copyright (C) 2005-2010 TWiki Contributors # # Adapted from WordPress plugin TimeSince by # Michael Heilemann (http://binarybonsai.com), @@ -28,7 +29,7 @@ ); $VERSION = '$Rev$'; -$RELEASE = '1.10'; +$RELEASE = '2010-07-27'; $NO_PREFS_IN_TOPIC = 1; $SHORTSUMMARY = 'Display time difference in a human readable way'; |