data/TWiki/WysiwygPlugin.txt
author Colas Nahaboo <colas@nahaboo.net>
Sat, 26 Jan 2008 15:50:53 +0100
changeset 0 414e01d06fd5
child 1 e2915a7cbdfa
permissions -rw-r--r--
RELEASE 4.2.0 freetown
     1 ---+!! Wysiwyg Plugin
     2 <!--
     3    * Set SHORTDESCRIPTION = Translator framework for Wysiwyg editors
     4 -->
     5 <!-- Do _not_ attempt to edit this topic; it is auto-generated. Please add comments/questions/remarks to the Dev topic instead. -->
     6 %SHORTDESCRIPTION%
     7 
     8 Support for the integration of WYSIWYG (What-You-See-Is-What-You-Get) editors. On its own, the only thing this plugin gives you is a stand-alone HTML to TWiki translator script. For WYSIWYG editing in TWiki, you will also need to install a specific editor package such as TWiki:Plugins.KupuEditorContrib or TWiki:Plugins.WikiwygContrib.
     9 
    10 This plugin provides a generic framework that supports editing of TWiki topics using any browser-based HTML editor. It works by transforming TML (TWiki Meta Language) into HTML for the editor, and then transforming HTML back into TML on save.
    11 
    12 %TOC%
    13 
    14 ---++ Features
    15 	* Supports the input of malformed HTML
    16 	* Full round-trip (TML -> XHTML -> TWiki syntax)
    17 	* Framework is editor-agnostic
    18 
    19 ---++ Details
    20 ---+++ What's in the package
    21 The package includes the following pieces:
    22 	* TML (TWiki syntax) to HTML translator
    23 	* HTML to TML translator (with stand-alone script)
    24 	* Generic TWiki plugin for automating the translation during editing
    25 
    26 ---+++ How it works
    27 The plugin works by translating the topic text into HTML when someone edits a topic. The HTML is then fed to the WYSIWYG editor. On save, the edited HTML is run through the reverse translation before saving to the topic. TWiki syntax is used in preference to HTML in the stored topic wherever possible, though HTML may be used if the translator can't find a suitable TML equivalent..
    28 
    29 The default rendering that TWiki uses to generate HTML for display in browsers is 'lossy' - information in the TWiki syntax is lost in the HTML output, and a round-trip (recovering the original TWiki syntax from the HTML) is impossible. To solve this problem the plugin instead uses its own translation of TWiki syntax to XHTML. The generated XHTML is annotated with CSS classes that support the accurate recovery of the original TWiki syntax.
    30 
    31 _Before you ask the obvious question, yes, the translator *could* be used to replace the TWiki rendering pipeline for generating HTML pages. In fact, the translator is taken almost directly from the implementation of the rendering pipeline for the TWiki-4 release_
    32 
    33 Translation of the HTML back to TWiki syntax uses the CPAN:HTML::Parser. This parser is used in preference to a more modern XML parser, because the WYSIWYG editor may not generate fully compliant XHTML. A strict parser would risk losing content. CPAN:HTML::Parser is better at handling malformed HTML.
    34 
    35 There is also the advantage that the translator can be used to *import* HTML from other sources - for example, existing web pages. Due to the simple nature of TWiki syntax and the potential complexity of web pages, this translation is often lossy - i.e there will be HTML features that can be entered by editors that will be lost in this translation step. This is especially noticeable with HTML tables.
    36 
    37 ---+++ Using the translators from Perl scripts
    38 
    39 Both translators can be used directly from Perl scripts, for example to build your own stand-alone translators.
    40 
    41 A stand-alone convertor script for HTML to TWiki is included in the installation. It can be found in =tools/html2tml.pl=.
    42 
    43 ---+++ Integrating a HTML Editor
    44 The plugin can be used to integrate an HTML editor in a number of different ways.
    45    1 The HTML for the content-to-be-edited can be generated directly in the standard edit template.
    46    1 The HTML for the content-to-be-edited can be generated directly in a specialised edit template.
    47    1 A URL can be used to fetch the content-to-be-edited from the server, for use in an IFRAME.
    48    1 REST handlers can be called from Javacript to convert content.
    49 
    50 ---++++ Generating content directly in the standard edit template
    51 This is the technique used by WYSIWYG editors that can sit on top of HTML
    52 textareas, such as !TinyMCE. The topic content is pre-converted to HTML before inclusion in the standard edit template. These editors use plugins that have a =beforeEditHandler= and an =afterEditHandler=. These handlers are responsible for the conversion of topic text to HTML, and post-conversion of HTML back to TML.
    53    1 User hits "edit".
    54    1 Editor-specific plugin =beforeEditHandler= converts topic content to HTML by calling =TWiki::Plugins::WysiwygPlugin::TranslateTML2HTML=.
    55    1 User edits and saves
    56    1 Editor-specific plugin =afterEditHandler= converts HTML back to TML by calling =TWiki::Plugins::WysiwygPlugin::TranslateHTML2TML=.
    57    * !WysiwygPlugin should *not* be enabled in =configure=.
    58    * =WYSIWYGPLUGIN_WYSIWYGSKIN= should *not* be set.
    59    * Your plugin should set the =textareas_hijacked= context id, to signal to skins to suppress their textarea manipulation functions.
    60 This is the recommended integration technique, if your editor can support it.
    61 
    62 ---++++ Generating content directly in a specialised edit template
    63 This technique is useful when the editor requires the topic content in a variety of different formats at the same time. In this scenario the editor uses a custom edit template. The WYSIWYG content is made available for instantiation in that template in a number of different formats. =WYSIWYGPLUGIN_WYSIWYGSKIN= *must* be set for this to work.
    64 
    65 The flow of control is as follows:
    66    1 User hits "edit" with the skin (or cover) set the same as =WYSIWYGPLUGIN_WYSIWYGSKIN=.
    67    1 The !WysiwygPlugin =beforeEditHandler= determines if the topic is WYSIWYG editable, and vetos the edit if not by redirecting to the standard edit skin.
    68  the edit
    69    1 The =edit= template containing the JS editor is instantiated.
    70    1 The following variables are available for expansion in the template:
    71       * =%<nop>WYSIWYG_TEXT%= expands to the HTML of the content-to-be-edited. This is suitable for use in a =textarea=.
    72       * =%<nop>JAVASCRIPT_TEXT%= expands to the HTML of the content-to-be-edited in a javascript constant.
    73    1 User edits and saves
    74    1 The =afterEditHandler= in the !WyswiygPlugin sees that =wysiwyg_edit= is set, which triggers the conversion back to TML.
    75 
    76    * The HTML form in the edit template *must* include an =&lt;input= called =wysiwyg_edit= and set it to 1, to trigger the conversion from HTML back to TML.
    77    * =WYSIWYGPLUGIN_WYSIWYGSKIN= must be set to the name of the skin used for WYSIWYG editing. This is usually the name of the editor e.g. =kupu=.
    78 
    79 ---++++ Fetching content from a URL
    80 In this scenario, the edit template is generated *without* the content-to-be-edited. The content is retrieved from the server using a URL e.g. from an =IFRAME=.
    81 
    82 The flow of control is as follows:
    83    1 As _Generating content directly in a specialised edit template_
    84    1 As _Generating content directly in a specialised edit template_
    85    1 As _Generating content directly in a specialised edit template_
    86    1 When the document loads in the browser, the JS editor invokes a content URL (using an =IFRAME= or a =XmlHttpRequest=) to obtain the HTML document to be edited
    87       * The content URL is just a TWiki =view= URL with the =wysiwyg_edit=
    88         parameter set.
    89       * The !WysiwygPlugin recognises the =wysiwyg_edit= parameter and uses the
    90         TML2HTML translator to prepare the text, which is then returned
    91         as =text/plain= to the browser.
    92       * Two TWiki variables, =%<nop>OWEB%= and %<nop>OTOPIC%=, can be used in the content URL in the edit template to refer to the source topic for the content.
    93    1 After edit handling is as for _Generating content directly in a specialised edit template_
    94 
    95 ---+++ Other techniques
    96 ---++++ Asynchronous saves
    97 Editors can use =XmlHttpRequest= to perform saves, by POSTing to the TWiki =save= script with the =wysiwyg_edit= parameter set to =1=. This parameter tells the =beforeSaveHandler= in the !WysiwygPlugin to convert the content back to TML. See %TWIKIWEB%.TWikiScripts for details of the other parameters to the =save= script.
    98 
    99 Once the save script has completed it responds with a redirect, either to an Oops page if the save failed, or to the appropriate post-save URL (usually a =view=). The editor must be ready to handle this redirect.
   100 
   101 ---++++ Handling Attachments
   102 Attachment uploads can be handled by URL requests from the editor template to the TWiki
   103 =upload= script. The =upload= script normally redirects to the containing topic; a behaviour that you usually don't want in an editor! There are two ways to handle this:
   104    * If the uploads are done in an =IFRAME= or via =XmlHttpRequest=, then the
   105      302 redirect at the end of the upload can simply be ignored.
   106    * You can pass =noredirect= to the =upload= script to suppress the redirect. In this case
   107      you will get a =text/plain= response of =OK= followed by a message if everything went well, or an error message if it did not.
   108 
   109 ---++++ REST handlers
   110 If you are confident in Javascript you can use REST handlers with =XmlHttpRequest= to convert content from TML to HTML and back again.
   111 
   112 The plugin defines the following REST handlers:
   113 
   114 =.../rest/WysiwygPlugin/html2tml?topic=Web.Topic;text=htmltexttotranslate=
   115 
   116 Converts the HTML text to TML. =topic= *must* be specified.
   117 
   118 =.../rest/WysiwygPlugin/tml2html?topic=Web.Topic;text=tmltexttotranslate=
   119 
   120 Converts the TML text to HTML. =topic= *must* be specified. The response is a =text/plain= page of converted content.
   121 
   122 ---++ Plugin Installation Instructions
   123 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.
   124 
   125 Like many other TWiki extensions, this module is shipped with a fully
   126 automatic installer script written using the Build<nop>Contrib.
   127    * If you have TWiki 4.2 or later, you can install from the =configure= interface (Go to Plugins->Find More Extensions)
   128       * See the [[http://twiki.org/cgi-bin/view/Plugins/BuildContribInstallationSupplement][installation supplement]] on TWiki.org for more information.
   129    * If you have any problems, then you can still install manually from the command-line:
   130       1 Download one of the =.zip= or =.tgz= archives
   131       1 Unpack the archive in the root directory of your TWiki installation.
   132       1 Run the installer script ( =perl &lt;module&gt;_installer= )
   133       1 Run =configure= and enable the module, if it is a plugin.
   134       1 Repeat for any missing dependencies.
   135    * If you are *still* having problems, then instead of running the installer script:
   136       1 Make sure that the file permissions allow the webserver user to access all files.
   137       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)
   138       1 Manually edit !LocalSite.cfg to set any configuration variables.
   139 
   140 %IF{"defined 'SYSTEMWEB'" else="<div class='twikiAlert'>%X% WARNING: SYSTEMWEB is not defined in this TWiki. Please add these definitions to your %MAINWEB%.TWikiPreferences, if they are not already there:<br><pre>   * <nop>Set SYSTEMWEB = %<nop>TWIKIWEB%<br>   * <nop>Set USERSWEB = %<nop>MAINWEB%</pre></div>"}%
   141 
   142 
   143 ---++ Plugin Configuration Settings
   144 
   145 ---+++ Translator control
   146 %INCLUDE{"%TWIKIWEB%.WysiwygPluginSettings"}%
   147 
   148 *Implementors note* if you are using your own before/after edit handlers, you can call =TWiki::Plugins::WysiwygPlugin::isWysiwygEditable()= to check these controls.
   149 
   150 ---++ Known issues
   151 
   152 ---+++ Incompatible with "non-standard" syntax
   153 WysiwygPlugin is incompatible with plugins that expand non-standard syntax e.g. TWiki:Plugins.MathModePlugin (WysiwygPlugin)
   154 
   155 Plugins that extend the syntax using TWiki variables, such as =%MYVARIABLE%=, should work fine.
   156 
   157 ---+++ Overlapping styles
   158 Because TWiki uses a "best guess" approach to some formatting, it allows overlapping of tags in a way forbidden by HTML, and it is impossible to guarantee 100% that formating in the original TWiki document will still be there when the same document is loaded and then saved through the WysiwygPlugin. The most obvious case of this is to do with styles. For example, the sentence
   159 <verbatim>
   160 *bold _bold-italic* italic_
   161 </verbatim>
   162 is legal in TML, but in HTML is represented by
   163 <verbatim>
   164 <strong>bold <em>bold-italic</em></strong> <em>italic</em>
   165 </verbatim>
   166 which gets translated back to TML as
   167 <verbatim>
   168 *bold _bold-italic_* _italic_
   169 </verbatim>
   170 which is correct by construction, but does not render correctly in TWiki. This problem is unfortunately unavoidable due to the way TWiki syntax works.
   171 
   172 ---++ Plugin Info
   173 
   174 This plugin is brought to you by a [[http://wikiring.com][WikiRing <a href="http://wikiring.com"><img src="%ATTACHURLPATH%/wikiringlogo20x20.png" title="WikiRing: Professional Wiki Innovation and Support" /></a>]] partner - working together to improve your wiki experience!
   175 
   176 Many thanks to the following sponsors for supporting this work:
   177    * [[http://ilog.fr][ILOG]]
   178    * [[http://www.carrier.com][Carrier Corporation]]
   179    * [[http://twiki.net][TWIKI.NET]]
   180 
   181 |  Plugin Authors: | TWiki:Main.CrawfordCurrie http://www.c-dot.co.uk |
   182 |  Copyright | &copy; ILOG 2005 http://www.ilog.fr |
   183 |  License | [[http://www.gnu.org/licenses/gpl.html][GPL (Gnu General Public License)]] |
   184 |  Plugin Version: | 16174 (22 Jan 2008) |
   185 |  Change History: | |
   186 |  20 Dec 2007 | TWikibug:Item5022: made TT font size same as verbatim. Had to add a new style to do it, as TMCE didn't want to play with TT or CODE tags. TWikibug:Item5138: post-conversion of 8-bit entities to characters to aid searching etc. |
   187 | 19 Dec 2007 | TWikibug:Item4836: make the parser tolerant of META, so pasting OO docs works TWikibug:Item4969: autoclose BR and HR tags TWikibug:Item5132: fixed IMG tags TWikibug:Item5076: fixed line-sensitive TML embedded in tables |
   188 |  8 Nov 2007 | TWikibug:Item4923: fixed blocking of table conversion due to empty attributes TWikibug:Item4936: An em embedded in an em was getting eaten TWikibug:Item4817: added typewriter text button TWikibug:Item4850: added font colour controls TWikibug:Item4645: added REST handlers for upload and fetching lists of attachments |
   189 |  2 Nov 2007 | TWikibug:Item4903: corrected over-enthusiastive interpretation of ! as an escape |
   190 |  21 Oct 2007 | TWikibug:Item4788: fixed unbalanced protect, which could cause loss of protected status TWikibug:Item4811: noautolink *looks* like an HTML construct but in fact is not; the tag is infact an "on-off" switch and does not imply any HTML structure, so cannot be converted to a DIV or a span, so has to be removed. TWikibug:Item4747: added &lt;sticky&gt; to try to overcome limitations in translation TWikibug:Item4831: added increased flexibility in deciding what HTML get converted to TML, and what does not. Analysed all the HTML4 tags to establish initial settings. TWikibug:Item4847: don't call non-existent function with older HTML::Parser releases TWikibug:Item4844: Saving a table from IE didn't convert it back to TML TWikibug:Item4855: table rows generated from TWiki variables were being eaten |
   191 |  6 Oct 2007 | TWikibug:Item4700: fixed colspans TWikibug:Item4701: removed extra line between %TABLE and the table TWikibug:Item4705: fixed spacing around literal and verbatim blocks TWikibug:Item4706: merge adjacent verbatim blocks separated only by whitespace TWikibug:Item4712: fixed eating of noautolink and literal TWikibug:Item4763: list items spanning multiple lines fixed TWikibug:Item4867: released tml2html |
   192 |  17 Sep 2007 | TWikibug:Item4647: TWikibug:Item4652: problems related to DIV fixed. TWikibug:Item4653: fixed multi-line twiki variables |
   193 |  16 Sep 2007 | TWikibug:Item4630: polished up the way the secret string is done, to ensure synch between perl and JS. Item4622: added UTF-8 handling steps that fixup malformed UTF8 strings before presenting them to the editor (saves Moz) and stops the editor passing them back to TWiki (saves IE). Removed extra entity decoding steps that were causing problems. TWikibug:Item4629: fixed issues with verbatim, highlighted by previous mangling of this topic |
   194 |  13 Sep 2007 | TWikibug:Item4613 cleaned up spurious message when navigating away TWikibug:Item4615 fixed incorrect rendering of emphasis next to br |
   195 |  12 Sep 2007 | TWikibug:Item4604 Fixes to REST handler, and add ability to trigger HTML2TML conversion from a content comment alone (required for some editors) TWikibug:Item4588 fixes to conversion of double-character emphases |
   196 |  7 Sep 2007 | TWikibug:Item4503 excess empty lines TWikibug:Item4486 no toc headers with unofficial syntax TWikibug:Item4560: empty lines lost TWikibug:Item4566: corrupted table on save TWikibug:Item4550 section tags being eaten |
   197 |  4 Sep 2007 | TWikibug:Item4534 TWikibug:Item4535 fixed |
   198 | See Subversion logs for earlier revisions ||
   199 |  Dependencies: | <table border="1"><tr><th>Name</th><th>Version</th><th>Description</th></tr><tr><td align="left">HTML::Parser</td><td align="left">&gt;=3.28</td><td align="left">Required. Available from [[http://cpan.uwinnipeg.ca/search?query=HTML%3A%3AParser&mode=dist][CPAN]].</td></tr><tr><td align="left">HTML::Entities</td><td align="left">&gt;=1.25</td><td align="left">Required. Available from [[http://cpan.uwinnipeg.ca/search?query=HTML%3A%3AEntities&mode=dist][CPAN]].</td></tr></table> |
   200 |  Plugin Home: | http://twiki.org/cgi-bin/view/Plugins/%TOPIC% |
   201 |  Feedback: | TWiki:Plugins/%TOPIC%Dev |
   202 |  Appraisal: | http://twiki.org/cgi-bin/view/Plugins/%TOPIC%Appraisal |
   203 
   204 __Related Topics:__ %TWIKIWEB%.TWikiPreferences, %TWIKIWEB%.TWikiPlugins
   205 
   206 <!-- Do _not_ attempt to edit this topic; it is auto-generated. Please add comments/questions/remarks to the Dev topic instead. -->
   207 
   208 %META:FILEATTACHMENT{name="wikiringlogo20x20.png" attr="h" comment="" version="1"}%