afterEditHandler. These handlers are responsible for the conversion of topic text to HTML, and post-conversion of HTML back to TML.
beforeEditHandlerconverts topic content to HTML by calling
afterEditHandlerconverts HTML back to TML by calling
WYSIWYGPLUGIN_WYSIWYGSKINshould not be set.
textareas_hijackedcontext id, to signal to skins to suppress their textarea manipulation functions.
WYSIWYGPLUGIN_WYSIWYGSKINmust be set for this to work. The flow of control is as follows:
beforeEditHandlerdetermines if the topic is WYSIWYG editable, and vetos the edit if not by redirecting to the standard edit skin. the edit
edittemplate containing the JS editor is instantiated.
%WYSIWYG_TEXT%expands to the HTML of the content-to-be-edited. This is suitable for use in a
afterEditHandlerin the WyswiygPlugin sees that
wysiwyg_editis set, which triggers the conversion back to TML.
wysiwyg_editand set it to 1, to trigger the conversion from HTML back to TML.
WYSIWYGPLUGIN_WYSIWYGSKINmust be set to the name of the skin used for WYSIWYG editing. This is usually the name of the editor e.g.
IFRAME. The flow of control is as follows:
XmlHttpRequest) to obtain the HTML document to be edited
viewURL with the
wysiwyg_editparameter and uses the TML2HTML translator to prepare the text, which is then returned as
text/plainto the browser.
%OWEB%and %OTOPIC%=, can be used in the content URL in the edit template to refer to the source topic for the content.
XmlHttpRequestto perform saves, by POSTing to the TWiki
savescript with the
wysiwyg_editparameter set to
1. This parameter tells the
beforeSaveHandlerin the WysiwygPlugin to convert the content back to TML. See TWikiScripts for details of the other parameters to the
savescript. 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.
uploadscript normally redirects to the containing topic; a behavior that you usually don't want in an editor! There are two ways to handle this:
XmlHttpRequest, then the 302 redirect at the end of the upload can simply be ignored.
uploadscript to suppress the redirect. In this case you will get a
OKfollowed by a message if everything went well, or an error message if it did not.
XmlHttpRequestto convert content from TML to HTML and back again. The plugin defines the following REST handlers:
.../rest/WysiwygPlugin/html2tml?topic=Web.Topic;text=htmltexttotranslateConverts the HTML text to TML.
topicmust be specified.
.../rest/WysiwygPlugin/tml2html?topic=Web.Topic;text=tmltexttotranslateConverts the TML text to HTML.
topicmust be specified. The response is a
text/plainpage of converted content.
configureinterface (Go to Plugins->Find More Extensions)
configureand enable the module, if it is a plugin.
,vfiles in your existing install (take care not to lock the files when you check in)
WYSIWYG_EXCLUDEcan be set to make the plugin sensitive to what is in a topic, before allowing it to be edited. The comma separated list to fall back to text edit can include:
html- HTML tags (e.g.
<div>, not including
variables- simple variables (e.g.
calls- variables with parameters e.g.
pre- pre-formatted blocks (
comments- HTML comments (
script- inline HTML Script tags - default
style- inline CSS style tags - default
table- inline HTML tables (
<table ..>. TML tables are not excluded)
WYSIWYG_EXCLUDE, you can still define a subset of variables that do not block edits. this is done in the global preference setting
WYSIWYG_EDITABLE_CALLS, which should be a list of variable names separated by vertical bars, with no spaces, e.g:
* Set WYSIWYG_EDITABLE_CALLS = COMMENT|CALENDAR|INCLUDEYou should set
WYSIWYG_EDITABLE_CALLSin TWikiPreferences, or in WebPreferences for each web.
WYSIWYGPLUGIN_PROTECT_EXISTING_TAGSpreference tells the translator that certain HTML tags which were originally in the topic text should remain as HTML tags; the translator will not try to convert them to TML. This protects the tags themselves, and not the contents enclosed between the
</tag>The default setting for this preference is defined within the plugin. It corresponds to
div, span. This feature may be disabled by setting the preference to a single comma. This does not guarantee that HTML markup will be removed; the conversion of HTML tags to TML markup remains subject to the other controls provided by the WysiwygPlugin, including the
<literal>blocks and the rules applied to tables and lists.
WYSIWYGPLUGIN_PROTECT_TAG_BLOCKSpreference tells the translator that certain HTML tag blocks which were originally in the topic text should remain as HTML blocks; the translator will not try to convert them to TML. The default setting for this preference is defined within the plugin. It corresponds to
script, style. As an example, individual html tables can be protected by surrounding them with
<sticky> .. </sticky> block. However,if you want to have all =<table> markup preserved as entered into topics by default, rather than subject to WYSIWYG editing, add =tableto this list, and =<table> markup will become automatically sticky. This feature may be disabled by setting the preference to a single comma.
WYSIWYGPLUGIN_STICKYBITSto stop the plugin from ever trying to convert specific HTML tags into TML when certain specific attributes are present on the tag. This is most useful when you have styling or alignment information in tags that must be preserved. This preference setting is used to tell the translator which attributes, when present on a tag, make it "stick" i.e. block conversion back to TML.
For example, setting it toThis setting is used only after the page has been processed by the editor. If the editor does not support a particular tag or attribute and the editor corrupts the tag, this setting will not be helpful. It is only used to prevent an HTML tag from being converted back to TML. Format of the setting is
table=background,lang;tr=valignwill stop the translator from trying to convert any
tabletag that has
langattributes, and any
trtag that has a
valignattribute back to TWiki
| table | column |markup (regardless of where that
tabletag comes from).
tag1=attrib,attrib;tag2=attrib. Attributes delimited by comma, and tags delimited by semicolon.
.*=id,on.*will ensure that any tag with an id or
on*event handler is kept as HTML. The default setting for this preference are hard coded in the plugin. If you wish to change the settings, the following list is the default setting coded in the plugin:
* Set WYSIWYGPLUGIN_STICKYBITS = (?!IMG).*=id,lang,title,dir,on.*; A=accesskey,coords,shape,target; BDO=dir; BR=clear; COL=char,charoff,span,valign,width; COLGROUP=align,char,charoff,span,valign,width; DIR=compact; DIV=align,style; DL=compact; FONT=size,face; H[0-9]=align; HR=align,noshade,size,width; LEGEND=accesskey,align; LI=value; OL=compact,start,type; P=align; PARAM=name,type,value,valuetype; PRE=width; Q=cite; TABLE=align,bgcolor,frame,rules,summary,width; TBODY=align,char,charoff,valign; TD=abbr,align,axis,bgcolor,char,charoff,headers,height,nowrap,rowspan,scope,valign,width; TFOOT=align,char,charoff,valign; TH=abbr,align,axis,bgcolor,char,charoff,height,nowrap,rowspan,scope,valign,width,headers; THEAD=align,char,charoff,valign; TR=bgcolor,char,charoff,valign; UL=compact,typeIf you edit using the plain-text editor, you can use the <sticky>..</sticky> tags to delimit HTML (or TML) that you do not want to be WYSIWYG edited. Implementors note if you are using your own before/after edit handlers, you can call
TWiki::Plugins::WysiwygPlugin::isWysiwygEditable()to check these controls. TWiki:Plugins.MathModePlugin (WysiwygPlugin) Plugins that extend the syntax using TWiki variables, such as
%MYVARIABLE%, should work fine.
*bold _bold-italic* italic_is legal in TML, but in HTML is represented by
<strong>bold <em>bold-italic</em></strong> <em>italic</em>which gets translated back to TML as
*bold _bold-italic_* _italic_which is correct by construction, but does not render correctly in TWiki. This problem is unfortunately unavoidable due to the way TWiki syntax works.
|Plugin Author:||TWiki:Main/CrawfordCurrie http://www.c-dot.co.uk|
|Copyright|| © 2005 ILOG http://www.ilog.fr,
© 2007 Twiki, Inc.,
© 2005-2010 TWiki:TWiki/TWikiContributor
|License||GPL (Gnu General Public License)|
|Plugin Version:||2010-05-17 18717 (2010-05-29)|
|2010-05-17:||TWikibug:Item6433 - more doc fixes; replacing TWIKIWEB with SYSTEMWEB|
|2010-04-24:||TWikibug:Item6433 - doc improvements, prepare for TWiki 5.0 release|
|18 Apr 2009||Fixed TWikibug:Item6251 (require http post for REST upload)|
|22 Oct 2008||Fixed TWikibug:Item5961 (emphasis), TWikibug:Item6089 (backslash in verbatim)|
|7 Aug 2008||Fixed TWikibug:Item5707 (mod_perl)|
|3 Aug 2008||TWiki 4.2.1 release version|
|25 May 2008||TWikibug:Item5457: TWikibug:Item5528: TWikibug:Item5626: using a debug simulation, I believe I have finally fixed all the complexities of using international character sets with the translator.|
|13 Apr 2008||TWikibug:Item4946: TWikibug:Item5530: I think I have finally fixed non-iso-8859-1 character sets. Painful. TWikibug:Item5393: removed spurious DIV generated by IE inside LI tags|
|31 Mar 2008||TWikibug:Item5314: TWikibug:Item5457: Fixed pickaxe mode for editing UTF-8. Characters above 255 are converted to entitites, which is a bit of a PITA, but at least it no longer corrupts topics.|
|28 Mar 2008||TWikibug:Item5294: fixed angle brackets in plain text and promoted sticky to be higher priority than any other tag, solving several problems in one go|
|24 Jan 2008||TWikibug:Item5257: remove extra spaces at end of Set lines|
|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.|
|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|
|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|
|2 Nov 2007||TWikibug:Item4903: corrected over-enthusiastive interpretation of ! as an escape|
|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 <sticky> 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|
|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|
|17 Sep 2007||TWikibug:Item4647: TWikibug:Item4652: problems related to DIV fixed. TWikibug:Item4653: fixed multi-line twiki variables|
|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|
|13 Sep 2007||TWikibug:Item4613 cleaned up spurious message when navigating away TWikibug:Item4615 fixed incorrect rendering of emphasis next to br|
|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|
|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|
|4 Sep 2007||TWikibug:Item4534 TWikibug:Item4535 fixed|
|See Subversion logs for earlier revisions|