r6 - 03 Sep 2006 - 19:40:16 - ChuckEhrlichYou are here: TWiki >  Plugins Web > PluginPackage > PluginPackageHowTo > DblClickEditPlugin
Tags:
editing 1 Add my vote for this tag, , create new tag

DblClickEditPlugin

WikiWiki stand's for quick .... This plugin allow to edit a topic just via a mouse double-click.

Why creating a plugin for this javascript feature:

  • to make it available for all skins
  • better modularity
  • to get dynamic disable feature in some cases like topics with EditTablePlugin active

Syntax Rules

  • define DBLCLICKEDIT setting to NO if you want to disable this feature
    • for you only right in your home topic
    • for a web right in WebPreferences topic
    • for a topic right in given topic

Example

suppose that this
is your
Topic content ...
Just dbl click here to edit DblClickEditPlugin topic !

Plugin Settings

Plugin settings are stored as preferences variables. To reference a plugin setting write %<plugin>_<setting>%, i.e. %NEWPLUGIN_SHORTDESCRIPTION%

  • One line description, is shown in the TextFormattingRules topic:
    • Set SHORTDESCRIPTION = Start editing with double click 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 DblClickEditPlugin.zip in your twiki installation directory. Content:
    File: Description:
    data/TWiki/DblClickEditPlugin.txt Plugin topic config
    lib/TWiki/Plugins/DblClickEditPlugin.pm Plugin Perl module
  • Configure the Plugin:
    • TWiki 4.0 and up: Run the configure script to enable the Plugin
  • Test if the installation was successful: just double click on any topic which is not protected from this feature.

Plugin Info

Plugin Author: TWiki:Main.PatrickNomblot
Copyright: © 2006, TWiki:Main.PatrickNomblot
License: GPL (GNU General Public License)
Plugin Version: 03 Jul 2006 (V1.000)
Change History:  
03 Jul 2006: Initial version
TWiki Dependency: $TWiki::Plugins::VERSION 1.1
CPAN Dependencies: none
Other Dependencies: none
Perl Version: 5.005
Benchmarks: GoodStyle nn%, FormattedSearch nn%, DblClickEditPlugin nn%
Plugin Home: http://TWiki.org/cgi-bin/view/Plugins/DblClickEditPlugin
Feedback: http://TWiki.org/cgi-bin/view/Plugins/DblClickEditPluginDev
Appraisal: http://TWiki.org/cgi-bin/view/Plugins/DblClickEditPluginAppraisal

Related Topics: TWikiPlugins, DeveloperDocumentationCategory, AdminDocumentationCategory, TWikiPreferences

-- TWiki:Main.PatrickNomblot - 03 Jul 2006

Warning: File below is supposed to be .tgz downloads as a .gz file. I had to change the extension in order to get it unpacked correctly.

-- ChuckEhrlich - 03 Sep 2006

Topic attachments
I Attachment Action Size Date Who Comment
plpm DblClickEditPlugin.pm manage 2.1 K 04 Jul 2006 - 13:43 PatrickNomblot avoid dblclickedit in edit mode
ziptgz DblClickEditPlugin.tgz manage 2.7 K 03 Jul 2006 - 12:18 PatrickNomblot first release
Edit | WYSIWYG | Attach | Printable | Raw View | Backlinks: Web, All Webs | History: r6 < r5 < r4 < r3 < r2 | More topic actions
 
Powered by TWiki
This site is powered by the TWiki collaboration platformCopyright © by the contributing authors. All material on this collaboration platform is the property of the contributing authors.
Ideas, requests, problems regarding TWiki? Send feedback SourceForge.net Logo