InlineEditPlugin

The Inline Edit Plugin provides a quick (zero server roundtrip) edit functionality from the TWiki view script. It has been architected to allow the definition and choice of Javascript editing component, using a TWiki template file. It is intended to be used in conjunction with Component Edit Plugin to enable editing of T Wiki Variables.

This is an initial pre-release and is not intended to be used in production. Insufficient testing and feedback has happened - and Its known to have problems with T Wiki Variables embeded in HTML attributes.

WARNING: when you edit using Inline Edit Plugin, it tries to create a topic lock or lease. In Cairo, this is done using the edit script, and in TWiki-4 via rest script. Unfortunatly, this means that they will only work if the respective scripts are authenticated, or a server side session is used.

WARNING: tinymce tries to clean up html, so i fyou have any html inline in the topic text, it WILL get broken - I'm planning on using sectional editing to work around this, but thats also a complex issue

 

Usage

If the Inline Edit Plugin is installed and enabled, all you should need to edit a page, is to double click on the rendered topic text. T Wiki Variables will be highlighted in Grey boxes, that you can click on to get a popup edit dialog driven by the Component Edit Plugin.

Plugin Settings

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

• One line description, is shown in the Text Formatting Rules topic:
  • Set SHORTDESCRIPTION = adds double click to edit functionality to the TWiki view script

• Debug plugin: (See output in data/debug.txt)
  • Set DEBUG = 0

• Select the editors, in order of preference (list the more specialised ones first)
• choose from (wikiwyg / tinymce / textarea)
• only textarea works in this release
  • Set EDITORS = tableedit, textarea

• If defined, we use the Wysiwyg Plugin 's TML2HTML, while if undefined, we use the new and less tested javascript version
• don't set this unless you have alot of spare CPU on your server
  • Set SENDHTML = 0

• set a minimum number of lines in a section, for sectional Edit - otherwise you get alot of single line edit boxes
• 0 means no sections (edit entire topic only)
  • Set MINIMUMSECTIONLENGTH = 1

• this option restricts the Inline Edit Plugin from adding its sections to only views using the specificed skins (it will otherwise break rss, kupu, etc)
• unset means the plugin is not present in view, but can still be used for sectional saving
  • Set SKINS = nat, pattern, classic, koala, smartedit, plain

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 server where TWiki is running.

 

• Download the ZIP file from the Plugin web (see below)
• Unzip InlineEditPlugin.zip in your twiki installation directory. Content: File:Description:data/TWiki/InlineEditPlugin.txt Plugin topic data/TWiki/InlineEditPlugin.txt,v Plugin topic repository lib/TWiki/Plugins/InlineEditPlugin.pm Plugin Perl module
• use the configure script to enable the Wysiwyg Plugin and Inline Edit Plugin
• Test if the installation was successful:
  • double click in a topic you have permission to edit.

 

Plugin Info

 

Plugin Author:	TWiki:Main.SvenDowideit - Sven Dowideit? @wikiring.com
Copyright:	© 2001-2006, SvenDowideit@wikiring.com
Plugin Version:	30 April 2006 (V0.900)
Change History:
30 April 2006:	Initial version
TWiki Dependency:	$TWiki::Plugins::VERSION 1.024
CPAN Dependencies:	CPAN:JSON
Other Dependencies:	TWiki:Plugins.WysiwygPlugin
Perl Version:	5.005
License:	GPL ( GNU General Public License)
TWiki:Plugins/Benchmark:	Good Style nn%, Formatted Search nn%, Inline Edit Plugin nn%
Plugin Home:	http://TWiki.org/cgi-bin/view/Plugins/InlineEditPlugin
Feedback:	http://TWiki.org/cgi-bin/view/Plugins/InlineEditPluginDev
Appraisal:	http://TWiki.org/cgi-bin/view/Plugins/InlineEditPluginAppraisal

Related Topics: T Wiki Preferences, T Wiki Plugins

-- TWiki:Main.SvenDowideit