buildrelease
[openafs-wiki.git] / TWiki / WysiwygPlugin.mdwn
1 # <a name="Wysiwyg Plugin"></a><a name=" Wysiwyg Plugin"></a> Wysiwyg Plugin
2
3 %SHORTDESCRIPTION%
4
5 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.
6
7 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.
8
9 <div>
10   <ul>
11     <li><a href="#Features"> Features</a></li>
12     <li><a href="#Details"> Details</a><ul>
13         <li><a href="#What's in the package"> What's in the package</a></li>
14         <li><a href="#How it works"> How it works</a></li>
15         <li><a href="#Using the translators from Perl"> Using the translators from Perl scripts</a></li>
16         <li><a href="#Integrating a Wysiwyg Editor"> Integrating a Wysiwyg Editor</a><ul>
17             <li><a href="#Getting content in the edit temp"> Getting content in the edit template</a></li>
18             <li><a href="#Fetching content from a URL"> Fetching content from a URL</a></li>
19           </ul>
20         </li>
21         <li><a href="#Handling Saves"> Handling Saves</a><ul>
22             <li><a href="#Handling Attachments"> Handling Attachments</a></li>
23           </ul>
24         </li>
25       </ul>
26     </li>
27     <li><a href="#Plugin Installation Instructions"> Plugin Installation Instructions</a></li>
28     <li><a href="#Plugin Configuration Settings"> Plugin Configuration Settings</a><ul>
29         <li><a href="#Translator control"> Translator control</a></li>
30       </ul>
31     </li>
32     <li><a href="#Known issues"> Known issues</a><ul>
33         <li><a href="#Incompatible with "non-standard""> Incompatible with "non-standard" syntax</a></li>
34         <li><a href="#Overlapping styles"> Overlapping styles</a></li>
35       </ul>
36     </li>
37     <li><a href="#Plugin Info"> Plugin Info</a></li>
38   </ul>
39 </div>
40
41 ## <a name="Features"></a> Features
42
43 - Supports the input of malformed HTML
44 - Full round-trip (TML -&gt; XHTML -&gt; TWiki syntax)
45 - Framework is editor-agnostic
46
47 ## <a name="Details"></a> Details
48
49 ### <a name="What&#39;s in the package"></a> What's in the package
50
51 The package includes the following pieces:
52
53 - TML (TWiki syntax) to HTML translator
54 - HTML to TML translator (with stand-alone script)
55 - Generic TWiki plugin for automating the translation during editing
56
57 ### <a name="How it works"></a> How it works
58
59 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..
60
61 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 pure XHTML. The generated XHTML is annotated with CSS classes that support the accurate recovery of the original TWiki syntax.
62
63 _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_
64
65 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 HTML may not generate fully compliant XHTML. A strict parser would risk losing content. CPAN:HTML::Parser is better at handling malformed HTML.
66
67 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.
68
69 ### <a name="Using the translators from Perl"></a><a name="Using the translators from Perl "></a> Using the translators from Perl scripts
70
71 Both translators can be used directly from Perl scripts, for example to build your own stand-alone translators.
72
73 A stand-alone convertor script for HTML to TWiki is included in the installation. It can be found in the top-level `tools` directory and is called `html2tml.pl`.
74
75 ### <a name="Integrating a Wysiwyg Editor"></a> Integrating a Wysiwyg Editor
76
77 The plugin can be used to generate HTML for an editor in two ways; first, by generating the HTML for the content-to-be-edited directly in the edit template, and second, through a URL that can be used to fetch the content-to-be-edited from the server.
78
79 #### <a name="Getting content in the edit temp"></a> Getting content in the edit template
80
81 This is the scenario used by the standard TWiki text editor, except that the text is pre-converted to HTML before inclusion in the template.
82
83 The flow of control is as follows:
84
85 1. User hits "edit".
86 2. The `beforeEditHandler` filters the edit, blocking any attempt to edit restricted content
87 3. The `edit` template containing the JS editor is instantiated. The following variables are available for expansion in the template:
88   - `%WYSIWYG_TEXT%` expands to the HTML of the content-to-be-edited. This is suitable for use in a `textarea`.
89   - `%JAVASCRIPT_TEXT%` expands to the HTML of the content-to-be-edited in a javascript constant.
90
91 `WYSIWYGPLUGIN_WYSIWYGSKIN` **must** be set for this to work.
92
93 #### <a name="Fetching content from a URL"></a> Fetching content from a URL
94
95 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` or using a `XmlHttpRequest`.
96
97 The flow of control is as follows:
98
99 1. User hits "edit".
100 2. If the current skin = `WYWIWYGPLUGIN_WYWIWYGSKIN`, the `beforeEditHandler` filters the edit, blocking any attempt to edit restricted content.
101 3. The `edit` template containing the JS editor is instantiated.
102 4. JS editor invokes content URL to obtain the HTML document to be edited
103   - The content URL is just a TWiki `view` URL with the `wysiwyg_edit` parameter set.
104   - The plugin recognises the `wysiwyg_edit` parameter and uses the [[TML2HTML]] translator to prepare the text, which is then returned as `text/plain` to the browser.
105   - Two TWiki variables, `%OWEB%` and %OTOPIC%=, should be used in the content URL to refer to the source topic for the content.
106
107 ### <a name="Handling Saves"></a> Handling Saves
108
109 Saves are invoked by the editor POSTing to the TWiki `save` script with the `wysiwyg_edit` parameter set to `1`. This parameter tells the `beforeSaveHandler` in the plugin to convert the HTML back to TML. See [[TWikiScripts]] for details of the other parameters to the `save` script.
110
111 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.
112
113 #### <a name="Handling Attachments"></a> Handling Attachments
114
115 Attachment uploads can be handled by URL requests from the editor to the TWiki `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:
116
117 - If the uploads are done in an `IFRAME` or via `XmlHttpRequest`, then the 302 redirect at the end of the upload can simply be ignored.
118 - You can pass `noredirect` to the `upload` script to suppress the redirect. In this case 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.
119
120 ## <a name="Plugin Installation Instructions"></a> Plugin Installation Instructions
121
122 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.
123
124 Like many other TWiki extensions, this module is shipped with a fully automatic installer script written using the BuildContrib.
125
126 - If you have TWiki 4.1 or later, and Perl 5.8, you can install from the `configure` interface (Go to Plugins-&gt;Find More Extensions)
127   - The webserver user has to have permission to write to all areas of your installation for this to work.
128 - If you have a permanent connection to the internet (and Perl 5.8), you are recommended to use the automatic installer script
129   - Just download the `WysiwygPlugin_installer` perl script and run it.
130 - **Notes:**
131   - The installer script will:
132     - Automatically resolve dependencies,
133     - Copy files into the right places in your local install (even if you have renamed data directories),
134     - check in new versions of any installed files that have existing RCS histories files in your existing install (such as topics).
135     - 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.
136     - (Developers only: the script will look for twikiplugins/WysiwygPlugin/WysiwygPlugin.tgz before downloading from TWiki.org)
137   - 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.
138     - Point the environment variable `$TWIKI_PACKAGES` to this directory, and the installer script will look there first for required TWiki packages.
139       - `$TWIKI_PACKAGES` is actually a path; you can list several directories separated by :
140     - 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](http://twiki.org/cgi-bin/view/Codev/BuildingDakar#CPAN_local_minimirror)
141 - 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:
142   1. Download and unpack one of the `.zip` or `.tgz` archives to a temporary directory.
143   2. Manually copy the contents across to the relevant places in your TWiki installation.
144   3. 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)
145   4. Manually edit LocalSite.cfg to set any configuration variables.
146   5. Run `configure` and enable the module, if it is a plugin.
147   6. Repeat from step 1 for any missing dependencies.
148
149 ## <a name="Plugin Configuration Settings"></a> Plugin Configuration Settings
150
151 ### <a name="Translator control"></a> Translator control
152
153 For any of the following controls to work, you must tell %TOPIC% the name of the skin being used to invoke the Wysiwyg editor, for example `kupu` or `wikiwyg`.
154
155 - Set WYSIWYGSKIN =
156
157 Note that is can be set differently in different areas by defining `WYSWIYGPLUGIN_WYSIWYGSKIN` locally (e.g. in WebPreferences).
158
159 The **global** TWiki Variable `WYSIWYG_EXCLUDE` can be set to make the plugin sensitive to what is in a topic before allowing it to be edited. You can set it up to refuse to edit if
160
161 - some or all of HTML tags (e.g. `<br />` or `<div>`), or
162 - simple variables (e.g. `%VAR%`) or
163 - calls (e.g. `%VARIABLE{...}%`)
164 - PRE blocks (`<pre>`)
165 - HTML comments (`<!--` ... `-->`)
166
167 are used in the topic. If the plugin detects an excluded construct in the topic, it will redirect to the default editor. Comma-separated list of one or more of `html`, `variables`, `calls`, `pre` or `comments` e.g.
168
169 - Set WYSIWYG\_EXCLUDE = calls,html
170
171 Set `WYSIWYG_EXCLUDE` in [[TWikiPreferences]], or in [[WebPreferences]] for each web.
172
173 If you excluded `calls` in `WYSIWYG_EXCLUDE`, you can still define a subset of TWiki variables that do **not** block edits. this is done in the **global** preference variable `WYSIWYG_EDITABLE_CALLS`, which should be a list of TWiki variable names separated by vertical bars, with no spaces, e.g:
174
175 - Set WYSIWYG\_EDITABLE\_CALLS = COMMENT|CALENDAR|INCLUDE
176
177 ## <a name="Known issues"></a> Known issues
178
179 ### <a name="Incompatible with &quot;non-standard&quot;"></a> Incompatible with "non-standard" syntax
180
181 [[WysiwygPlugin]] is incompatible with plugins that expand non-standard syntax e.g. TWiki:Plugins.MathModePlugin ([[WysiwygPlugin]])
182
183 Plugins that extend the syntax using TWiki variables, such as `%MYVARIABLE%`, should work fine.
184
185 ### <a name="Overlapping styles"></a> Overlapping styles
186
187 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
188
189     *bold _bold-italic* italic_
190
191 is legal in TML, but in HTML is represented by
192
193     <strong>bold <em>bold-italic</em></strong> <em>italic</em>
194
195 which gets translated back to TML as
196
197     *bold _bold-italic_* _italic_
198
199 which is correct by construction, but does not render correctly in TWiki. This problem is unfortunately unavoidable due to the way TWiki syntax works.
200
201 ## <a name="Plugin Info"></a> Plugin Info
202
203 <table border="1" cellpadding="0" cellspacing="0">
204   <tr>
205     <td align="right"> Plugin Authors: </td>
206     <td> TWiki:Main.CrawfordCurrie <a href="http://www.c-dot.co.uk" target="_top">http://www.c-dot.co.uk</a></td>
207   </tr>
208   <tr>
209     <td align="right"> Copyright </td>
210     <td> Â© ILOG 2005 <a href="http://www.ilog.fr" target="_top">http://www.ilog.fr</a></td>
211   </tr>
212   <tr>
213     <td align="right"> License </td>
214     <td><a href="http://www.gnu.org/licenses/gpl.html" target="_top">GPL (Gnu General Public License)</a></td>
215   </tr>
216   <tr>
217     <td align="right"> Plugin Version: </td>
218     <td> 12422 </td>
219   </tr>
220   <tr>
221     <td align="right"> Change History: </td>
222     <td> Â  </td>
223   </tr>
224   <tr>
225     <td align="right"> 12422 </td>
226     <td> Added JAVASCRIPT_TEXT to support editors that require topic text in a JS var </td>
227   </tr>
228   <tr>
229     <td align="right"> 12161 </td>
230     <td> Added support for embedded editable HTML in the edit template </td>
231   </tr>
232   <tr>
233     <td align="right"> 12119 </td>
234     <td> Split into [[Main/WysiwygPlugin]] and [[Main/KupuContrib]]</td>
235   </tr>
236   <tr>
237     <td align="right"> 11538 </td>
238     <td> Minor doc updates, minor fixes to spacing in lists, integrated Koen Marten's template topic patch </td>
239   </tr>
240   <tr>
241     <td align="right"> 9671 </td>
242     <td><a href="http://develop.twiki.org/~develop/cgi-bin/view/Bugs/Item2025" rel="nofollow">Item2025</a> corrected handling of SPAN and FONT tags used for colour changes </td>
243   </tr>
244   <tr>
245     <td align="right"> 9566 </td>
246     <td><a href="http://develop.twiki.org/~develop/cgi-bin/view/Bugs/Item1890" rel="nofollow">Item1890</a> doc update </td>
247   </tr>
248   <tr>
249     <td align="right"> 9565 </td>
250     <td><a href="http://develop.twiki.org/~develop/cgi-bin/view/Bugs/Item1890" rel="nofollow">Item1890</a> <a href="http://develop.twiki.org/~develop/cgi-bin/view/Bugs/Item1041" rel="nofollow">Item1041</a> <a href="http://develop.twiki.org/~develop/cgi-bin/view/Bugs/Item944" rel="nofollow">Item944</a> Much more aggressive cleanup of HTML pasted in from external sources. Excessively verbose HTML (e.g. from Outlook) was causing apparent infinite looing behaviour. </td>
251   </tr>
252   <tr>
253     <td align="right"> 8867 </td>
254     <td><a href="http://develop.twiki.org/~develop/cgi-bin/view/Bugs/Item1176" rel="nofollow">Item1176</a> commented out Cairo version of header handler </td>
255   </tr>
256   <tr>
257     <td align="right"> 8780 </td>
258     <td><a href="http://develop.twiki.org/~develop/cgi-bin/view/Bugs/Item1625" rel="nofollow">Item1625</a> disable expansion of twiki variables in urls where there are other twiki variables that can't be expanded </td>
259   </tr>
260   <tr>
261     <td align="right"> 8779 </td>
262     <td><a href="http://develop.twiki.org/~develop/cgi-bin/view/Bugs/Item1530" rel="nofollow">Item1530</a> support for templatetopic when editing new topics </td>
263   </tr>
264   <tr>
265     <td align="right"> 8592 </td>
266     <td><a href="http://develop.twiki.org/~develop/cgi-bin/view/Bugs/Item1532" rel="nofollow">Item1532</a> [[Main/WysiwygPlugin]]: Added two more do-not-edit-if-topic-contains parameters, pre+comments </td>
267   </tr>
268   <tr>
269     <td align="right"> 8590 </td>
270     <td><a href="http://develop.twiki.org/~develop/cgi-bin/view/Bugs/Item1532" rel="nofollow">Item1532</a> [[Main/WysiwygPlugin]]: Kenneths suggestion on proper handling of HTML comments (incl. change to kupu) </td>
271   </tr>
272   <tr>
273     <td align="right"> 8572 </td>
274     <td><a href="http://develop.twiki.org/~develop/cgi-bin/view/Bugs/Item1529" rel="nofollow">Item1529</a> evil, evil. The XMLSerializer in IE isn't happy serializing the DOM. I have no idea why. Kupu manages to get away with this because it passes the DOM through the XML validator, which I had to disable because it strips comments. So, for now, the IE implementation will strip comments - but at least you can save again </td>
275   </tr>
276   <tr>
277     <td align="right"> 8538 </td>
278     <td><a href="http://develop.twiki.org/~develop/cgi-bin/view/Bugs/Item1501" rel="nofollow">Item1501</a> table handling was a bit spazzy. Several problems fixed. </td>
279   </tr>
280   <tr>
281     <td align="right"> 8535 </td>
282     <td><a href="http://develop.twiki.org/~develop/cgi-bin/view/Bugs/Item1518" rel="nofollow">Item1518</a> moved icon and string lists into topics, updated screenshot </td>
283   </tr>
284   <tr>
285     <td align="right"> 8531 </td>
286     <td><a href="http://develop.twiki.org/~develop/cgi-bin/view/Bugs/Item1392" rel="nofollow">Item1392</a> reversed the sense of the navigate-away condition, again </td>
287   </tr>
288   <tr>
289     <td align="right"> 8466 </td>
290     <td><a href="http://develop.twiki.org/~develop/cgi-bin/view/Bugs/Item1486" rel="nofollow">Item1486</a> added WYSIWYG_EXCLUDE to allow exclusion of 'uneditable' content </td>
291   </tr>
292   <tr>
293     <td align="right"> 8463 </td>
294     <td><a href="http://develop.twiki.org/~develop/cgi-bin/view/Bugs/Item1486" rel="nofollow">Item1486</a> was stripping comments, wrongly. Had to disable the kupu filters completely, they just do too much damage. </td>
295   </tr>
296   <tr>
297     <td align="right"> 8401 </td>
298     <td><a href="http://develop.twiki.org/~develop/cgi-bin/view/Bugs/Item1457" rel="nofollow">Item1457</a> corrected problem with bullet list at top of topic </td>
299   </tr>
300   <tr>
301     <td align="right"> 8388 </td>
302     <td><a href="http://develop.twiki.org/~develop/cgi-bin/view/Bugs/Item1445" rel="nofollow">Item1445</a> fix for a javascript error, introduced by previous fix </td>
303   </tr>
304   <tr>
305     <td align="right"> 8387 </td>
306     <td><a href="http://develop.twiki.org/~develop/cgi-bin/view/Bugs/Item1445" rel="nofollow">Item1445</a> small usability improvements </td>
307   </tr>
308   <tr>
309     <td align="right"> 8334 </td>
310     <td><a href="http://develop.twiki.org/~develop/cgi-bin/view/Bugs/Item663" rel="nofollow">Item663</a> TWiki.org doc merge: Fix incorrect link to kupu website </td>
311   </tr>
312   <tr>
313     <td align="right"> 8327 </td>
314     <td><a href="http://develop.twiki.org/~develop/cgi-bin/view/Bugs/Item1411" rel="nofollow">Item1411</a> handle case of the result of a TWiki variable being nopped </td>
315   </tr>
316   <tr>
317     <td align="right"> 8312 </td>
318     <td><a href="http://develop.twiki.org/~develop/cgi-bin/view/Bugs/Item1317" rel="nofollow">Item1317</a> wrong result returned from generation function when expanding HTML embedded in verbatim block </td>
319   </tr>
320   <tr>
321     <td align="right"> 8301 </td>
322     <td><a href="http://develop.twiki.org/~develop/cgi-bin/view/Bugs/Item1397" rel="nofollow">Item1397</a> removed excess space after sqaub links </td>
323   </tr>
324   <tr>
325     <td align="right"> 8300 </td>
326     <td><a href="http://develop.twiki.org/~develop/cgi-bin/view/Bugs/Item1231" rel="nofollow">Item1231</a> added %SPAN% to indicate a spanned-over cell in the editor. Improved handling of HTML in verbatim tags by inserting line breaks is the tag type calls for it, before removing the HTML. </td>
327   </tr>
328   <tr>
329     <td align="right"> 8276 </td>
330     <td><a href="http://develop.twiki.org/~develop/cgi-bin/view/Bugs/Item1215" rel="nofollow">Item1215</a> added WYSIWYG_ICONS and WYSIWYG_TAGS to support user customisation of icon images and twiki variables that can be inserted </td>
331   </tr>
332   <tr>
333     <td align="right"> 8274 </td>
334     <td><a href="http://develop.twiki.org/~develop/cgi-bin/view/Bugs/Item1314" rel="nofollow">Item1314</a> debugging in case the hang happens again; and made sure to default the editor just in case </td>
335   </tr>
336   <tr>
337     <td align="right"> 8273 </td>
338     <td><a href="http://develop.twiki.org/~develop/cgi-bin/view/Bugs/Item1315" rel="nofollow">Item1315</a> short forms must be terminated by one of the same characters that terminate wikiwords </td>
339   </tr>
340   <tr>
341     <td align="right"> 8272 </td>
342     <td><a href="http://develop.twiki.org/~develop/cgi-bin/view/Bugs/Item1391" rel="nofollow">Item1391</a> added special interpretation of IMG tags to expand selected TWiki variables within SRC attributes </td>
343   </tr>
344   <tr>
345     <td align="right"> 8271 </td>
346     <td><a href="http://develop.twiki.org/~develop/cgi-bin/view/Bugs/Item1340" rel="nofollow">Item1340</a> refined handling of NOP to cover abbrevs </td>
347   </tr>
348   <tr>
349     <td align="right"> 8270 </td>
350     <td><a href="http://develop.twiki.org/~develop/cgi-bin/view/Bugs/Item1311" rel="nofollow">Item1311</a> removed excess space inserted in headings </td>
351   </tr>
352   <tr>
353     <td align="right"> 8269 </td>
354     <td><a href="http://develop.twiki.org/~develop/cgi-bin/view/Bugs/Item1339" rel="nofollow">Item1339</a> changed from using arbitrary attribute for notoc to a new CSS class. Arbitrary attributes are stripped by Kupu before save. </td>
355   </tr>
356   <tr>
357     <td align="right"> 8268 </td>
358     <td><a href="http://develop.twiki.org/~develop/cgi-bin/view/Bugs/Item1344" rel="nofollow">Item1344</a> strip ^Ms inserted by Sarissa during serialisation on IE </td>
359   </tr>
360   <tr>
361     <td align="right"> 8267 </td>
362     <td><a href="http://develop.twiki.org/~develop/cgi-bin/view/Bugs/Item1394" rel="nofollow">Item1394</a> still can't get text styles to work properly in IE; but I am now firmly of the opinion that the fault lies with the browser, and not with Kupu. </td>
363   </tr>
364   <tr>
365     <td align="right"> 8232 </td>
366     <td><a href="http://develop.twiki.org/~develop/cgi-bin/view/Bugs/Item1341" rel="nofollow">Item1341</a> added appropriate CSS class </td>
367   </tr>
368   <tr>
369     <td align="right"> 8152 </td>
370     <td><a href="http://develop.twiki.org/~develop/cgi-bin/view/Bugs/Item1313" rel="nofollow">Item1313</a> added caveat about editing complex HTML and mixed HTML-TML </td>
371   </tr>
372   <tr>
373     <td align="right"> 8151 </td>
374     <td><a href="http://develop.twiki.org/~develop/cgi-bin/view/Bugs/Item1334" rel="nofollow">Item1334</a> headers not handled properly in Cairo version </td>
375   </tr>
376   <tr>
377     <td align="right"> 8108 </td>
378     <td><a href="http://develop.twiki.org/~develop/cgi-bin/view/Bugs/Item1318" rel="nofollow">Item1318</a> corrected table/list parser for tables embedded in bulleted lists </td>
379   </tr>
380   <tr>
381     <td align="right"> 8106 </td>
382     <td><a href="http://develop.twiki.org/~develop/cgi-bin/view/Bugs/Item1310" rel="nofollow">Item1310</a> support for &lt;nop/&gt; </td>
383   </tr>
384   <tr>
385     <td align="right"> 8105 </td>
386     <td><a href="http://develop.twiki.org/~develop/cgi-bin/view/Bugs/Item1317" rel="nofollow">Item1317</a> support for limited case of nopped variable </td>
387   </tr>
388   <tr>
389     <td align="right"> 8104 </td>
390     <td><a href="http://develop.twiki.org/~develop/cgi-bin/view/Bugs/Item1320" rel="nofollow">Item1320</a> corrected interpretation of relative URL path in [[]] </td>
391   </tr>
392   <tr>
393     <td align="right"> 8091 </td>
394     <td><a href="http://develop.twiki.org/~develop/cgi-bin/view/Bugs/Item1259" rel="nofollow">Item1259</a> changed comment handling; rather than trying to create HTML, which gets munged, create an HTML comment. This will only be editable by switching to source view, but hey, it's supposed to be WYSIWYG. Note that this also means that comments in pasted HTML should be retained now </td>
395   </tr>
396   <tr>
397     <td align="right"> 8063 </td>
398     <td><a href="http://develop.twiki.org/~develop/cgi-bin/view/Bugs/Item1042" rel="nofollow">Item1042</a> spec of SCRIPTURL changed </td>
399   </tr>
400   <tr>
401     <td align="right"> 7904 </td>
402     <td><a href="http://develop.twiki.org/~develop/cgi-bin/view/Bugs/Item1189" rel="nofollow">Item1189</a> reverting accidental checkin of experimental code </td>
403   </tr>
404   <tr>
405     <td align="right"> 7903 </td>
406     <td><a href="http://develop.twiki.org/~develop/cgi-bin/view/Bugs/Item1189" rel="nofollow">Item1189</a> filter whitelist is not good enough; need to generate B and I nodes. templates/ pub/TWiki/WysiwygPlugin </td>
407   </tr>
408   <tr>
409     <td align="right"> 7902 </td>
410     <td><a href="http://develop.twiki.org/~develop/cgi-bin/view/Bugs/Item1189" rel="nofollow">Item1189</a> it took bloody ages to track down, but finally discovered that bold and italic were being filtered out of spans by Kupu 1.3.2.... too smart for it's own good. So added them to the filter whitelist, and it works again. </td>
411   </tr>
412   <tr>
413     <td align="right"> 7873 </td>
414     <td><a href="http://develop.twiki.org/~develop/cgi-bin/view/Bugs/Item1189" rel="nofollow">Item1189</a> added pre save filter to try and find where the attributes are disappearing to in FF </td>
415   </tr>
416   <tr>
417     <td align="right"> 7872 </td>
418     <td><a href="http://develop.twiki.org/~develop/cgi-bin/view/Bugs/Item1187" rel="nofollow">Item1187</a> for lack of an s on an RE, the nation was lost (well, the multi-line comment actually). Thanks Kenneth! </td>
419   </tr>
420   <tr>
421     <td align="right"> 7871 </td>
422     <td><a href="http://develop.twiki.org/~develop/cgi-bin/view/Bugs/Item859" rel="nofollow">Item859</a> solved issue with non-display of inserted images. Was due to the use of an onSubmit handler to close the dialog, rather than an onLoad handler triggered when the IFRAME that contains the result is loaded. </td>
423   </tr>
424   <tr>
425     <td align="right"> 7869 </td>
426     <td><a href="http://develop.twiki.org/~develop/cgi-bin/view/Bugs/Item1172" rel="nofollow">Item1172</a> had to rewrite big chunk of the table popup to get it working with 1.3.2 </td>
427   </tr>
428   <tr>
429     <td align="right"> 7858 </td>
430     <td><a href="http://develop.twiki.org/~develop/cgi-bin/view/Bugs/Item1151" rel="nofollow">Item1151</a> rewrote link handlings stuff to leverage browser better </td>
431   </tr>
432   <tr>
433     <td align="right"> 7854 </td>
434     <td><a href="http://develop.twiki.org/~develop/cgi-bin/view/Bugs/Item1175" rel="nofollow">Item1175</a> escape wikiwords within squabs </td>
435   </tr>
436   <tr>
437     <td align="right"> 7815 </td>
438     <td><a href="http://develop.twiki.org/~develop/cgi-bin/view/Bugs/Item1158" rel="nofollow">Item1158</a> works for Cairo now as well </td>
439   </tr>
440   <tr>
441     <td align="right"> 7814 </td>
442     <td><a href="http://develop.twiki.org/~develop/cgi-bin/view/Bugs/Item1158" rel="nofollow">Item1158</a> first implementation of AJAX interface to allow selectoin of topics from other webs </td>
443   </tr>
444   <tr>
445     <td align="right"> 7812 </td>
446     <td><a href="http://develop.twiki.org/~develop/cgi-bin/view/Bugs/Item1154" rel="nofollow">Item1154</a> removed non-existent scull.gif </td>
447   </tr>
448   <tr>
449     <td align="right"> 7811 </td>
450     <td><a href="http://develop.twiki.org/~develop/cgi-bin/view/Bugs/Item1155" rel="nofollow">Item1155</a> added extra recursion block, as Item1155 suggests it is needed </td>
451   </tr>
452   <tr>
453     <td align="right"> 7801 </td>
454     <td><a href="http://develop.twiki.org/~develop/cgi-bin/view/Bugs/Item1042" rel="nofollow">Item1042</a> All sorts of clever tricks to handle expansion/compression of a subset of TWiki variables when they are used in URLs. Not a complete solution, but better than it was. </td>
455   </tr>
456   <tr>
457     <td align="right"> 7799 </td>
458     <td><a href="http://develop.twiki.org/~develop/cgi-bin/view/Bugs/Item1024" rel="nofollow">Item1024</a> caught out by recursive call to beforeCommonTagsHandler in Cairo (nasty) </td>
459   </tr>
460   <tr>
461     <td align="right"> 7798 </td>
462     <td><a href="http://develop.twiki.org/~develop/cgi-bin/view/Bugs/Item1042" rel="nofollow">Item1042</a> whoops, broke \t conversion in Cairo </td>
463   </tr>
464   <tr>
465     <td align="right"> 7789 </td>
466     <td><a href="http://develop.twiki.org/~develop/cgi-bin/view/Bugs/Item1140" rel="nofollow">Item1140</a> testcase for 1140 </td>
467   </tr>
468   <tr>
469     <td align="right"> 7788 </td>
470     <td><a href="http://develop.twiki.org/~develop/cgi-bin/view/Bugs/Item1140" rel="nofollow">Item1140</a> fix rewriting of img src urls (and updated MANIFEST for Kupu1.3.2) </td>
471   </tr>
472   <tr>
473     <td align="right"> 7786 </td>
474     <td><a href="http://develop.twiki.org/~develop/cgi-bin/view/Bugs/Item1042" rel="nofollow">Item1042</a> extensive improvements to variable and URL recognition and conversion </td>
475   </tr>
476   <tr>
477     <td align="right"> 7766 </td>
478     <td><a href="http://develop.twiki.org/~develop/cgi-bin/view/Bugs/Item856" rel="nofollow">Item856</a> added doc on EDIT_SKIN to the plugin </td>
479   </tr>
480   <tr>
481     <td align="right"> 7712 </td>
482     <td><a href="http://develop.twiki.org/~develop/cgi-bin/view/Bugs/Item1074" rel="nofollow">Item1074</a> upgrade to Kupu 1.3.2 complete (at last) </td>
483   </tr>
484   <tr>
485     <td align="right"> 7710 </td>
486     <td><a href="http://develop.twiki.org/~develop/cgi-bin/view/Bugs/Item1074" rel="nofollow">Item1074</a> Fixed source edit mode </td>
487   </tr>
488   <tr>
489     <td align="right"> 7709 </td>
490     <td><a href="http://develop.twiki.org/~develop/cgi-bin/view/Bugs/Item1074" rel="nofollow">Item1074</a> tidied up broken toolbar. There are still known issues </td>
491   </tr>
492   <tr>
493     <td align="right"> 7700 </td>
494     <td><a href="http://develop.twiki.org/~develop/cgi-bin/view/Bugs/Item1074" rel="nofollow">Item1074</a> first pass at moving to Kupu 1.3.2. </td>
495   </tr>
496   <tr>
497     <td align="right"> 7673 </td>
498     <td><a href="http://develop.twiki.org/~develop/cgi-bin/view/Bugs/Item1037" rel="nofollow">Item1037</a> insert wikiword only if selection is zero length </td>
499   </tr>
500   <tr>
501     <td align="right"> 7672 </td>
502     <td><a href="http://develop.twiki.org/~develop/cgi-bin/view/Bugs/Item977" rel="nofollow">Item977</a> changed to remove dangerous Cairo-based assumption, and use context ids instead </td>
503   </tr>
504   <tr>
505     <td align="right"> 7630 </td>
506     <td><a href="http://develop.twiki.org/~develop/cgi-bin/view/Bugs/Item1025" rel="nofollow">Item1025</a> added 'escape clause' for old handlers implemented to support old TWiki releases without warnings </td>
507   </tr>
508   <tr>
509     <td align="right"> 7506 </td>
510     <td><a href="http://develop.twiki.org/~develop/cgi-bin/view/Bugs/Item941" rel="nofollow">Item941</a> Eliminated the last of the dynamic globals to try and solve saving problem. Can;t test with mod_perl, but is fine with speedycgi AFAICT </td>
511   </tr>
512   <tr>
513     <td align="right"> 7456 </td>
514     <td><a href="http://develop.twiki.org/~develop/cgi-bin/view/Bugs/Item873" rel="nofollow">Item873</a> minor issue; replace br with \n in pre </td>
515   </tr>
516   <tr>
517     <td align="right"> 7455 </td>
518     <td><a href="http://develop.twiki.org/~develop/cgi-bin/view/Bugs/Item873" rel="nofollow">Item873</a> obvious problem parsing closing pre tag on same line as open tag </td>
519   </tr>
520   <tr>
521     <td align="right"> 7453 </td>
522     <td><a href="http://develop.twiki.org/~develop/cgi-bin/view/Bugs/Item710" rel="nofollow">Item710</a> Handling HTML comments </td>
523   </tr>
524   <tr>
525     <td align="right"> 7452 </td>
526     <td><a href="http://develop.twiki.org/~develop/cgi-bin/view/Bugs/Item876" rel="nofollow">Item876</a> Item945: Item876: spacing around table cells, correct handling of variables. Had to compromise on handling [[]] but I think it's for the best. </td>
527   </tr>
528   <tr>
529     <td align="right"> 7430 </td>
530     <td><a href="http://develop.twiki.org/~develop/cgi-bin/view/Bugs/Item871" rel="nofollow">Item871</a> made sure that brackets are generated for non-wikiwords </td>
531   </tr>
532   <tr>
533     <td align="right"> 7425 </td>
534     <td><a href="http://develop.twiki.org/~develop/cgi-bin/view/Bugs/Item928" rel="nofollow">Item928</a> removed special interpretation of mailto links </td>
535   </tr>
536   <tr>
537     <td align="right"> 7424 </td>
538     <td><a href="http://develop.twiki.org/~develop/cgi-bin/view/Bugs/Item866" rel="nofollow">Item866</a> extended URL parsing to handle MAINWEB and TWIKIWEB twiki variables, in the same hacky way as the core. </td>
539   </tr>
540   <tr>
541     <td align="right"> 7416 </td>
542     <td><a href="http://develop.twiki.org/~develop/cgi-bin/view/Bugs/Item870" rel="nofollow">Item870</a> a couple of corner-cases for correct handling of twiki variables </td>
543   </tr>
544   <tr>
545     <td align="right"> 7401 </td>
546     <td><a href="http://develop.twiki.org/~develop/cgi-bin/view/Bugs/Item899" rel="nofollow">Item899</a> changed list generation to use spaces instead of tabs </td>
547   </tr>
548   <tr>
549     <td align="right"> 7265 </td>
550     <td><a href="http://develop.twiki.org/~develop/cgi-bin/view/Bugs/Item180" rel="nofollow">Item180</a> removed pointless, outdated dependency check from [[Main/DateFieldPlugin]]</td>
551   </tr>
552   <tr>
553     <td align="right"> 6935 </td>
554     <td><a href="http://develop.twiki.org/~develop/cgi-bin/view/Bugs/Item622" rel="nofollow">Item622</a> reverted 3 specs to tabs in Set lines in plugins topics for kompatterbility with Kigh-roe </td>
555   </tr>
556   <tr>
557     <td align="right"> 6905 </td>
558     <td><a href="http://develop.twiki.org/~develop/cgi-bin/view/Bugs/Item622" rel="nofollow">Item622</a> tabs -&gt; 3 spacesto avoid confusing the users </td>
559   </tr>
560   <tr>
561     <td align="right"> 6850 </td>
562     <td><a href="http://develop.twiki.org/~develop/cgi-bin/view/Bugs/Item638" rel="nofollow">Item638</a> added instruction to run configure to all install docs (I hope) </td>
563   </tr>
564   <tr>
565     <td align="right"> 6827 </td>
566     <td><a href="http://develop.twiki.org/~develop/cgi-bin/view/Bugs/Item569" rel="nofollow">Item569</a> added default RELEASE to everything that had a version, and removed a load of dead code that was getting in the way </td>
567   </tr>
568   <tr>
569     <td align="right"> 6758 </td>
570     <td><a href="http://develop.twiki.org/~develop/cgi-bin/view/Bugs/Item569" rel="nofollow">Item569</a> computed version numbers for plugins from the repository rev they were built from. </td>
571   </tr>
572   <tr>
573     <td align="right"> 6504 </td>
574     <td><a href="http://develop.twiki.org/~develop/cgi-bin/view/Bugs/Item436" rel="nofollow">Item436</a> incremented vernos of all changed plugins </td>
575   </tr>
576   <tr>
577     <td align="right"> 6485 </td>
578     <td><a href="http://develop.twiki.org/~develop/cgi-bin/view/Bugs/Item429" rel="nofollow">Item429</a> trying to make access controls clearer </td>
579   </tr>
580   <tr>
581     <td align="right"> 6401 </td>
582     <td><a href="http://develop.twiki.org/~develop/cgi-bin/view/Bugs/Item340" rel="nofollow">Item340</a> re-initialisation bug found by [[Main/ColasNahaboo]] when using mod_perl; fixed by correctly re-initialising the parse stack for each run of the convertor </td>
583   </tr>
584   <tr>
585     <td align="right"> 6284 </td>
586     <td><a href="http://develop.twiki.org/~develop/cgi-bin/view/Bugs/Item340" rel="nofollow">Item340</a> Release 0.16 of [[Main/WysiwygPlugin]]</td>
587   </tr>
588   <tr>
589     <td align="right"> 6279 </td>
590     <td><a href="http://develop.twiki.org/~develop/cgi-bin/view/Bugs/Item340" rel="nofollow">Item340</a> bugfixes for release 0.16 of [[Main/WysiwygPlugin]]</td>
591   </tr>
592   <tr>
593     <td align="right"> 6261 </td>
594     <td><a href="http://develop.twiki.org/~develop/cgi-bin/view/Bugs/Item335" rel="nofollow">Item335</a> Switched PNGs to indexed mode, as transparency doesn't work on IE for RGB images </td>
595   </tr>
596   <tr>
597     <td align="right"> 6238 </td>
598     <td><a href="http://develop.twiki.org/~develop/cgi-bin/view/Bugs/Item332" rel="nofollow">Item332</a> Added context identifier to [[Main/WysiwygPlugin]], and a button to the pattern view template. If [[Main/WysiwygPlugin]] is enabled, then the button will appear. Neat, huh? </td>
599   </tr>
600   <tr>
601     <td align="right"> 6195 </td>
602     <td><a href="http://develop.twiki.org/~develop/cgi-bin/view/Bugs/Item196" rel="nofollow">Item196</a> getting plugin test suites to pass. Doesn't mean the plugins actually work, just that the test suites run (which is a good indicator) </td>
603   </tr>
604   <tr>
605     <td align="right"> 6174 </td>
606     <td><a href="http://develop.twiki.org/~develop/cgi-bin/view/Bugs/Item168" rel="nofollow">Item168</a> checkpoint checking for 0.16 </td>
607   </tr>
608   <tr>
609     <td align="right"> 6151 </td>
610     <td><a href="http://develop.twiki.org/~develop/cgi-bin/view/Bugs/Item186" rel="nofollow">Item186</a> more minor updates </td>
611   </tr>
612   <tr>
613     <td align="right"> 6150 </td>
614     <td><a href="http://develop.twiki.org/~develop/cgi-bin/view/Bugs/Item168" rel="nofollow">Item168</a> new icons, and a couple of bugfixes, to [[Main/WysiwygPlugin]]</td>
615   </tr>
616   <tr>
617     <td align="right"> 6092 </td>
618     <td><a href="http://develop.twiki.org/~develop/cgi-bin/view/Bugs/Item196" rel="nofollow">Item196</a> more plugin and contrib fixes for develop; mainly just moving tests around and making sure they all pass. </td>
619   </tr>
620   <tr>
621     <td align="right"> 6067 </td>
622     <td><a href="http://develop.twiki.org/~develop/cgi-bin/view/Bugs/Item138" rel="nofollow">Item138</a> had to change to using beforeCommonTagsHandler and also escape % signs to prevent TWiki from rendering internal tags (as reported by Colas) </td>
623   </tr>
624   <tr>
625     <td align="right"> 5979 </td>
626     <td><a href="http://develop.twiki.org/~develop/cgi-bin/view/Bugs/Item168" rel="nofollow">Item168</a> corrected stupid error on IE; added screenshot </td>
627   </tr>
628   <tr>
629     <td align="right"> 5977 </td>
630     <td><a href="http://develop.twiki.org/~develop/cgi-bin/view/Bugs/Item168" rel="nofollow">Item168</a> release 0.13 </td>
631   </tr>
632   <tr>
633     <td align="right"> 5948 </td>
634     <td><a href="http://develop.twiki.org/~develop/cgi-bin/view/Bugs/Item168" rel="nofollow">Item168</a> nearly ready for 0.13 </td>
635   </tr>
636   <tr>
637     <td align="right"> 5937 </td>
638     <td><a href="http://develop.twiki.org/~develop/cgi-bin/view/Bugs/Item168" rel="nofollow">Item168</a> corrected images, twikified all images </td>
639   </tr>
640   <tr>
641     <td align="right"> 5936 </td>
642     <td><a href="http://develop.twiki.org/~develop/cgi-bin/view/Bugs/Item168" rel="nofollow">Item168</a> the import from cvs has screwed images </td>
643   </tr>
644   <tr>
645     <td align="right"> 5934 </td>
646     <td><a href="http://develop.twiki.org/~develop/cgi-bin/view/Bugs/Item168" rel="nofollow">Item168</a> twikified icon images, and renamed some images to be more intention-revealing </td>
647   </tr>
648   <tr>
649     <td align="right"> 5739 </td>
650     <td> 0.12 beta release </td>
651   </tr>
652   <tr>
653     <td align="right"> 5730 </td>
654     <td> V0.11 </td>
655   </tr>
656   <tr>
657     <td align="right"> 5714 </td>
658     <td> Tidied up installer, documentation. Release 0.10 </td>
659   </tr>
660   <tr>
661     <td align="right"> 5712 </td>
662     <td> pre-release 0.06 </td>
663   </tr>
664   <tr>
665     <td align="right"> 5706 </td>
666     <td> Version 0.05 </td>
667   </tr>
668   <tr>
669     <td align="right"> 5705 </td>
670     <td> Checkpoint checking - version 0.03 </td>
671   </tr>
672   <tr>
673     <td align="right"> 5702 </td>
674     <td> cvsrmtee old files </td>
675   </tr>
676   <tr>
677     <td align="right"> 5701 </td>
678     <td> Check in for prototype release </td>
679   </tr>
680   <tr>
681     <td align="right"> 5700 </td>
682     <td> Check in for prototype release </td>
683   </tr>
684   <tr>
685     <td align="right"> 5699 </td>
686     <td> Checkpoint </td>
687   </tr>
688   <tr>
689     <td align="right"> 5698 </td>
690     <td> Most of the toolboxes are working again </td>
691   </tr>
692   <tr>
693     <td align="right"> 5693 </td>
694     <td> Initial commit; doesn't do much except run tests </td>
695   </tr>
696   <tr>
697     <td align="right"> Dependencies: </td>
698     <td>
699       <table border="1">
700         <tr>
701           <th>Name</th>
702           <th>Version</th>
703           <th>Description</th>
704         </tr>
705         <tr>
706           <td align="left">HTML::Parser</td>
707           <td align="left">&gt;=3.28</td>
708           <td align="left">Required. Available from <a href="http://cpan.uwinnipeg.ca/search?query=HTML%3A%3AParser&mode=dist" target="_top">CPAN</a>.</td>
709         </tr>
710         <tr>
711           <td align="left">HTML::Entities</td>
712           <td align="left">&gt;=1.25</td>
713           <td align="left">Required. Available from <a href="http://cpan.uwinnipeg.ca/search?query=HTML%3A%3AEntities&mode=dist" target="_top">CPAN</a>.</td>
714         </tr>
715       </table>
716     </td>
717   </tr>
718   <tr>
719     <td align="right"> Plugin Home: </td>
720     <td><a href="http://twiki.org/cgi-bin/view/Plugins/%TOPIC%" target="_top">http://twiki.org/cgi-bin/view/Plugins/%TOPIC%</a></td>
721   </tr>
722   <tr>
723     <td align="right"> Feedback: </td>
724     <td> TWiki:Plugins/%TOPIC%Dev </td>
725   </tr>
726   <tr>
727     <td align="right"> Appraisal: </td>
728     <td><a href="http://twiki.org/cgi-bin/view/Plugins/%TOPIC%Appraisal" target="_top">http://twiki.org/cgi-bin/view/Plugins/%TOPIC%Appraisal</a></td>
729   </tr>
730 </table>
731
732 **_Related Topics:_** [[TWikiPreferences]], [[TWikiPlugins]]