Natural Edit Plugin

Description

The NatEdit is an wiki editor that helps in learning the TML Language by providing a GUI. By design, this is not a wysiwyg editor that tries to generate the correct TML in the background. Instead, the user is still in charge of writing correct wiki markup but with a bit more of assistance as a plain browser textarea. Therefor this editor helps to lower the learning curve but will not get in your way once you are aware of wiki markup.

NatEdit is implemented as a jquery plugin, called jquery.natedit, and thus heavily depends on javascript. Hence browsers without javascript are not supported. You will need to install the JQueryPlugin to use NatEdit.

Caution: Unlikely previous versions (pre 2.0), theming has been disabled in the current version. So you are "stuck" with one and the same button layout for now.

Documentation

jquery.natedit docu

Screenshot

screenshot

Configuration

PatternSkin:
To enable the NatEditPlugin add the identifier natedit to the SKIN variable in SitePreferences or WebPreferences, e.g.

   * Set SKIN = natedit,pattern

NatSkin:
No extra configuration steps are needed in case you are using NatSkin. NatEditPlugin is the default editor for NatSkin, that is the normal

   * Set SKIN = nat

is sufficient.

Plugin Installation Instructions

You do not need to install anything in the browser to use this extension. The following instructions are for the administrator who installs the extension on the server.

Open configure, and open the "Extensions" section. Use "Find More Extensions" to get a list of available extensions. Select "Install".

If you have any problems, or if the extension isn't available in configure, then you can still install manually from the command-line. See http://foswiki.org/Support/ManuallyInstallingExtensions for more help.

