Author: PeterThoeny Date: 2011-02-24 02:28:03 -0600 (Thu, 24 Feb 2011) New Revision: 20500 Trac url: http://develop.twiki.org/trac/changeset/20500 Added: twiki/branches/TWikiRelease05x00/DblClickEditPlugin/ twiki/branches/TWikiRelease05x00/DblClickEditPlugin/data/ twiki/branches/TWikiRelease05x00/DblClickEditPlugin/data/TWiki/ twiki/branches/TWikiRelease05x00/DblClickEditPlugin/data/TWiki/DblClickEditPlugin.txt twiki/branches/TWikiRelease05x00/DblClickEditPlugin/lib/ twiki/branches/TWikiRelease05x00/DblClickEditPlugin/lib/TWiki/ twiki/branches/TWikiRelease05x00/DblClickEditPlugin/lib/TWiki/Plugins/ twiki/branches/TWikiRelease05x00/DblClickEditPlugin/lib/TWiki/Plugins/DblClickEditPlugin.pm Log: Item6638: Initial import into SVN -- thanks TWiki:Main.PatrickNomblot Added: twiki/branches/TWikiRelease05x00/DblClickEditPlugin/data/TWiki/DblClickEditPlugin.txt =================================================================== --- twiki/branches/TWikiRelease05x00/DblClickEditPlugin/data/TWiki/DblClickEditPlugin.txt (rev 0) +++ twiki/branches/TWikiRelease05x00/DblClickEditPlugin/data/TWiki/DblClickEditPlugin.txt 2011-02-24 08:28:03 UTC (rev 20500) @@ -0,0 +1,75 @@ +%META:TOPICINFO{author="PatrickNomblot" date="1151929123" format="1.1" reprev="1.2" version="1.2"}% +---+!! <nop>%TOPIC% + +This plugin allow to edit a topic just via a double mouse clic. + +%TOC% + +---++ Syntax Rules + + * define var %<nop>DBLCLICKEDIT% to NO if you want to disable this feature + * for you only, in your home topic + * for a web, in WebPreferences topic + * for a topic, in given topic + + +---++ Example +<center><div style="background-color: #FFFFcc; border: 1px solid #006633; width:80%; text-align:center;"} ondblclick="javascript:location.href='%SCRIPTURL{"edit"}%/%WEB%/%TOPIC%?t=%GMTIME{"$epoch"}%'" > +suppose that this <br> +is your <br> +Topic content ...<br> +Just dbl click here to edit %TOPIC% topic ! +</div></center> + + + +---++ Plugin Settings + +Plugin settings are stored as preferences variables. To reference a plugin setting write ==%<nop><plugin>_<setting>%==, i.e. ==%<nop>NEWPLUGIN_SHORTDESCRIPTION%== + + * One line description, is shown in the %TWIKIWEB%.TextFormattingRules topic: + * Set SHORTDESCRIPTION = start editing with dbl clic mouse button + + * Debug plugin: (See output in =data/debug.txt=) + * Set DEBUG = 0 + + * My own setting: + * Set DBLCLICKEDIT = YES + + +---++ 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. + + * 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%.txt,v== | Plugin topic repository | + | ==lib/TWiki/Plugins/%TOPIC%.pm== | Plugin Perl module | + * Configure the Plugin: + * TWiki 4.0 and up: Run the [[%SCRIPTURL%/configure%SCRIPTSUFFIX%][configure]] script to enable the Plugin + * Change the Plugin settings as needed + * Test if the installation was successful: + * _enter samples here_ + +---++ Plugin Info + +| Plugin Author: | TWiki:Main.PatrickNomblot | +| Copyright: | © 2006, TWiki:Main.PatrickNomblot | +| License: | GPL ([[http://www.gnu.org/copyleft/gpl.html][GNU General Public License]]) | +| Plugin Version: | 03 Jul 2006 (V1.000) | +| Change History: | <!-- versions below in reverse order --> | +| 03 Jul 2006: | Initial version | +| TWiki Dependency: | $TWiki::Plugins::VERSION 1.1 | +| CPAN Dependencies: | none | +| Other Dependencies: | none | +| Perl Version: | 5.005 | +| [[TWiki:Plugins/Benchmark][Benchmarks]]: | %TWIKIWEB%.GoodStyle nn%, %TWIKIWEB%.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 | + +__Related Topics:__ %TWIKIWEB%.TWikiPlugins, %TWIKIWEB%.DeveloperDocumentationCategory, %TWIKIWEB%.AdminDocumentationCategory, %TWIKIWEB%.TWikiPreferences + +-- TWiki:Main.PatrickNomblot - 03 Jul 2006 Added: twiki/branches/TWikiRelease05x00/DblClickEditPlugin/lib/TWiki/Plugins/DblClickEditPlugin.pm =================================================================== --- twiki/branches/TWikiRelease05x00/DblClickEditPlugin/lib/TWiki/Plugins/DblClickEditPlugin.pm (rev 0) +++ twiki/branches/TWikiRelease05x00/DblClickEditPlugin/lib/TWiki/Plugins/DblClickEditPlugin.pm 2011-02-24 08:28:03 UTC (rev 20500) @@ -0,0 +1,69 @@ +# Plugin for TWiki Enterprise Collaboration Platform, http://TWiki.org/ +# +# Copyright (C) 2000-2003 Andrea Sterbini, a.s...@fl... +# Copyright (C) 2001-2006 Peter Thoeny, pe...@th... +# and TWiki Contributors. All Rights Reserved. TWiki Contributors +# are listed in the AUTHORS file in the root of this distribution. +# NOTE: Please extend that file, not this notice. +# +# This program is free software; you can redistribute it and/or +# modify it under the terms of the GNU General Public License +# as published by the Free Software Foundation; either version 2 +# of the License, or (at your option) any later version. For +# more details read LICENSE in the root of this distribution. +# +# This program is distributed in the hope that it will be useful, +# but WITHOUT ANY WARRANTY; without even the implied warranty of +# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. +# +# For licensing info read LICENSE file in the TWiki root. + + +package TWiki::Plugins::DblClickEditPlugin; + +use strict; + +use vars qw( $VERSION $RELEASE $debug $pluginName $web $topic ); + +$VERSION = '$Rev: 9813$'; + +$RELEASE = 'Dakar'; + +# Name of this Plugin, only used in this module +$pluginName = 'DblClickEditPlugin'; + + +sub initPlugin { + my( $atopic, $aweb, $user, $installWeb ) = @_; + + # keep in mind web.topic names + $topic = $atopic; + $web = $aweb; + + # check for Plugins.pm versions + if( $TWiki::Plugins::VERSION < 1.026 ) { + TWiki::Func::writeWarning( "Version mismatch between $pluginName and Plugins.pm" ); + return 0; + } + + # Plugin correctly initialized + return 1; +} + + + +sub postRenderingHandler { + my $url = TWiki::Func::getScriptUrl($web, $topic, "edit") . "?t=". time(); + + my $dblclickedit = TWiki::Func::expandCommonVariables( "%DBLCLICKEDIT%" ); + + if ( $dblclickedit !~ /(no|off|0)/i ) { + $_[0] =~ s#<body([^\>]*)>#<body ondblclick="javascript:location.href=\'$url\'" $1>#; + } + +} + + + + +1; |