(r1) NatEditPlugin < System

You are here: Foswiki>System Web>NatEditPlugin~~EditAttach~~
---+!! Natural Edit Plugin
<!--

   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.com" title="Make your Wiki ring!" style="text-decoration:none">
      Powered by <br /> <nop>WikiRing Consultants </a>
  </td>
</tr>
</table>

---++ Description
%STARTSECTION{"summary"}%
The <nop>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. 
%ENDSECTION{"summary"}%

<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 <nop>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
<a href="%ATTACHURLPATH%/screenshot1.png" title="screenshot"><img src="%ATTACHURLPATH%/screenshot1.png" alt="screenshot" border="0" /></a>

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

*NatSkin:* %BR%
No extra configuration steps are needed in case you are using <nop>NatSkin.
<nop>NatEditPlugin 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
NatEditPluginJSUnitTests that can be run as a problem diagnosing tool. These
require the installation of <nop>JSUnitContrib, and then can be run
from
*[[%PUBURL%/%SYSTEMWEB%/JSUnitContrib/testRunner.html?testpage=%SCRIPTURL{"view"}%/%WEB%/NatEditPluginJSUnitTests][Run all tests]]*

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

---++ 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.


---++ Plugin Info
Sponsored by [[http://www.trivadis.com][Trivadis AG]] 

|  Author: | Michael Daum |
|  Copyright &copy;: | 2007-2010 Michael Daum http://michaeldaumconsulting.com |
|  License: | GPL ([[http://www.gnu.org/copyleft/gpl.html][GNU General Public License]]) |
|  Release: | v4.21 |
|  Version: | 6336 (2010-02-15) |
|  Change History: | |
|  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 <nop>TinyMCE resize \
                 automatically as <nop>NatEdit does |
|  14 Sep 2009 | yet another attempt to support <nop>TinyMCEPlugin; \
                 don't take over raw edit automatically; \
                 added <nop>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/<nop>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 <nop>TinyMCEPlugin wysiwyg editor; \
                 removed non-maintained "word" style; \
                 fixes for foswiki/compat; \
                 added settings template; \
                 distinguishing _restore revision_ from a normal _edit_; \
                 made <nop>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 <nop>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 <nop>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 <nop>PatternSkin |
|  03 Jul 2008 | improved skin to ease integration into <nop>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 <nop>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 standard javascript; \
                 using css sprites instead of individual buttons |
|  02 Oct 2007 | be compatible with <nop>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 [[http://DistributedINFORMATION.com][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 <nop>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 |
|  31 Mar 2007 | Initial version |
|  Dependencies: | <table class="foswikiTable" border="1"><tr><th>Name</th><th>Version</th><th>Description</th></tr><tr><td align="left">Foswiki::Plugins::JQueryPlugin</td><td align="left">&gt;=3740</td><td align="left">Required.</td></tr><tr><td align="left">Foswiki::Plugins::SetVariablePlugin</td><td align="left">&gt;=4287</td><td align="left">Required.</td></tr><tr><td align="left">Foswiki::Plugins::UploadPlugin</td><td align="left">&gt;=1340</td><td align="left">Required.</td></tr><tr><td align="left">Foswiki::Plugins::RenderPlugin</td><td align="left">&gt;=3644</td><td align="left">Required.</td></tr><tr><td align="left">Foswiki::Plugins::DBCachePlugin</td><td align="left">&gt;=4358</td><td align="left">Required.</td></tr><tr><td align="left">Foswiki::Plugins::ZonePlugin</td><td align="left">&gt;=1.0</td><td align="left">Required.</td></tr></table> |
|  Perl Version: | - |
|  Plugin Home: | http://foswiki.org/Extensions/%TOPIC% |
Topic attachments
I	Attachment	Action	Size	Date	Who	Comment
png	screenshot1.png	manage	50.9 K	08 Apr 2008 - 15:12	ProjectContributor
Topic revision: r3 - 28 Jan 2010, ProjectContributor
System
Copyright © by the contributing authors. All material on this site is the property of the contributing authors.
Ideas, requests, problems regarding Foswiki? Send feedback