You are here: Foswiki>System Web>Category>AdminDocumentationCategory>Plugins>WysiwygPlugin>WysiwygPluginSettings (2024-12-23, UnknownUser)Edit Attach
The global preference setting WYSIWYG_EXCLUDE
can 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 <br>), or macros
- simple macros (e.g. %VAR%
) or calls
- macros with parameters e.g. %MACRO{...}%
pre
blocks (<pre>
) comments
(<!--
... -->
) script
= inline HTML Script tags - defaultstyle
= inline Css style tags - defaulttable
= inline html tables (=<table ..>. TML tables are not excluded) If the plugin detects an excluded construct in the topic, it will refuse to allow the edit and will redirect to the default editor.
If you excluded calls
in WYSIWYG_EXCLUDE
, you can still define a subset of macros that do not block edits. this is done in the global preference setting WYSIWYG_EDITABLE_CALLS
, 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 WYSIWYG_EXCLUDE
and WYSIWYG_EDITABLE_CALLS
in SitePreferences, or in WebPreferences for each web.
The WYSIWYGPLUGIN_PROTECT_EXISTING_TAGS
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. This protects the tags themselves, and not the contents enclosed between the <tag>
and </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 WYSIWYGPLUGIN_STICKYBITS
and WYSIWYGPLUGIN_IGNOREATTRS
preferences, <sticky>
blocks, <literal>
blocks and the rules applied to tables and lists.
The WYSIWYGPLUGIN_PROTECT_TAG_BLOCKS
preference 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 table
to this list, and =<table> markup will become automatically sticky.
This feature may be disabled by setting the preference to a single comma.
You can define the global preference WYSIWYGPLUGIN_STICKYBITS
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 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 totable=background,lang;tr=valign
will stop the translator from trying to convert anytable
tag that hasbackground
orlang
attributes, and anytr
tag that has avalign
attribute back to Foswiki| table | column |
markup (regardless of where thattable
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 tag1=attrib,attrib;tag2=attrib
. Attributes delimited by comma, and tags delimited by semicolon.
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 .*=id,on.*
will ensure that any tag with an id or on*
event handler is kept as HTML.
Note: HTML has been gradually deprecating HTML attributes, replacing them with equivalent styles. For example, the table, row and cell background color attribute: bgcolor="#123456"
has been deprecated, replaced with style="background-color: #123456;"
A limited subset of tags ( table, th, tr, td
) will match against both the attributes and the style components. Styles have been added to the default setting.
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,.*?background-color:.*,frame,rules,summary,width; TBODY=align,char,charoff,valign; TD=abbr,align,axis,bgcolor,.*?background-color:.*,.*?border-color:.*,char,charoff,headers,height,nowrap,rowspan,scope,valign,width; TFOOT=align,char,charoff,valign; TH=abbr,align,axis,bgcolor,.*?background-color:.*,char,charoff,height,nowrap,rowspan,scope,valign,width,headers; THEAD=align,char,charoff,valign; TR=bgcolor,.*?background-color:.*,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.
have specific styling that you want to make sure you strip off.
This preference takes the same format as WYSIWYGPLUGIN_STICKYBITS
. It specifies tags and their attributes that are to be ignored when making the decision whether to keep the tag or not. For example, a <font face="Open Sans">
tag will normally be maintained in the TML. However setting WYSIWYGPLUGIN_IGNOREATTRS
to font=face
will result in it being removed.
By default WYSIWYGPLUGIN_IGNOREATTRS
is empty. WYSIWYGPLUGIN_STICKYBITS
takes precedence over this setting.
Edit | Attach | Print version | History: r1 | Backlinks | View wiki text | Edit wiki text | More topic actions
Topic revision: r1 - 2024-12-23, UnknownUser
Copyright © by the contributing authors. All material on this site is the property of the contributing authors.
Ideas, requests, problems regarding Foswiki? Send feedback