Natural Edit Contrib

Powered by WikiRing Consultants

Description

The NatEdit is an wiki editor that helps in learning the TWikiMarkup 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 TWiki:Plugins/JQueryPlugin to use NatEdit.

Caution:
Theming has been disabled in the current version. So you are stuck with one and the same button layout for now. Themability is brought back on the final 2.0 release, hopefully.

Documentation

jquery.natedit docu

Screenshot

Configuration

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

   * Set SKIN = natedit,pattern

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

   * Set SKIN = nat

is sufficient.

JSUnitContrib based Unit tests

There is a small set of browser based unit tests defined in NatEditContribJSUnitTests that can be run as a problem diagnosing tool. These require the installation of TWiki:Plugins.JSUnitContrib, and then can be run from Run all tests

Testing has been carried out using Safari, Firefox, Opera and Internet Explorer.

Contrib Info

Sponsored by Trivadis AG & TWIKI.NET

Author:	TWiki:Main/MichaelDaum
Copyright ©:	2007-2008 Michael Daum http://michaeldaumconsulting.com
License:	GPL (GNU General Public License)
Version:	v2.00-pre1
Change History:
17 Jan 2008	reimplemented as jquery.natedit plugin; using a tabbed interface now; new default button design
03 Jan 2008	added beforeSubmitHandler to give TWiki:Plugins/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 twiki's 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 TWiki:Main.SvenDowideit DistributedINFORMATION for TWIKI.NET
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 TWiki:Plugins/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 (TWiki-4.1.2)
31 Mar 2007	Initial version
Dependencies:	%$DEPENDENCIES%
Perl Version:	-
Plugin Home:	TWiki:Plugins/NatEditContrib
Feedback:	TWiki:Plugins/NatEditContribDev
Appraisal:	TWiki:Plugins/NatEditContribAppraisal

-- TWiki:Main.MichaelDaum - 13 Feb 2008