|
|
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
KupuContribIntegration of the OSCOM Kupu WYSIWYG editor with TWiki.
On this page:
The integration uses the TWiki:Plugins.WysiwygPlugin to translate text to and from a format that Kupu can edit.
Caveat: KupuContrib 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 %TML%-type variables.
How to use the editorBasic help for most of the functions in the toolbar is available by "hovering" the mouse over the button. Some functions require a bit more explanation:
Kupu NotesThe version of Kupu shipped with this plugin is an uncustomised basic Kupu release. All the TWikification is done as plugins and extensions to Kupu - the basic kupu code is shipped completely intact.Installation Instructions%$INSTALL_INSTRUCTIONS% Kupu uses a special edit template (see TWikiTemplates). Important Set the name of the skin to use for WYSIWYG editing. This preference can be set in Main.TWikiPreferences, WebPreferences or in individual topics. If it is not set the editor is disabled. For example,
pattern skin, the %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 kupu to enable this module.
To add the editor to another skin, add the following link to the skin alongside or in place of the existing 'edit' link:<a href="%SCRIPTURLPATH%/edit%SCRIPTSUFFIX%/%WEB%/%TOPIC%?skin=kupu">Kupu</a>
As you can see this is just a standard edit link with the 'kupu' skin in place of the usual edit skin. Here it is for this topic: Kupu. Try clicking on it, but do not save!
Other SettingsThe global TWiki VariableWYSIWYG_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 veto an edit if the topic contains:
calls in WYSIWYG_EXCLUDE, you can still define a subset of TWiki variables that do not block edits. this is done in the global TWiki variable WYSIWYG_EDITABLE_CALLS, which should be a list of TWiki variable names separated by vertical bars, with no spaces, e.g: * Set WYSIWYG_EDITABLE_CALLS = COMMENT|CALENDAR|INCLUDE
You should set WYSIWYG_EXCLUDE and WYSIWYG_EDITABLE_CALLS in TWikiPreferences, or in WebPreferences for each web.
You can define the global variable WYSIWYGPLUGIN_STICKYBITS to stop the
plugin from ever trying to convert specific HTML tags into
HTML 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 variable is used to tell the translator which attributes, when present
on a tag, make it "stick" i.e. block conversion. For example, setting it to
table=background,lang;tr=valign will stop the translator from trying to
handle any table tag that has background or lang attributes, and any
tr tag that has a valign attribute.
You can use perl regular expressions to match tag and attribute names, so .*=id,on.* will ensure that any tag with an on* event handler is kept as HTML.
The default setting for this variable is:
.*=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;
DL=compact;
FONT=size,face;
H\d=align;
HR=align,noshade,size,width;
LEGEND=accesskey,align;
LI=type,value;
OL=compact,start,type;
P=align;
PARAM=name,type,value,valuetype;
PRE=width;
Q=cite;
TABLE=align,bgcolor,border,cellpadding,cellspacing,frame,rules,summary,width;
TBODY=align,char,charoff,valign;
TD=abbr,align,axis,bgcolor,char,charoff,colspan,headers,height,nowrap,rowspan,scope,valign,width;
TFOOT=align,char,charoff,valign;
TH=abbr,align,axis,bgcolor,char,charoff,colspan,height,nowrap,rowspan,scope,valign,width,headers;
THEAD=align,char,charoff,valign;
TR=bgcolor,char,charoff,valign;
UL=compact,type
If 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.
The editor template includes a number of files that can be used for other settings. These files are not included in the distribution, so that you can easily create your own local content.
TWiki.WysiwygPluginIconsYou can define a list of icons that will be available in the Kupu editor when the toolbar button is pressed. This topic has to contain a list of <IMG> tags. If present, the 'alt' text will be used in place of the <IMG> tag when translating from HTML to TML. Example:
<img src="%PUBURL%/TWiki/TWikiDocGraphics/tip.gif" /> <img src="%PUBURL%/TWiki/TWikiDocGraphics/warning.gif" /> <img src="%PUBURL%/TWiki/TWikiDocGraphics/pencil.gif" /> <img src="%PUBURL%/TWiki/TWikiDocGraphics/choice-yes.gif" /> <img src="%PUBURL%/TWiki/TWikiDocGraphics/updated.gif" /> <img src="%PUBURL%/TWiki/TWikiDocGraphics/help.gif" /> <img src="%PUBURL%/TWiki/TWikiDocGraphics/new.gif" /> <img src="%PUBURL%/TWiki/TWikiDocGraphics/starred.gif" /> <img src="%PUBURL%/TWiki/TWikiDocGraphics/arrowright.gif" /> TWiki.WysiwygPluginStringsYou can also define a list of strings that will be available for insertion in topics using the toolbar button. This topic has to contain a list of HTML 'option' tags. Example:
<option value='-- <nop>%WIKIUSERNAME% - %DATE%'>Signature</option>
<option value="%<nop>WIKINAME%">Wiki name (variable)</option>
<option value='%<nop>SEARCH{"search for"}%'>Inline search (variable)</option>
<option value='%<nop>INCLUDE{"topic or url"}%'>Include (variable)</option>
<option value="%<nop>TOC%"> Table of Contents (variable)</option>
<option value="%<nop>TOPIC%">Topic (variable)</option>
<option value="%<nop>WEB%">Web (variable)</option>
<option value="%<nop>DATE%"> Date (variable)</option>
The bit between the > < value defines text in the drop-down box in the editor, and the value defines the actual string inserted in the topic.
TWiki.WysiwygPluginLocalHelpIf it exists, the contents of this topic will be included and shown on the edit screen below the status bar. It is intended to be used for site-specific quick help information.Known problemsCan't undo all functions (Kupu + browser)Due to limitations in the browser support for editing, not all functions can be undone. Also, the undo buffer can be cleared unexpectedly during editing, especially when using Internet Explorer. Because of limitations in the browsers, the editor does not support PRE blocks. All PRE blocks will be converted to TWiki verbatim blocks on save. This can cause some confusion, especially when editor formatting controls (such as "bold") have been used to format text in a PRE block. Users are advised to use only plain text in PRE (verbatim) blocks.No Safari supportKupu does not work on Safari.Contrib InfoThis extension is brought to you by a WikiRing partner - working together to improve your wiki experience!
|
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
r1 - 06 Dec 2007 - 20:07:43 - TWikiGuest |
Copyright © by the contributing authors. All material on this collaboration platform is the property of the contributing authors. Ideas, requests, problems regarding WikiRing? Send feedback
Note: Please contribute updates to this topic on TWiki.org at TWiki:TWiki.KupuContrib