Author: Michael Daum
Copyright ©: 2007-2013 Michael Daum http://michaeldaumconsulting.com
License: GPL (GNU General Public License)
Release: 07 Aug 2013
Version: 7.10
Change History:  
07 Aug 2013 fixed generation of a new validation key in a save+continue
17 Jul 2013 added support for CaptchaPlugin
18 Jun 2013 removed dependency on SetVariablePlugin
28 Mar 2013 fixed storing the TopicTitle changing during a rename action only to the topic being renamed
27 Feb 2013 re-fixed strikeone-protected save+continue; improved error handling dealing with AntiWikiSpamPlugin-alike error messages
20 Feb 2013 fixed character encoding when previewing a topic on a non-utf8 site
25 Jan 2013 fixed auto-start feature
18 Jan 2013 improved compatibility with PatternSkin
15 Jan 2013 added work-around for an IE8 bug in textareas
21 Dec 2012 added in-edit upload support using Foswiki:Extensions/TopicInteractionPlugin
29 Oct 2012 removed local button styles to allow theming via jquery-ui; use of NATEDIT_THEME is deprecated from now on
22 Oct 2012 implemented improved list editing; rewrite of modal dialogs to use jquery-ui-dialog instead of the old simplemodal library
10 Jul 2012 fixed character encoding when saving a topic on a non-utf8 site using a REST handler
21 Feb 2012 only add one strikeone nonce to the http header
20 Feb 2012 moved missing javascript code over from NatSkin to NatEditPlugin; fixed save+continue on a strikeone-protected foswiki; added compatibility wrapper for older APIs to Foswiki::Validate
17 Feb 2012 added interface to set permissions from within edit (only with Foswiki:Extensions/SetVariablePlugin installed)
11 Jan 2012 added support for Foswiki:Extensions/WorkflowPlugin
10 Jan 2012 added german translation; fixed css when used with PatternSkin
30 Sep 2011 fixed autoresize of wysiwyg editor; improved toggle button switching between raw and wysiwyg editor; improved integration of validation code; using ui::autocomplete instead of deprecated jquery.autocomplete plugin now
04 Apr 2011 using a modal dialog for preview; save+continue is done in the background async'ly now
24 Mar 2011 added specific css classes for each button box
17 Feb 2011 fixed insert table in IE7+8
22 Dec 2010 fixed some errors reported by jslint; improved the way forms are submitted to be more jquery-friendly
06 Dec 2010 Foswikitask:Item2304: fixes for Google Chrome
01 Dec 2010 fixed compatibility with newest foswiki; improved TopicTitle feature not to set a title under certain conditions; Foswikitask:Item9006: disabling preview button on IE6,7,8; shipping compressed and minified css+js
12 Feb 2010 Foswikitask:Item8486, Foswikitask:Item8385: fixing edit and settings screen on PatternSkin
04 Dec 2009 Foswikitask:Item2453: Form data not saved when edit is invoked with ?action=form ('Edit data form of this topic' link)
18 Nov 2009 Foswikitask:Item2373: improve XHTML validation
17 Nov 2009 Foswikitask:Item2368 toolbar not always hidden (PH); improved usability of upload and insert-link dialog
02 Nov 2009 Foswikitask:Item2281: attempt to make TinyMCE resize automatically as NatEdit does
14 Sep 2009 yet another attempt to support TinyMCEPlugin; don't take over raw edit automatically; added PatternSkin css fixes for edit dialogs
20 Aug 2009 added support for ImagePlugin when inserting attachments
03 Jul 2009 IE fixes, PatternSkin related fixes
23 Jun 2009 converted to foswiki, lots of feature enhancements
03 Feb 2009 fixed preview+save on Foswiki/PatternSkin; fixed force new revision; added a workaround to bind the submit event to the return key in input fields (gets hijacked by jscalendar popup otherwise)
15 Jan 2009 fixed buttons in preview screen
07 Jan 2009 support for TinyMCEPlugin wysiwyg editor; removed non-maintained "word" style; fixes for foswiki/compat; added settings template; distinguishing restore revision from a normal edit; made DBCachePlugin's topic title feature optional; added "Show on screen" settings to easily switch off form, attachment or meta:comments (forthcoming); fixed action=text; removing TopicTitle formfield from the "Form" tab if it is already on the "Text" tab
18 Nov 2008 fixing form data being nulled on preview; using jquery to submit the data
13 Nov 2008 using new BUTTONs from JQueryPlugin
12 Nov 2008 fixing calculation of bottom bar, using new automaxexpand feature of tabpane widget
11 Nov 2008 usability improvements on topic forms
16 Jul 2008 fixed calculation of tab height; removed topicinfo makro as it is in conflict with PatternSkin
03 Jul 2008 improved skin to ease integration into WikiApplication
29 Apr 2008 added workaround for regression error in IE6+7's textarea; be backwards compatible to legacy pattern skins
17 Jan 2008 reimplemented as jquery.natedit plugin; using a tabbed interface now; new default button design
03 Jan 2008 added beforeSubmitHandler to give EditChapterPlugin a chance to hook in
13 Nov 2007 fixed calculation of textarea offset while autoresizing it to window height, fixed initialization not to use Behaviour anymore, fixed autohide/showing of word toolbar together with tinymce
08 Oct 2007 fixed word toolbar together with TinyMCEPlugin; fixed launching a popup by not relying on standard javascript; using css sprites instead of individual buttons
02 Oct 2007 be compatible with TinyMCEPlugin
23 Aug 2007 bug fixes for IE6&7 - Item4430
04 Aug 2007 added Word theme added bullet and numbered lists buttons & Javascript added create Table button and Javascript work done by Sven Dowideit DistributedINFORMATION
21 May 2007 fixed display of toolbar buttons
01 May 2007 made natedit themable
27 Apr 2007 made all button output configurable; standardized their defaults; fixed javascript in preview mode; added support for RevCommentPlugin; added monospace button; reworked some of the icons
23 Apr 2007 fixed IE freezing on resizing the edit window
05 Apr 2007 added support for EditContrib and editform
04 Apr 2007 added css file; added monospace <-> propotional font toggles; made signature text customizable; minor refactoring of the javascript; removed non-standard tags FORMATLIST and IFDEFINED
03 Apr 2007 added NATEDIT_HELPTEXT variable; be backwards compatible to PatternSkin
31 Mar 2007 Initial version
Dependencies:
NameVersionDescription
Foswiki::Plugins::JQueryPlugin>=4.2Required.
Foswiki::Plugins::TopicInteractionPlugin>=3.20Optional, require to upload attachments from within the editor.
Foswiki::Plugins::ZonePlugin>=3.1Required. required for Foswiki < 1.1
Perl Version: -
Plugin Home: http://foswiki.org/Extensions/NatEditPlugin

Topic revision: r43 - 02 Sep 2013, MichaelDaum
 
The copyright of the content on this website is held by the contributing authors, except where stated elsewhere. see CopyrightStatement. Creative Commons License