[TWiki-Dev] [SVN] PeterThoeny r23281 - in twiki/trunk/VarCachePlugin: data/TWiki lib/TWiki/Plugins

[<de...@de...>]

Author: PeterThoeny
Date: 2012-09-07 17:01:35 -0500 (Fri, 07 Sep 2012)
New Revision: 23281
Trac url: http://develop.twiki.org/trac/changeset/23281

Modified:
   twiki/trunk/VarCachePlugin/data/TWiki/VarCachePlugin.txt
   twiki/trunk/VarCachePlugin/lib/TWiki/Plugins/VarCachePlugin.pm
Log:
Item6837: Doc fixes

Modified: twiki/trunk/VarCachePlugin/data/TWiki/VarCachePlugin.txt
===================================================================
--- twiki/trunk/VarCachePlugin/data/TWiki/VarCachePlugin.txt	2012-09-07 21:38:42 UTC (rev 23280)
+++ twiki/trunk/VarCachePlugin/data/TWiki/VarCachePlugin.txt	2012-09-07 22:01:35 UTC (rev 23281)
@@ -1,4 +1,4 @@
-%META:TOPICINFO{author="TWikiContributor" date="1335590767" format="1.1" version="$Rev$"}%
+%META:TOPICINFO{author="TWikiContributor" date="1347055169" format="1.1" version="$Rev$"}%
 ---+!! Variable Cache Plugin 
 <!--
    Contributions to this plugin are appreciated. Please update the plugin page at
@@ -71,32 +71,42 @@
 
 ---++ Plugin Installation Instructions
 
-__Note:__ You do not need to install anything on the browser to use this plugin. The following instructions are for the administrator who installs the plugin on the TWiki server. 
+__Note:__ You do not need to install anything on the browser to use this plugin. The following instructions are for the administrator who installs the plugin on the TWiki server.
 
-   * Download the ZIP file from the Plugin web (see below)
-   * Unzip ==%TOPIC%.zip== in your twiki installation directory. Content:
-     | *File:* | *Description:* |
-     | ==data/TWiki/%TOPIC%.txt== | Plugin topic |
-     | ==data/TWiki/%TOPIC%Test.txt== | Plugin test topic |
-     | ==data/TWiki/VarVARCACHE.txt== | Variable documentation topic |
-     | ==lib/TWiki/Plugins/%TOPIC%.pm== | Plugin Perl module |
-     | ==pub/TWiki/%TOPIC%/cachetopic.gif== | Cache icon 16x16 |
-   * TWiki 4.0 and up: Run the [[%SCRIPTURL%/configure%SCRIPTSUFFIX%][configure%SCRIPTSUFFIX%]] script to enable the Plugin
-   * Test if the installation was successful:
-      * Visit the %TOPIC%Test topic, it contains a nested search
-      * Click on the <u>refresh</u> link or append a =?varcache=refresh= parameter to the URL
+   * For an __automated installation__, run the [[%SCRIPTURL{configure}%][configure]] script and follow "Find More Extensions" in the in the __Extensions__ section.
 
+   * Or, follow these __manual installation__ steps:
+      * Download the ZIP file from the Plugins home (see below).
+      * Unzip ==%TOPIC%.zip== in your twiki installation directory. Content:
+        | *File:* | *Description:* |
+        | ==data/TWiki/%TOPIC%.txt== | Plugin topic |
+        | ==data/TWiki/%TOPIC%Test.txt== | Plugin test topic |
+        | ==data/TWiki/VarVARCACHE.txt== | Variable documentation topic |
+        | ==lib/TWiki/Plugins/%TOPIC%.pm== | Plugin Perl module |
+        | ==pub/TWiki/%TOPIC%/cachetopic.gif== | Cache icon 16x16 |
+      * Set the ownership of the extracted directories and files to the webserver user.
+      * Make sure the dependencies listed in the table below are resolved.
+        %$DEPENDENCIES%
+
+   * Plugin __configuration and testing__:
+      * Run the [[%SCRIPTURL{configure}%][configure]] script, enable the plugin in the __Plugins__ section
+      * Configure the plugin: See plugin settings above.
+      * Test if the installation was successful:
+         * Visit the %TOPIC%Test topic, it contains a nested search.
+         * Click on the <u>refresh</u> link or append a =?varcache=refresh= parameter to the URL.
+
 ---++ Plugin Info
 
    * One line description, is shown in the %SYSTEMWEB%.TextFormattingRules topic:
       * Set SHORTDESCRIPTION = Cache TWiki variables in selected topics for faster page rendering
 
 |  Plugin Author: | TWiki:Main.PeterThoeny |
-|  Copyright: | &copy; 2004-2012, Peter Thoeny, [[http://www.twiki.net/][Twiki, Inc.]] <br /> &copy; 2008-2012 TWiki:TWiki.TWikiContributor |
+|  Copyright: | &copy; 2004-2012, Peter Thoeny, [[http://twiki.org/][TWiki.org]] <br /> &copy; 2008-2012 TWiki:TWiki.TWikiContributor |
 |  License: | GPL ([[http://www.gnu.org/copyleft/gpl.html][GNU General Public License]]) |
-|  Plugin Version: | 2012-04-27 |
+|  Plugin Version: | 2012-09-07 |
 |  Change History: | <!-- versions below in reverse order -->&nbsp; |
-|  2011-04-27: | TWikibug:Item6871: new =&lt;varcache_exclude&gt;= tag to exclude parts of page from getting cached |
+|  2012-09-07: | TWikibug:Item6837: Doc fixes |
+|  2012-04-27: | TWikibug:Item6871: New =&lt;varcache_exclude&gt;= tag to exclude parts of page from getting cached |
 |  2011-05-25: | TWikibug:Item6701: Small code refactor; adding $SHORTDESCRIPTION that was missing in previous release |
 |  2011-05-24: | TWikibug:Item6730: Move cache data from pub directory to working directory; Use proper umask for directories created; Fix to make it better run under mod_perl; Support abbreviated %<nop>VARCACHE% syntax; Possible to specify a refresh of 0 (meaning infinite) -- TWiki:Main.TimotheLitt |
 |  2011-05-01: | TWikibug:Item6701: Doc improvements |

Modified: twiki/trunk/VarCachePlugin/lib/TWiki/Plugins/VarCachePlugin.pm
===================================================================
--- twiki/trunk/VarCachePlugin/lib/TWiki/Plugins/VarCachePlugin.pm	2012-09-07 21:38:42 UTC (rev 23280)
+++ twiki/trunk/VarCachePlugin/lib/TWiki/Plugins/VarCachePlugin.pm	2012-09-07 22:01:35 UTC (rev 23281)
@@ -23,7 +23,7 @@
 
 # =========================
 our $VERSION = '$Rev$';
-our $RELEASE = '2012-04-27';
+our $RELEASE = '2012-09-07';
 
 # =========================
 our $SHORTDESCRIPTION = 'Cache TWiki variables in selected topics for faster page rendering';