NatEditContrib < TWiki

TWiki Web>NatEditContrib (12 Sep 2008, TWikiAdminGroup) (raw view)EditAttach

---+!! Natural Edit Contrib
<!--

   PLEASE DO NOT EDIT THIS TOPIC

   It is automatically generated from the subversion repository, and any
   changes you make will simply be overwritten the next time a release is
   generated.

   Instead, you could check your fix in, raise a bug in the Bugs web, or
   mail the author.
-->
%TOC%
<table style="float:right">
<tr>
  <td><img src="%ATTACHURLPATH%/wikiringlogo40x40.png"></td>
  <td><a href="http://wikiring.de" title="Make your Wiki ring!" style="text-decoration:none">
      Powered by <br /> <nop>WikiRing Consultants </a>
  </td>
</tr>
</table>

---++ Description
The <nop>NatEdit is an wiki editor that helps in learning the <nop>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. 

<nop>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 <nop>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
<img src="%ATTACHURLPATH%/screenshot1.png" alt="screenshot1.png" />

---++ Configuration
*PatternSkin:* %BR%
To enable the <nop>NatEditContrib add the identifier =natedit= to the =SKIN= 
variable in %MAINWEB%.TWikiPreferences or WebPreferences, e.g.
<pre>
   * <!-- -->Set SKIN = natedit,pattern
</pre>

*NatSkin:* %BR%
No extra configuration steps are needed in case you are using TWiki:Plugins/NatSkin.
<nop>NatEditContrib is the default editor for <nop>NatSkin, that is the normal
<pre>
   * <!-- -->Set SKIN = nat
</pre>
is sufficient.


<!--
   * Set STUB = %$STUB%
   * Set SHORTDESCRIPTION = A Wikiwyg Editor
-->

---++ <nop>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
*[[%PUBURL%/%TWIKIWEB%/JSUnitContrib/testRunner.html?testpage=%SCRIPTURL{"view"}%/%WEB%/NatEditContribJSUnitTests][Run all tests]]*

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

---++ Contrib Info
Sponsored by [[http://www.trivadis.com][Trivadis AG]] & [[http://twiki.net][TWIKI.NET]]

|  Author: | TWiki:Main/MichaelDaum |
|  Copyright &copy;: | 2007-2008 Michael Daum http://michaeldaumconsulting.com |
|  License: | GPL ([[http://www.gnu.org/copyleft/gpl.html][GNU General Public License]]) |
|  Version: | v2.12 |
|  Change History: | |
|  16 Jul 2008 | fixed calculation of tab height; removed =topicinfo= makro as it is in conflict with <nop>PatternSkin |
|  03 Jul 2008 | improved skin to ease integration into <nop>TWikiApplication |
|  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 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 <nop>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 <nop>TinyMCEPlugin |
|  23 Aug 2007 | bug fixes for IE6&7 - [[http://develop.twiki.org/~twiki4/cgi-bin/view/Bugs/Item4430][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 [[http://DistributedINFORMATION.com][DistributedINFORMATION]] for [[http://twiki.net][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 <nop>EditContrib and =editform= |
|  04 Apr 2007 | added css file; \
                   added monospace &lt;-&gt; 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 <nop>PatternSkin (TWiki-4.1.2) |
|  31 Mar 2007 | Initial version |
|  Dependencies: | <table border="1"><tr><th>Name</th><th>Version</th><th>Description</th></tr><tr><td align="left">TWiki::Plugins::JQueryPlugin</td><td align="left">&gt;=0.50</td><td align="left">Required. Download from the TWiki:Plugins/JQueryPlugin add-on. </td></tr></table> |
|  Perl Version: | - |
|  Plugin Home: | TWiki:Plugins/%TOPIC% |
|  Feedback: | TWiki:Plugins/%TOPIC%Dev |
|  Appraisal: | TWiki:Plugins/%TOPIC%Appraisal |

-- TWiki:Main.MichaelDaum - 16 Jul 2008

Attachments

Topic attachments
I	Attachment	Action	Size	Date	Who	Comment
js	edit.js	manage	1.5 K	17 Jul 2008 - 02:02	TWikiAdminGroup	Saved by install script
js	jquery.natedit.js	manage	22.8 K	17 Jul 2008 - 02:02	TWikiAdminGroup	Saved by install script
png	screenshot1.png	manage	50.9 K	17 Jul 2008 - 02:02	TWikiAdminGroup	Saved by install script
css	styles.css	manage	1.9 K	17 Jul 2008 - 02:02	TWikiAdminGroup	Saved by install script
png	wikiringlogo40x40.png	manage	2.5 K	17 Jul 2008 - 02:02	TWikiAdminGroup	Saved by install script

Topic revision: r2 - 12 Sep 2008 - 20:10:58 - TWikiAdminGroup

TWiki

Webs
DnD
Main
Support
TWiki

Copyright © by the contributing authors. All material on this collaboration platform is the property of the contributing authors.
Ideas, requests, problems regarding TWiki? Send feedback
Note: Please contribute updates to this topic on TWiki.org at TWiki:TWiki.NatEditContrib