Settings for WysiwygPlugin that are common to most editor integrations
WYSIWYG_EXCLUDE - Prevent WYSIWYG editing
This is not supported currently by the TinyMCE Editor. This setting is not used.
The global preference setting
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:
html - HTML tags (e.g.
<div>, not including <br>), or
macros - simple macros (e.g.
calls - macros with parameters e.g.
pre blocks (
If the plugin detects an excluded construct in the topic, it will refuse to allow the edit and will redirect to the default editor.
WYSIWYG_EDITABLE_CALLS - Exceptions to WYSIWYG_EXCLUDE
If you excluded
, you can still define a subset of macros that do not
block edits. this is done in the global preference setting
, which should be a list of macro names separated by vertical bars, with no spaces, e.g:
* Set WYSIWYG_EDITABLE_CALLS = COMMENT|CALENDAR|INCLUDE
You should set
, or in WebPreferences
for each web.
WYSIWYGPLUGIN_PROTECT_EXISTING_TAGS - Protect specific tags originally in the topic text
preference 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.
The default setting for this preference is defined within the plugin.
It corresponds to
This feature may be disabled by setting the preference to a single comma.
Thi 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
blocks and the rules applied
to tables and lists.
WYSIWYGPLUGIN_STICKYBITS - Protect tags based upon their arguments
You can define the global preference
to 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
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 to
table=background,lang;tr=valign will stop the translator from trying to
table tag that has
lang attributes, and any
tr tag that has a
valign attribute back to Foswiki
| table | column |
markup (regardless of where that
table tag comes from).
This 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
. Attributes delimited by
comma, and tags delimited by semicolon.
- The left side of the equal sign is the tag.
- The right side of the equal sign is a comma delimited list of attributes to be matched.
If a matching tag is found, that matches any of the attributes listed,
the tag will not be converted back to TML.
You can use perl regular expressions to match tag and attribute names, so
will ensure that any tag with an id or
event handler is kept as
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 =
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.