---+!! !TinyMCEContrib
<!--
One line description, required for extensions repository catalog.
    * Set SHORTDESCRIPTION = Integration of the TinyMCE Wysiwym Editor
-->
%SHORTDESCRIPTION%

%TOC%
<img src="%ATTACHURLPATH%/tinymce.gif" alt="tinymce.gif" style="float:right" />
This is an integration of the !TinyMCE WYSIWYG editor. As well as being fast, the editor has one very attractive feature - search and replace.

The integration uses the TWiki:Plugins.WysiwygPlugin to translate text to and from a format that !TinyMCE can edit.

At this point the skin for the editor is *very* simple, and the editor is show with default buttons that probably don't work. %RED% It needs someone with knowledge of HTML and CSS to sit down and polish the integration. %ENDCOLOR%

*Caveat*: %TOPIC% is designed for editing TWiki topics, not as a general purpose HTML editor. It will work fine on topics that contain text, TML formatting, and most HTML. However, because of the complexity of transforming TML into HTML and back, complex TML, and mixing HTML and TML may not give the results you expect. You are recommended to use the standard browser textarea editor for editing existing topics that contain mixed HTML and TML, or complex %<nop>TML%-type variables.

---++ Installation Instructions

First follow the installation instructions to install the Contrib:

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

Like many other TWiki extensions, this module is shipped with a fully automatic installer script written using the Build<nop>Contrib.
   * If you have TWiki 4.1 or later, you can install from the =configure= interface (Go to Plugins->Find More Extensions)
      * The webserver user has to have permission to write to all areas of your installation for this to work.
   * If you have a permanent connection to the internet, you are recommended to use the automatic installer script
      * Just download the =TinyMCEContrib_installer= perl script and run it.
   * *Notes:*
      * The installer script will:
         * Automatically resolve dependencies,
         * Copy files into the right places in your local install (even if you have renamed data directories),
         * check in new versions of any installed files that have existing RCS histories files in your existing install (such as topics).
         * If the $TWIKI_PACKAGES environment variable is set to point to a directory, the installer will try to get archives from there. Otherwise it will try to download from twiki.org or cpan.org, as appropriate.
         * (Developers only: the script will look for twikiplugins/TinyMCEContrib/TinyMCEContrib.tgz before downloading from TWiki.org)
      * If you don't have a permanent connection, you can still use the automatic installer, by downloading all required TWiki archives to a local directory.
         * Point the environment variable =$TWIKI_PACKAGES= to this directory, and the installer script will look there first for required TWiki packages.
            * =$TWIKI_PACKAGES= is actually a path; you can list several directories separated by :
         * If you are behind a firewall that blocks access to CPAN, you can build a local CPAN mini-mirror, as described at http://twiki.org/cgi-bin/view/Codev/BuildingDakar#CPAN_local_minimirror
   * If you don't want to use the installer script, or have problems on your platform (e.g. you don't have Perl 5.8), then you can still install manually:
      1 Download and unpack one of the =.zip= or =.tgz= archives to a temporary directory.
      1 Manually copy the contents across to the relevant places in your TWiki installation.
      1 Check in any installed files that have existing =,v= files in your existing install (take care *not* to lock the files when you check in)
      1 Manually edit !LocalSite.cfg to set any configuration variables.
      1 Run =configure= and enable the module, if it is a plugin.
      1 Repeat from step 1 for any missing dependencies.


*Do not forget to enable the WysiwygPlugin in =configure= or it won't work*.

	* To enable the editor in one of your skins, add the following link to the skin alongside or in place of the existing 'edit' link:<br /><code>&lt;a href="%<nop>SCRIPTURLPATH%/edit%<nop>SCRIPTSUFFIX%/%<nop>WEB%/%<nop>TOPIC%?skin=tinymce"&gt;tinymce&lt;/a&gt;</code><br />As you can see this is just a standard edit link with the 'tinymce' skin in place of the usual edit skin. Here it is for this topic: <a href="%SCRIPTURLPATH%/edit%SCRIPTSUFFIX%/%WEB%/%TOPIC%?skin=tinymce">TinyMCE</a>. Try clicking on it, but _do not save_!

If you are using TWiki-4.0.0 or later with =pattern= skin, the =%<nop>COMPOSER%= global TWiki variable is used to control the skin used for the WYSIWYG editor link. You can define this variable to the empty string to disable WYSIWYG editing on a site, per-web, per-user or per-topic basis. Set =COMPOSER= to =tinymce= to enable this module.

---++ Contrib Info

|  Contrib Author(s): | TWiki:Main.CrawfordCurrie |
|  Contrib Version: | 0 (27 Feb 2007) |
|  Copyright: | &copy; 2007 WikiRing |
|  License: | [[http://www.gnu.org/licenses/gpl.html][GPL (Gnu General Public License)]] |
|  Change History: | <!-- versions below in reverse order -->&nbsp; |
|  Dependencies: | None |
|  Contrib Home: | http://twiki.org/cgi-bin/view/Plugins/TinyMCEContrib |
|  Feedback: | http://twiki.org/cgi-bin/view/Plugins/TinyMCEContribDev |
|  Appraisal: | http://twiki.org/cgi-bin/view/Plugins/TinyMCEContribAppraisal |

<!-- Do _not_ attempt to edit this topic; it is auto-generated. Please add comments/questions/remarks to the Dev topic instead. -->

%META:FILEATTACHMENT{name="tinymce.gif" attr="h" comment="screenshot"}%
