config
Wrapper for the elements which specify the configuration of edit-on Pro.
None.
fontmapping, presetcolors, customtags, spellingcheckers, cleanupprocess, defaulttablesettings, paragraphstyles, alternateenterkeyaction, fontsizeunit, fontsizes, documentcounter, tabpaneplacement , documentvalidation, sourceview, exportasnumerical, bodyonly, nbspfill, locale, uicolors, newdocumentdialog, multipleundoredo, oldfontstylemode, combowidth, standalonemode, licensekey, encoding, showall, sethtmldataurl, gethtmldataurl, eopeventhandling, ondataloaded, ondataposted, ondatapostederror, templateurl, customfield, localeurl, uicolor, dragndrop, directhttp, uploadimagesmethod, imagebase, presetsymbols
None.
<config>
<fontmapping usesystemfonts="true"/>
<!-- further configuration settings ... -->
</config>
alternateenterkeyaction
Specifies the type of line break created when the enter key is pressed.
config
None.
enabled (true|false) "false"
If enabled is set to false, a paragraph (<p>...</p>) is inserted when the enter key is pressed inside the editor. If shift+enter is pressed, a line break is created (<br />).
If enabled is set to true, a line break will be created when the enter key is pressed while a new paragraph is inserted when pressing shift+enter.
<alternateenterkeyaction enabled="true" />
advanceddialog
Enables or disables the "Advanced" tab in all dialogs which contain an "Advanced" tab (e.g. the "Insert Image", "Insert Link", "Insert Hyperlink" dialogs). The "Advanced " tab of these dialogs lets the user specify values for attributes which can not be selected on the default tab of the dialog. The attributes that are available and the values that can be set are read directly from the DTD.
config
None.
enabled (true|false) "true"
If enabled is set to false, the "Advanced" tab is not available.
If enabled is set to true, the "Advanced" tab can be used.
<advanceddialog enabled="true" />
autohyperlink
Specifies if hyperlinking as-you-type is enabled. If this feature is enabled, when the user types in a hyperlink in WYSIWYG view, it will automatically be converted into a HTML hyperlink.
config
None.
enabled (true|false) "true"
If enabled is set to true, hyperlinks typed in WYSIWYG View are automatically converted to HTML hyperlinks..
<autohyperlink enabled="true" />
autosave
Determines whether the editor's content should be regularly be saved. Also specifies in which interval the save should be performed, and which mehtod should be used to save the editor's content.
config
None.
enabled (true|false) "true"
If enabled is set to false, the autosave feature is disabled. If it is set to true, the content will be saved in an interval specified by the interval attribute.
method (filesystem|post) "post"
If method is set to filesystem , the editor's file will be saved to a file on the client computer. The file name and path is specified by the attribute destination .
If method is set to post, the editor's content is sent to the URL specified by destination . For details about how to handle POST requests sent by the editor, please see the chapter Direct HTTP connection API .
destination CDATA #REQUIRED
The attribute destination specifies the location to which the editor's content will be saved to or posted to, depending on the selected autosave method.
interval CDATA #REQUIRED
The attribute interval specifies the interval after which the save request is repeated (in seconds).
<autosave enabled="true"
method="filesystem"
destination="c:\folder\myfile.htm"
interval="300" />
base
Specifies the URL used by the editor to find and display images or objects with a relative path. If this element is specified, the editor will look for images or objects with a relative path in a location relative to the base . If the element is not specified, it defaults to the code base.
config
None,
href
Specifies the URL used by the editor to find and display images with a relative path.
<base href="http://myserver.com/" />
blockquote
Specifies whether the "Insert Blockquote" dialog prompts the user to enter a value for the "cite" attribute of the "blockquote" element inserted by this dialog.
config
None.
showinsertdialog (true|false) "true"
if set to true, "Insert Blockquote" dialog prompts the user to enter a value for the "cite" attribute of the "blockquote" element inserted by this dialog.
<blockquote showinsertdialog="false" />
bodyonly
Specifies whether the editor exports content outside of the body (<body>...</body>) tag of a page.
config
None.
enabled (true|false) "false"
If enabled is set to false, the editor will process content outside the page body and preserve header tags (e.g. <head>...</head>, <title>...</title>, etc...) . It will deliver a complete XHTML page when exporting.
If enabled is set to true, the editor will only process content inside the page body. The page body is all content inside of the <body>...</body> tags of a page. Always set enabled to true when dealing with fragments of web pages.This hashtable will contain status information about each file that was uploaded. It will contain the following info for each file:The old name of the fileThe new name of the uploaded fileThe new file path on the serverThe status code returned by the serverThe type of the upload that was performed (image, object or document)
<bodyonly enabled="true" />
browsefilesystem
Determines whether the "Browse File System" button is available in the "Insert Image" and "Insert Object" dialogs.
config
None.
enabled (true|false) "true"
If browsefilesystem is set to true, the "Browse File System..." button will be available in the "Insert Image" and "Insert Object" dialogs.
If browsefilesystem is set to false, it will not be possible to select an image or object from the file system using the "Insert Image" and "Insert Object" dialogs.
<browsefilesystem enabled="true" />
cleanupprocess
Specifies the (client-side) class or server-side script assuring the wellformedness of content imported into / exported from the editor. The clean-up will be assured by the editor itself by default. Use this attribute to override the clean-up process with your own implementation.
config
None.
class CDATA #IMPLIED
The name of the class that used on the client-side to clean up data in the editor.
cleanuponload (off|auto|always) "auto"
Determines when a clean-up will be performed while content is loaded into the editor. If the attribute has the value off , the editor will never perform a clean-up on content that is imported.
If cleanuponload has been set to auto , edit-on Pro will perform a clean-up if the document that is imported is invalid in respect to the DocType specified in the editor.
If cleanuponload has been set to always , the clean-up will always be performed when content is imported.
cleanuponsave (off|auto|always) "auto"
Determines whether a clean-up will be performed while content is exported from the editor. If the attribute has the value off , the editor will not perform a clean-up while exporting content.
If cleanuponsave has the value auto , the editor will perform a clean-up if the document that is exported is invalid according to the DocType specified in the editor.
If cleanuponsave has the value always , the clean-up will always be performed when content is exported.
dropillegalattributes (true|false) "true"
Determines whether attributes not allowed in the Document Type Declaration used by the editor will be removed from the document.
dropillegaltags(true|false) "true"
Determines whether elements not allowed in the Document Type Declaration used by the editor will be removed from the document.
url CDATA #IMPLIED
Determines the URL of the server-side script cleaning the data in the editor.
hidecomments (true|false) "false"
If set to true , MS Word generated comments are removed when content is pasted from MS Word.
<cleanupprocess url="http://myserver.com/customCleanUp.jsp"
dropillegalattributes="false" />
converttablewidthtorelative
If this is set, any table with an absolute size pasted into the editor will be converted to a table with relative width.
config
None.
enabled (true|false) "false"
If this is set, any table with an absolute size pasted into the editor will be converted to a table with relative width.
reference CDATA #IMPLIED
Determines a width (in pixels) relative to which tables with an absolute width will be converted to a relative width.
<converttablewidthtorelative enabled="true" reference="800" />
customfield
May be used to specify an additional custom field sent to the server-side script specified by the element directhttp along with the field HTMLDATA . The request will be a POST request and the data will be stored in a field called CUSTOMFIELD .
config
None.
value CDATA #REQUIRED
Determines the value that the field CUSTOMFIELD will contain.
<customfield value="CustomFieldValue" />
customtagseditingonly
If this setting is enabled, editing will only be possible within custom tags in the document.
config
None.
enabled (true|false) "false"
If this is set to true, editing will only be possible within custom tags in the document.
<customtagseditingonly enabled="true" />
defaulttablesettings
Specifies the default values of the default values that will be preset in the Insert Table dialog. A table inserted using the INSERTTABLE action will also have these values.
config
table_bgcolor, table_borderwidth, table_caption, table_cellpadding, table_cellspacing, table_colwidth, table_maxcols, table_maxrows, table_numcols, table_numrows, table_overallwidth, table_row
table_align (left | right | center)
If set, tables inserted using the Insert Table dialog will have the specified alignment by default.
cell_valign (top | middle | bottom | baseline)
If set, the cells of tables inserted using the Insert Table dialog will have the specified vertical alignment by default.
width_unit (percent | pixel)
Allows to specifiy whether the table and cell width should be set in pixel or percent by default.
height_unit (percent | pixel)
Allows to specifiy whether the table and cell height should be set in pixel or percent by default.
automatic_relative_cellwidth (true|false) "false"
If this is set to true, when a table with a relative width is inserted and no width was specified for the individual cells, width attributes will automatically be added to the tables' cells. These width attributes will of course also have relative values and the editor will make sure the total width for all cells in a row is 100%.
widthinstyle (true|false) "false"
If this is set to true , the table width will be set using style properties instead of the width attribute.
<defaulttablesettings table_align="center"
cell_valign="middle"
width_unit="percent"
height_unit="percent">
<table_bgcolor>#dedfde</table_bgcolor>
<table_borderwidth>2</table_borderwidth>
<table_caption alignment="top">Test Caption</table_caption>
<table_cellpadding>3</table_cellpadding>
<table_cellspacing>2</table_cellspacing>
<table_colwidth>20%</table_colwidth>
<table_maxcols>10</table_maxcols>
<table_maxrows>10</table_maxrows>
<table_numcols>5</table_numcols>
<table_numrows>5</table_numrows>
<table_overallwidth>100%</table_overallwidth>
<table_rowheight>10%</table_rowheight>
</defaulttablesettings>
table_bgcolor
Specifies the default background color set in the Insert Table dialog.
defaulttablesettings
None.
None.
<table_bgcolor>#dedfde</table_bgcolor>
table_borderwidth
Specifies the default table border width color set in the Insert Table dialog. The default is "1".
defaulttablesettings
None.
None.If this is set, any table with an absolute size pasted into the editor will be converted to a table with relative width.
<table_borderwidth>25%</table_borderwidth>
table_caption
Specifies the default table caption set in the Insert Table dialog.
defaulttablesettings
None.
alignment (left|right|top|bottom) #IMPLIED
Specifies the alignment of the table caption.
<table_caption alignment="top">
Test caption
</table_caption>
table_cellpadding
Specifies the default cell padding set in the Insert Table dialog.
defaulttablesettings
None.
None.
<table_cellpadding>2</table_cellpadding>
table_cellspacing
Specifies the default cell spacing set in the Insert Table dialog.
defaulttablesettings
None.
None.isbottom
<table_cellspacing>2</table_cellspacing>
table_colwidth
Specifies the default column width color set in the Insert Table dialog.
defaulttablesettings
None.
None.
<table_colwidth>25%</table_colwidth>
table_maxcols
Specifies the maximum number of table columns that can be inserted using the Insert Table dialog.
inserttabledialog
None.
None.
<table_maxcols>15</table_maxcols>
Setting the number of max cols above 10 may affect the editor's performance on some systems
table_maxrows
Specifies the maximum number of table rows that can be inserted using the Insert Table dialog.
inserttabledialog
None.
None.
<table_maxrows>15</table_maxrows>
Setting the number of max rows above 10 may affect the editor's performance on some systems
table_numcols
Specifies the number of columns set in the Insert Table dialog. Default value: 2.
defaulttablesettings
None.
None.
<table_numcols>4</table_numrows>
table_numrows
Specifies the number of rows set in the Insert Table dialog. Default value: 2.
defaulttablesettings
None.
None.
<table_numrows>3</table_numrows>
table_overallwidth
Specifies the default width set in the Insert Table dialog. Default value: 100%.
defaulttablesettings
None.
None.
<table_overallwidth>100%</table_overallwidth>
table_rowheight
Specifies the default row height set in the Insert Table dialog.
defaulttablesettings
None.
None.
<table_rowheight>10</table_rowheight>
diff
Allows the configuration of the display and ignore filter of the comparison mode.
config
ignorefilterurl, verticalbarlook
None.
<diff>
<verticalbarlook>
verticalbar-width="2"
verticalbar-color="#0689cc"
/>
<ignorefilterurl>http://www.yourserver.com/ignorefilter.xsl</ignorefilterurl>
<diff/>
ignorefilterurl
You can configure VersioTrack to ignore certain types of changes when in comparison mode. To do so, you have to set up an ignore filter. The ignore filter is in XSLT format. You can specify the location of the ignore filter as content of the ignorefilterurl element.
See Ignoring Changes for details.
config
None.
None.
<ignorefilterurl>http://www.yourserver.com/ignorefilter.xsl</ignorefilterurl>
verticalbarlook
diff
None.
verticalbar-width CDATA #IMPLIED
Specifies the width of the vertical bar that marks changes on the left side of the editor in comparison mode.
vertical-color CDATA #IMPLIED
Specifies the color of the vertical bar that marks changes on the left side of the editor in comparison mode.
<ignorefilterurl>http://www.yourserver.com/ignorefilter.xsl</ignorefilterurl>
defaultfont
Specifies the default font used to display the editor's content where no font is otherwise specified.
This font is only used to render the editor's content, and is not exported in any way.
config
None.
name CDATA #REQUIRED
Specifies the default font used to display the editor's content where no font is otherwise specified.
This font is only used to render the editor's content, and is not exported in any way.
<defaultfont name="Arial"></defaultfont>
directhttp
Allows the configuration of the HTTP direct connection API.
config
None.
sethtmldataurl CDATA #REQUIRED
Determines the location of a document loaded after the editor is initialized.
setokurl CDATA #IMPLIED
Allows to specify an URL called after a document specified by the attribute url has been loaded successfully.
setoktarget CDATA #IMPLIED
Determines the target frame of the document specified by the setokurl attribute.
seterrorurl CDATA #IMPLIED
Allows to specify a URL called if the document specified by the attribute url could not be successfully loaded.
seterrortarget CDATA #IMPLIED
Determines the target frame of the document specified by the seterrorurl attribute.
gethtmldataurl CDATA #REQUIRED
Specifies the location of the server-side script that will receive the data posted by the editor when the SAVE action is fired. The request will be a POST request and the data will be stored in a field with the name HTMLDATA .
getokurl CDATA #IMPLIED
Allows to specify an URL to be called after the editor's content has been sent successfully to the location specified by the attribute url .
getoktarget CDATA #IMPLIED
Determines the target frame of the document specified by the getokurl attribute.
geterrorurl CDATA #IMPLIED
Allows to specify an URL called if the editor's content couldn't be sent successfully to the location specified by the attribute url .
geterrortarget CDATA #IMPLIED
Determines the target frame of the document specified by the geterrorurl attribute.
<directhttp sethtmldataurl="http://myserver.com/mycontent.htm"
setokurl="http://myserver.com/ok.htm"
setoktarget="_new"
seterrorurl="http://myserver.com/error.htm"
seterrortarget="_blank"
gethtmldataurl="http://myserver.com/save.php"
getokurl="http://myserver.com/ok.htm"
getoktarget="_new"
geterrorurl="http://myserver.com/error.htm"
geterrortarget="_blank" />
documentcounter
Enables character counting and allows to restrict the number of characters in a document to a specified maximum.
config
None.
limit CDATA #IMPLIED
Determines the number of characters displayed as upper limit in the editor.
enforcelimit (true|false) "false"
Determines whether the character limit specified by the attribute limit will be enforced or not. If set to true, adding further content will be blocked if the limit is surpassed.
<documentcounter limit="5000" enforcelimit="true" />
documentvalidation
Specifies whether the editor's content will be validated against the DocType set in the editor.
config
None.
enabled (true|false) "true"
If enabled is set to false, the editor will not validate documents.
If enabled is set to true, documents loaded into the editor will be validated against the DocType set in the editor.
validateonsave (true|false) "false"
If validateonsave is set to true, documents will be validated against the DTD specified by the DocType set in the editor when they are saved.
overridedoctype (true|false) "true"
If overridedoctype is set to false, the editor will always validate against the DocType of the document loaded into the editor.
If overridedoctype is set to true, the editor will always validate agianst the DocType specified in the template loaded in the editor and ignore the current document type set in the editor.
allowforcedload (true|false) "false"
If allowforcedload is set to true, a prompt will appear asking for confirmation when ever the user tries to load an invalid document. If the user selects "Load anyway" from the prompt, the editor will try to load the document anyway. If this attribute is set to false, the user will not be able to enforce the loading of invalid documents.
<documentvalidation enabled="true"
validateonsave="true"
overridedoctype="true" />
dragndrop
Specifies whether drag and drop is enabled in the editor or not.
configbase
None.
enabled (true|false) "true"
If enabled is set to false, it is not be possible to drag and drop external documents into the editor.
<dragndrop enabled="true" />
encoding
Specifies the encoding used by the editor.
config
None.
value CDATA #REQUIRED
Specifies the encoding used by the editor. See http://java.sun.com./j2se/1.4.2/docs/guide/intl/encoding.doc.html for possible values.
The name of a specific encoding used as value for this element may differ from the HTML term for this encoding. The name used by the encoding element is the Java term for this encoding and can be found in the document specified by the link above.
The web page containing the editor must use the same encoding as the editor in the document loaded in the editor. For example, in order to use the UTF-8 encoding, the value of the encoding element must be "UTF8", while "utf-8" has to be used in the page's META tag.
<encoding value="UTF8" />
eopeventhandling
Wrapper for the editor's event handling elements, which allow to specify JavaScript functions executed when a specific event is fired.
config
ondataloaded, ondataposted, ondatapostederror
None.
<eopeventhandling>
<ondataloaded value="OnDataLoaded" />
<ondataposted value="OnDataPosted" />
<ondatapostederror value="OnDataPostedError" />
</eopeventhandling>
ondataloaded
Specifies a JavaScript function to be executed after content was loaded into the editor using the setHTMLDataFromURL() function.
eopeventhandling
None.
value CDATA #REQUIRED
Specifies a JavaScript function to be executed after content was loaded into the editor using the setHTMLDataFromURL() function. The specified JavaScript function will also receive a reference to the applet as first argument.
<ondataloaded value="OnDataLoaded" />
ondataposted
Specifies a JavaScript function to be executed after the editor's content was successfully sent to the location specified by the gethtmldataurl attribute of the element directhttp .
eopeventhandlingbase
None.
value CDATA #REQUIRED
Specifies a JavaScript function to be executed after the editor's content was successfully sent to the location specified by the element directhttp . The specified JavaScript function will also receive a reference to the applet as first argument.
<ondataposted value="OnDataPosted" />
ondatapostederror
Specifies a JavaScript function to be executed if the editor's content was not sent successfully to the location specified by the gethtmldataurl attribute of the element directhttp in the configuration file.
eopeventhandling
None.
value CDATA #REQUIRED
Specifies a JavaScript function to be executed if the editor's content was not sent successfully to the location specified by the element directhttp . The specified JavaScript function will also receive a reference to the applet as first argument.
<ondatapostederror value="OnDataPostedError" />
exportasnumerical
Specifies whether the editor should export special characters and symbols (as defined in XHTML entity sets) as numeric character entities.
config
None.
enabled (true|false) "false"
If enabled is set to true, the editor will export special characters and symbols as numeric character entities. E.g. "ä" will be exported as "ä".
<exportasnumerical enabled="true" />
Characters will only be exported as entities if they are not supported by the encoding specified in the document. If characters are supported by the specified encoding, they will be exported as such.
fontmapping
Wrapper for the font element, specifying to which font the fonts in the editor will be mapped to when the document is exported.
config
font
usesystemfonts (true|false) "false"
If usesystemfonts is set to true, all fonts available on the client system will also be available in the editor.
<fontmapping usesystemfonts="true" />
It is recommended to set usesystemfonts to true only in an homogeneous environment (i.e. where all client machines using the editor have a similar configuration), as fonts available on a specific client system may not be available on other client systems. Documents using a specific font may not be displayed correctly on all client systems viewing the document.
font
Specifies a mapping of a font within the editor.
fontmapping
renderedfont, exportedfont
name CDATA #REQUIRED
Determines the name of the font displayed within the editor.
<font name="Roman">
<renderedfont>Serif</renderedfont>
<exportedfont>Georgia, Times New Roman, Times</exportedfont>
</font>
renderedfont
Specifies the font used in the editor to render this font name.
font
None.
url CDATA #IMPLIED
If a specific font is not available on all client machines, this font can be fetched from a font file in TTF format at the URL specified by url . This font is then used to render the font specified by renderedfont .
<fontmapping>
<font name="Roman">
<renderedfont
url="http://myserver/customfont.ttf">Serif</renderedfont>
<exportedfont>Georgia, Times New Roman, Times</exportedfont>
</font>
</fontmapping>
exportedfont
Specifies the name of the font this font name will be exported to.
font
None.
None.
<fontmapping>
<font name="Roman">
<renderedfont>Serif</renderedfont>
<exportedfont>Georgia, Times, Serif</exportedfont>
</font>
</fontmapping>
fontsizeunit
Specifies the unit used to display fonts.
config
None.
unit (pt|px|em|cm|%) "px"
Determines the font size unit used in the editor. The default unit is "px".
<fontsizeunit unit="pt" />
fontsizes
Wrapper for the fontsize element, specifying the font sizes available in the font size selector box.
config
fontsize
None.
<fontsizes>
<fontsize size="12em" />
<fontsize size="12cm" />
<fontsize size="12%" />
<fontsize size="large" />
<fontsize size="24" />
<fontsize size="36" />
</fontsizes>
fontsize
Specifies a font size available in the font size selector box.
fontsizes
None.
size CDATA #REQUIRED
Specifies a font size available in the font size selector box. The font size may be specified by a unit descriptor such as "cm", "%" or "em" to determine which font size unit is used. If no unit is specified, the size unit specified by the element fontsizeunit will apply.
<fontsize size="12" />
iconrepository
Specifies a repository from which the editor loads the toolbar icons. If this repository is specified, the applet will first look for icons in the repository. If the icon can not be found in the repository, it is loaded from the edit-on Pro JAR file.
If a relative path is used for the repository, it is resolved relative to the editor's codebase.
config
None.
url
Specifies a repository from which the editor loads the toolbar icons. If this repository is specified, the applet will first look for icons in the repository. If the icon can not be found in the repository, it is loaded from the edit-on Pro JAR file.
<iconrepository url="myicons/" />
imagebase
Specifies the URL used by the editor to find and display images with a relative path. If this element is specified, the editor will look for images with a relative path in a location relative to the imagebase . If the element is not specified, it defaults to the code base.
config
None.
url
Specifies the URL used by the editor to find and display images with a relative path.
<imagebase url="http://myserver.com/myimages" />
This setting is deprecated as of edit-on Pro version 4.2. Please use base instead.
inlinequote
Specifies whether the "Insert Inline Quote" dialog prompts the user to enter a value for the "cite" attribute of the "inlinequote" element inserted by this dialog.
config
None.
showinsertdialog (true|false) "true"
if set to true, "Insert Inline Quote" dialog prompts the user to enter a value for the "cite" attribute of the "q" element inserted by this dialog.
<blockquote showinsertdialog="false" />
licensekey
Specifies the location of the license key file required by the editor.
config
None.
value CDATA #IMPLIED
Specifies the URL location of the license key file. The value may be relative to the editor's codebase. If this element is not specified, the editor will search for a file called licensekey.xml at the editor's codebase.
<licensekey value="licensekey.xml" />
locale
Specifies the language module defining the user interface language.
config
None.
value CDATA #IMPLIED
Specifies the language module defining the user interface language. The possible values are American English ("en_US"), Spanish ("es_ES"), French ("fr_FR") and German ("de_DE").
<locale value="en_US" />
localeurl
Specifies the location of the locale filed used by the editor. The value may be relative to the applet codebase. If specified, it overrides the value set by locale . localeurl enables the integrator to specify a custom locale not available in the editor by default.
config
None.
value CDATA #IMPLIED
Specifies the location of the locale filed used by the editor.
<localeurl value="locale_it_IT.xml" />
mousewheelscroll
Specifies the scroll increment per rotation of the mouse wheel. The default scroll increment is 172.
config
None.
increment CDATA #REQUIRED
Specifies the scroll increment per rotation of the mouse wheel. The default scroll increment is 172.
<mousewheelscroll increment="400" />
multipleundoredo
Specifies whether it is possible to undo / redo a sequence of actions performed within the editor.
config
None.
enabled (true|false) "false"
If enabled is is set to false, it is not possible to undo / redo a sequence of actions performed within the editor.
maxsteps CDATA #REQUIRED
Determines the maximum number of actions which can be undone / redone in sequence within the editor.
<multipleundoredo enabled="true" maxsteps="5" />
newdocumentdialog
Specifies whether the editor will prompt for confirmation before clearing the content when the NEW action is fired.
config
None.
enabled (true|false) "true"
If enabled is set to true, the editor will prompt for confirmation before clearing the content when the NEW action is fired.
<newdocumentdialog enabled="true" />
nbspfill
Specifies whether a " " entitity will be inserted into empty paragraphs when the editor's content is exported.
config
None.
enabled (true|false) "false"
If enabled is set to true, " " entities will be inserted in empty paragraphs outside tables when the editor's content is exported.
filltable (true|false) "false"
If filltable is set to true, " " entities will be inserted in empty table cells when the editor's content is exported.
<nbspfill enabled="true" filltable="true" />
oldfontstylemode
Specifies whether the editor will use the "old font style" mode or not.
config
None.
enabled (true|false) "false"
If enabled is set to true, the "<b>", "<i>" and "<u>" tags will be used instead of "<strong>", "<em>" and "<span style='text-decoration:underline'>" respectively when entering bold, italic or underlined text.
If enabled is set to false, "<strong>", "<em>" and "<span style='text-decoration:underline'>" will be used for bold, italic and underlined text.
<oldfontstylemode enabled="true" />
pageproperties
Allows to configure whether certain tabs in the "Page Properties..." dialog should be disabled.
config
None.
disablegeneraltab (true|false) "false"
If set to true, the "General" tab of the "Page Properties" dialog is disabled.
disablecolorstab (true|false) "false"
If set to true, the "Colors" tab of the "Page Properties" dialog is disabled.
disablebackgroundtab (true|false) "false"
If set to true, the "Background" tab of the "Page Properties" dialog is disabled.
<pageproperties disablecolorstab="true" />
paragraphstyles
Wrapper for the paragraphstyle element specifying the styles that can be set in the Paragraph Styles selector box.
config
paragraphstyle
None.
<paragraphstyles>
<paragraphstyle name="h1" />
<paragraphstyle name="h2" />
<paragraphstyle name="h3" />
<paragraphstyle name="h4" />
</paragraphstyles>
paragraphstyle
Specifies the individual paragraph styles available in the Paragraph Styles selector box.
paragraphstyles
None.
name
Specifies the individual paragraph styles available in the Paragraph Styles selector box.
<paragraphstyle name="h1" />
presetcolors
Wrapper for the color element specifying the preset colors available in the applet's color dialog.
config
color
only (true|false) "false"
If only is set to true, only preset colors specified by the integrator will be available in the editor.
<presetcolors>
<color rgb="#ff0000" desc="Red" />
<color rgb="#ffffff" desc="White" />
<color rgb="#000000" />
</presetcolors>
color
Specifies a custom color available in the applet's color dialog.
presetcolors
None.
rgb CDATA #REQUIRED
Specifies the RGB value of the color.
desc CDATA #IMPLIED p
Specifies a description of the color which will appear in the color dialog.
<color rgb="#ff0000" desc="Red" />
pastespecial
Configures the "Paste Special" dialog.
config
None.
prompt (true|false) "false"
If set to true, the "Paste special" dialog will be opened and present a selection of paste types whenever content is pasted from MS Word.
preselectedaction (PASTEWITHFILTER|PASTEPLAINTEXT|PASTE|PASTEWITHSTYLEDEFS) "PASTE"
This specifies which paste action will be selected by default in the "Paste special" dialog when it is opened.
<pastespecial prompt="false" preselectedaction="PASTE">
preservestyle
Preserves the formatting of the current paragraph when it is split into a new paragraph by pressing enter. The new paragraph will have the same formatting as the original paragraph if this setting is enabled.
config
None.
enabled (true|false) "true"
If set to true, the formatting of the paragraph at the caret location is preserved when it is split by pressing enter.
<preservestyle enabled="true" >
presetsymbols
Wrapper for the symbol element specifying custom symbols available in the "Insert Special Character" dialog.
config
symbol
only (true|false) "false"
If only is set to true, only preset symbols specified by the integrator will be available in the "Insert Special Character" dialog.
<presetsymbols>
<symbol entity="Α"/>
<symbol entity="Β"/>
<symbol entity="Γ"/>
<symbol entity="Δ"/>
</presetsymbols>
symbol
Specifies a custom symbol available in the "Insert Special Character" dialog.
config
symbol
entity CDATA #REQUIRED
Specifies a custom symbol available in the "Insert Special Character" dialog as entity. The symbol will then be displayed in the "Additional Symbols" tab of the "Insert Special Character" dialog.
<symbol entity="Δ"/>
showall
Determines whether the "Show all" mode is activated at the editor's start-up or not.
config
None.
enabled (true|false) "false"
Using this configuration setting overrides the value from the user preferences.
<showall enabled="true" />
spellingcheckers
Specifies the languages available in the spell checker. The spell checker languages are defined using the spellingchecker element. The element addspellcheckwordurl enables the user to add new words to a dictionary.
config
spellingchecker, addspellcheckwordurl
autospellcheck (true|false) "false"
Determines whether the spell checker will check the document's spelling at run-time.
allowaddwords (true|false) "true"
Determines whether the user can add words to the user dictionary at run-time.
<spellingcheckers autospellcheck="true">
<spellingchecker name="english"
archive="lex/english.jar"
default="true"
version="100" />
<addspellcheckwordurl url="http://myserver.com/adword.php" />
</spellingcheckers>
spellingchecker
Specifies a language available in the spell checker.
spellingcheckers
None.
name CDATA #REQUIRED
Determines the name of the language.
archive CDATA #REQUIRED
Specifies the location of the language JAR file.
properties CDATA #IMPLIED
Determines the location of the spell-checker properties file if specified. Per default, the properties file located in the spell-checker JAR file is used to set the spell-checker properties, but if this attribute set, the new properties file is used instead of the one in the JAR file for the specififed language.
default (true|false) "false"
Determines whether the language is used as default language by the spell checker.
version CDATA #REQUIRED
The version is used when caching the spellchecker JAR on the client. The version may be updated in subsequent releases of edit-on Pro. If the version indicated here is newer than the version on client, the client will get the new version from the server and cache it locally on the client. If the version is the same as on the client, the version on the client will be loaded, thus reducing the loading time of edit-on Pro.
<spellingchecker name="english"
archive="lex/english.jar"
default="true"
version="100" />
addspellcheckwordurl
Specifies the URL of the serve word wrapping is active in source view.r-side script that will receive the word data after clicking on the "Add word" button in the spell checker dialog. The request sending the word data will be a POST request. The word will be contained in a field called "WORD" while the language currently used will be stored in a field called "LANG". The server-side script should append the word to the corresponding dictionary file. The new word will be recognized the next time the spelling is checked. When this element is not set, clicking the "Add word" button will add the word to the user dictionary.
spellingcheckers
None.
url
Specifies the URL of the server-side script that will receive the word data after selecting on the "Add word" button in the spell checker dialog.
<addspellcheckwordurl url="http://myserver.com/adword.php" />
sourceview
Specifies whether the source view is available.
config
None.
enabled (true|false) "false"
If enabled is set to true, the source view is available.
smartindent (true|false) "true"
Specifies whether smart indenting is enabled or not. Smart indenting enables the editor to export XHTML data in a clean, indented layout.
wordwrap (true|false) "false"
Determines whether word wrapping is active in source view.
readonly (true|false) "false"
Determines whether editing is possible in source view.
syntaxhighlighting (true|false) "false"
Specifies whether syntax highlighting is enabled in sourceview.
The wordwrap setting has no effect when syntax highlighting is active. The editor will always display a horizontal scrollbar instead.
fontname CDATA #IMPLIED
Specifies the font face used in source view.
This setting will only have an effect if the source view syntax highlighting is enabled.
fontsize CDATA #IMPLIED
Specifies the font size used n source view.
This setting will only have an effect if the source view syntax highlighting is enabled.
<sourceview enabled="true"
smartindent="false"
wordwrap="true"
syntaxhighlighting="false" />
standalonemode
Specifies whether the editor is displayed in frame window mode by default
config
None.
enabled (true|false) "false"
If enabled is set to true, the editor will be displayed in frame window mode by default.
<standalonemode enabled="true" />
tabpaneplacement
Specifies whether the tab pane will be placed at the top or at the bottom of the editor.
config
None.
isbottom (true|false) "false"
If isbottom is set to true, the tab pane will be placed at the bottom of the editor.
If isbottom is set to false, the tab pane will be placed at the top of the editor.
<tabpaneplacement isbottom="true" />
templateurl
Specifies the location of the template loaded once the editor is initialized.
config
None.
url CDATA #REQUIRED
Specifies the location of the template loaded once the editor is initialized. The location of the template may be relative to the editor's codebase.
The template will be loaded before any other content. It is also loaded before any of the events specified by the element eopeventhandling are fired. You can set a DocType in the template which will be used for any documents opened with the editor even if these documents specify other DocTypes, unless the overridedoctype attribute of the documentvalidation element is set to true. In this case, the editor will always use the DocType of the newly opened documents for validation.
<templateurl url="template.xhtml" />
text-antialiasing
Determines whether the text in the editor should be anti-aliased or not.
config
None.
enabled (true|false|default) "default"
If set to true, text in the editor is anti-aliased. If “default” is used, the default alias setting of the system is used.
<text-antialiasing enabled="true" />
graphics-antialiasing
Determines whether images in the editor should be anti-aliased or not. If “default” is used, the default alias setting of the system is used.
config
None.
enabled (true|false|default) "default"
If set to true, images in the editor are anti-aliased. If “default” is used, the default alias setting of the system is used.
<graphics-antialiasing enabled="true" />
uploadimagesmethod
Wrapper for the elements http and webdav which specify the method that will be used to upload images to the server.
config
http | webdav
None.
<uploadimagesmethod>
<webdav username="root"
userpassword="root"
url="http://myserver.com/webdavfolder"/>
</uploadimagesmethod>
This setting is deprecated as of edit-on Pro version 4.2. Please use the setting filemanagement instead.
filemanagement
Wrapper for the file element which is used to specify file repositories or upload handlers for the different file types that can be handled by edit-on Pro.
config
file
None.
<filemanagement>
<file type="image"
baseurl="http://www.myserver.com/"
autoupload="true"
onuploadfinished="myEventHandler">
<webdav url="http://www.myserver.com/"
username="webdav"
encryptedpassword="webdav="
debug="true"
putmethodexpectation="false"
mimetype="image/gif" />
</file>
</filemanagement>
file
Determines how files of the specified type should be handled by edit-on Pro. If a WebDAV connection is specified, the files of the specified type can be inserted from or uploaded to the repository.
file
http | webdav
type (image|object|document) #REQUIRED
Specifies the file type that will be managed. For details, please see the table "Overview of ACTIONS and their corresponding configuration" in the chapter Uploading and Inserting Files Using WebDAV .
mimetype CDATA #IMPLIED
Allows to specify a list of mime types that will be used to determine which files will be displayed in the "Upload Images" and "Browse Image Repository" dialogs. E.g. mimetype="image/gif,image/jpeg" will restrict the type of images that will be displayed in these dialogs to images in JPEG and GIF format.
baseurl CDATA #IMPLIED
Specifies a base URL which will be used to convert absolute file paths to relative paths when uploading the files are uploaded to or inserted from the repository.
autoupload (true|false) false
If set to true, an upload dialog is opened for this file type when the SAVE action is triggered or the postDocumentToServer API function is called.
maxsize CDATA #IMPLIED
Specifies the maximal size of the files that can be uploaded (in bytes).
onuploadfinished CDATA #IMPLIED
Specifies a JavaScript event handler function that will be called after the upload is finished. The function will receive two arguments, obj and status. While obj contains a reference to the applet, status is a two-dimensional array containing information about the upload of each file. It will contain the following info for each file:
The old name of the file
The new name of the uploaded file
The new file path on the server
The status code returned by the server
The type of the upload that was performed ( image , object or document )
<file type="image"
baseurl="http://www.myserver.com/"
autoupload="true"
onuploadfinished="imageEventHandler">
http
Specifies the location the files of the specified type contained in the document will be posted to when the corresponding upload action is fired. Only files not located at the URL specified by the base element will be posted.
file
None.
url CDATA #REQUIRED
Specifies the location the files contained in the document will be posted to when the corresponding action is fired.
defaultdialog (true|false) "true"
Specifies whether the "Image Upload" dialog should be displayed when uploading the specified file type. If set to false, all files of the specified type are uploaded when the file upload is started, and no dialog allowing the user to select individual files to upload is displayed.
<http url="http://myserver.com/imageupload.php" />
webdav
Determines the location of the WebDAV folder that will serve as repository when uploading files corresponding to the file type specified by the parent file element.
file
None.
In case the value of the username attribute, the passsword attribute or both attributes are empty, a login dialog will be displayed. This dialog gives the user three attempts to authenticate to the WebDAV repository.
username CDATA #IMPLIED
Determines the name of the user to authentify as when connecting to the WebDAV location specified by url .
userpassword CDATA #IMPLIED
Determines the password used to authentify the user specified by username when connecting to the location specified by url .
The password for the WebDAV connection specified by the userpassword attribute may not contain whitespace. Please make sure it does not contain any whitespace or the connection to the WebDAV repository may fail if a password is required.
encryptedpassword CDATA #IMPLIED
Determines the password used to authentify the user specified by username when connecting to the location specified by url . Unlike userpassword , this attribute will not take the password as is in plain text as argument, but rather the encrypted version of the password that was encrypted using the password encryption tool found in the /tools directory in the edit-on Pro installation package.
The password for the WebDAV connection specified by the encryptedpassword attribute may not contain whitespace. Please make sure it does not contain any whitespace or the connection to the WebDAV repository may fail if a password is required.
url CDATA #REQUIRED
Determines the location of the WebDAV folder images contained in the document will be uploaded to using the "Upload Images" dialog.
debug (true|false) "false"
If set to true all actions of the WebDAV connections are logged within the Java console.
mimetype CDATA #IMPLIED
If set, only files with the specified mime types will be displayed in the WebDAV dialogs.
putmethodexpectation (true|false) "true"
If set to false , the Expect: 100-continue handshake will not be used by the webdav client when sendig a request to the server. Set this to false if your server does not fully support HTTP 1.1 or if you are receiving a server response with the HTTP error code 417 when using WebDAV.
fullaccess (true|false) "false"
If set to true, the user is allowed to create new directories, rename files and delete files in the WebDAV directory.
The purpose of the 100 (Continue) status (refer to section 10.1.1 of the RFC 2616 for more details) is to allow a client that is sending a request message with a request body to determine if the origin server is willing to accept the request (based on the request headers) before the client sends the request body. In some cases, it might either be inappropriate or highly inefficient for the client to send the body if the server will reject the message without looking at the body.
<webdav username="webdavuser"
userpassword="webdavuserpassword"
url="http://myserver.com/webdavfolder/"
debug="true"
mimetype="image/gif,image/jpeg" />
uicolors
Wrapper for the uicolor element, which allows to individually specify custom colors for each area of the editor's user interface.
config
uicolor
None.
<uicolors>
<uicolor name="windowfacecolor" rgb="#000099" />
<uicolor name="tabpaneactivecolor" rgb="#eeeeee" />
<uicolor name="windowhighlightcolor" rgb="#ffcc66" />
<uicolor name="darkedgecolor" rgb="#ff0000" />
</uicolors>
uicolor
Allows to specify custom colors for each area of the editor's user interface.
uicolors
None.
name (windowfacecolor | tabpaneactivecolor | windowhighlightcolor | lightedgecolor | darkedgecolor | innertextcolor | disablediconcolor) #REQUIRED
Specifies the area of the user interface where the custom color should be used.
rgb CDATA #REQUIRED
Determines the hexadecimal RGB value of the custom color.
<uicolor name="windowfacecolor" rgb="#000099" />
userpreferences
Determines whether or not the saving of user preferences should be enabled or not. If user preferences are enabled, some dialogs will retain user-specified values such as custom colors, table size etc.
config
None.
enabled (true|false) "true"
If set to true, user preferences will be stored and used by the editor.
<userpreferences enabled="false" />