The file ezoe.ini contains the eZ publish configuration settings for the eZ Online Editor extension. By default it is located here:

<eZ_Publish_root>/ezpublish_legacy/extension/ezoe/settings/ezoe.ini

list of settings:

1.  [EditorSettings]
    Plugins
    Skin
    SkinVariant
    Directionality
    ToolbarAlign
    CompatibilityMode
    ValidateEmbedObjects
    TagPathOpenDialog
    CustomAttributeStyleMap
    XmlTagNameAlias
    XmlBrowseImageAallias
2.  [SystemSettings]
    RelativeURL
3.  [EditorLayout]
    Buttons
    ToolbarLocation
    PathLocation
4.  [SpellChecker]
    config
5.  [AtD]
    api_key

Configuration Group: [EditorSettings]

  Setting: Plugins

Summary

This setting sets the TinyMCE plugins used by eZ Online Editor.

Usage

Plugins[]=name plugin

Description

This setting sets the TinyMCE plugins used by eZ Online Editor.

The following TinyMCE plugins are tested and supported by the eZ Online Editor:

•  safari: This plugin is not used for eZ Online Editor version 5.2. and up since it is no longer needed by TinyMCE version 3.3 onwards. It solved various Safari compatibility issues between TinyMCE and WebKit. The latter being the rendering engine used by Google Chrome and Safari browsers. This plugin is not loaded when you are using other browsers like Firefox or Internet Explorer.
•  eztable: This plugin will add specific eZ table management functionality to TinyMCE.
•  insertdatetime: Adds support for two new buttons, insertdate & inserttime, these lets you insert preformatted date and time strings into your documents.
•  visualchars: This plugin will add the possibility to see invisible characters like " " (Non breaking space).
•  nonbreaking: This plugin will add a button for inserting nonbreaking space entities at the current caret location.
•  spellchecker: This plugin will add spellchecker functionality to TinyMCE by providing a new button that performs an AJAX call to a back end PHP page that uses PSpell/ASpell or Google spellchecker(default).
•  searchreplace: This plugin will add search and replace dialogs to TinyMCE.
•  paste: This plugin will autodetect word contents and then automatically clean it up before inserting it to the editor. When using this plugin there is no longer any need to use dialogs to paste contents from third-party sources.
•  fullscreen: This plugin will add full-screen editing mode to TinyMCE.
•  inlinepopups: This plugin will open all dialogs as floating DIV layers instead of pop-up windows. This plugin is very useful to get around pop-up blockers, and to avoid that editors gets access to edit document when they have modal dialogs opened.
•  AtD: This plugin, After the Deadline, offers spelling, style and grammar checking functionality. This is an advance alternative to 'spellchecker', it can be used by many browsers.
•  ezemotions: This plugin is the eZ variant of the emotions plugin. It allows users to insert smiley images into the TinyMCE editable area.
•  directionality: This plugin adds directionality buttons to TinyMCE and a default ezoe.ini setting which enables it to better handle languages written from right to left. It provides two buttons for text direction: ltr (left to right) and rtl (right to left).

For more information on the TinyMCE plugins please visit http://wiki.moxiecode.com/index.php/TinyMCE:Plugins

This setting is case sensitive.

Example

Plugins[]
Plugins[]=eztable
Plugins[]=paste
Plugins[]=fullscreen
Plugins[]=inlinepopups

 These plugins are enabled by default.

  Setting: Skin

Summary

This setting will define the skin for the editor.

Usage

Skin=<skin name>

Description

This setting will define the skin for the Online Editor.

The predefined styles for the OE text area are specified in the following folder:

<eZ_Publish_root>/ezpublish_legacy/extension/ezoe/design/standard/stylesheets/skins/

By default the following skins are included:

•  default: the grey skin as shown in some of the screenshots
•  o2k7: an "Office 2007" skin as used out of the box.

You can also use custom skins to define the appearance of the OE text area, by adding them here:

.../<your_design>/stylesheets/skins/<skin_name>

For more information on the use of the eZ Online Editor stylesheets please visit http://ez.no/doc/extensions/online_editor/5_x/settings

Alternatively you can use skin variations, which can be defined with the setting SkinVariant in block [EditorSettings].

This setting is case sensitive.

Example

Skin=o2k7

 This is the default setting, which will set the use of an "Office 2007" skin.

  Setting: SkinVariant

Summary

This setting will define the skin variation for the Online Editor.

Usage

SkinVariant=<name skin variant>

Description

This setting will define the skin variation for the Online Editor.

The included skin variations in the Office 2007 skin ("o2k7") are "silver" (ui_silver.css) and "black" (ui_black.css). These skin variant are located at:

<eZ_Publish_root>/ezpublish_legacy/extension/ezoe/design/standard/stylesheets/skins/o2k7/ui_silver.css

and

<eZ_Publish_root>/ezpublish_legacy/extension/ezoe/design/standard/stylesheets/skins/o2k7/ui_black.css.

If you want to create your own skin variation, place it in:

<eZ_Publish_root>/ezpublish_legacy/design/<your_design>/stylesheets/skins/<skin_name>/ui_<skin_variation>.css

This setting should be used in combination with the "Skin" setting in block [EditorSettings].

By default this setting is left empty.

This setting is case sensitive.

Example

[EditorSettings]
Skin=o2k7
SkinVariant=silver

 In this example the skin setting is set to the "Office 2007" skin, and the skin variant "silver" will be used.

  Setting: Directionality

Summary

This setting specifies the default writing direction.

Usage

Directionality=<b>ltr</b> | rtl

Description

This setting specifies the default writing direction. Some languages, like Hebrew, Arabic and Urdu, write from right to left instead of left to right.

Possible values are:

•  ltr: this is the default value. It stands for "Left-to-Right" indicating that the writing direction should be left to right.
•  rtl: this value stands for "Right-To-Left" indicates that the writing direction should be right to left.

This setting is case sensitive.

Example

Directionality=ltr

This is the default setting.

  Setting: ToolbarAlign

Summary

This setting specifies the toolbar button alignment.

Usage

ToolbarAlign=left | right

Description

This setting specifies the default alignment of the toolbar buttons.

Possible values are left and right.

This setting is case sensitive.

Example

ToolbarAlign=left

  Setting: CompatibilityMode

Summary

This setting allows users to enable compatibility mode by making editor behave more like eZ Online Editor 4.x.

Usage

CompatibilityMode=enabled | <b>disabled</b>

Description

This setting allows users to enable compatibility mode by making editor behave more like eZ Online Editor 4.x. For example it will use the attachment icon for embed relations, which makes it easier to place embed objects inside text and move them around. Keep in mind that by using this setting the preview function will be lost, the name of embed object, however, will be shown if you hover the icon.

This setting is disabled by default.

This setting is case sensitive.

Example

CompatibilityMode=disabled

 This is the default setting

  Setting: ValidateEmbedObjects

Summary

Sets validation embed objects.

Usage

ValidateEmbedObjects=enabled | disabled

Description

By enabling this setting embeded objects is validated, by not allowing you to publish content if any of the embed objects are in the trash or has been fully deleted. These embed objects will have a red border around them making it clear which once to remove. This setting is disabled by default.

This setting is case sensitive.

Example

ValidateEmbedObjects=disabled

This is the default setting.

  Setting: TagPathOpenDialog

Summary

This setting allows you to get the default TinyMCE behavior when clicking on a tag name.

Usage

TagPathOpenDialog=enabled | disabled

Description

This setting allows you to get the default TinyMCE behavior when clicking on a tag name, where TinyMCE will just select the tag you click on in the path. To allow this the setting must be set to disabled. Note that you might lose access to dialogues for several tags by disabling this as not all tags have their own button.

This setting is case sensitive.

Example

TagPathOpenDialog=enabled

This is the default setting

  Setting: CustomAttributeStyleMap

Summary

This setting maps custom attribute names to style values.

Usage

CustomAttributeStyleMap[<custom  attribute name>]=<style value>

Description

This setting maps the custom attribute names to style values so they can be previewed in the Online Editor.The supported styles are limited to the following types:

•  border: this includes border-color, border-width and border-style
•  margin
•  padding
•  width
•  height

Example

CustomAttributeStyleMap[]
CustomAttributeStyleMap[width]=width
CustomAttributeStyleMap[height]=height
CustomAttributeStyleMap[margin]=margin
CustomAttributeStyleMap[padding]=padding
CustomAttributeStyleMap[border]=border
CustomAttributeStyleMap[border_color]=border-color
CustomAttributeStyleMap[border_size]=border-width
CustomAttributeStyleMap[border_style]=border-style

 This is the default setting.

  Setting: XmlTagNameAlias

Summary

Sets the friendly names for tags.

Usage

XmlTagNameAlias[<tag>]=<tag name>

Description

Sets the friendly names for tags, as shown in status bar and dialogs.

It is important to note that this setting only works for the standard HTML tags, such as head, body, table, div, paragraph, span, strong, emphasize, etc...

This setting is case sensitive.

Example

XmlTagNameAlias[]
XmlTagNameAlias[th]=table  header
XmlTagNameAlias[td]=table cell
XmlTagNameAlias[tr]=table  row
XmlTagNameAlias[ul]=unordered list
XmlTagNameAlias[ol]=ordered  list
XmlTagNameAlias[li]=list item

 This is the default setting.

Setting: BrowseImageAlias

Summary

Sets the size for images in the Online Editor.

Usage

BrowseImageAlias[<image>]=<size>

Description

The image alias to use while browsing for an image content in Online Editor. It will set the image size when you upload an image with ezoe.

It is important to note tat  this image alias must exist. The default value is 'small'. Other values are:

• reference
• large
• tiny
• medium

Example

BrowseImageAlias[image1]=small

This is the default setting.

Configuration Group: [SystemSettings]

  Setting: RelativeURL

Summary

This setting the use of relative URLs inside the editor.

Usage

RelativeURL=enabled | disabled

Description

This setting the use of relative URLs (without host) inside the editor. This setting will only affects images in Online Editor version 5.0.This setting is enabled by default.

This setting is case sensitive.

Example

RelativeURL=enabled

 This is the default setting.

Configuration Group: [EditorLayout]

The settings here define the global Online Editor layout.

For eZ Publish versions 4.1 and higher it is possible to set an [EditorLayout] block for specific editors. For example [EditorLayout_mini], which defines the editor layout for the mini online editor. Keep in mind that the editor, "mini" in this case, needs to be set in the ezxml.ini file under TagPreset. Setting blocks for specific online editors, like [EditorLayout_mini], will override the settings in the [EditorLayout] block. The settings defined in the global [EditorLayout] are only used if no settings have been set in the specific editor layout block.

  Setting: Buttons

Summary

This settings sets the default buttons to use in the Online Editor.

Usage

Buttons[<type>]=<button name>

Description

This settings sets the default buttons to use in the Online Editor.The following buttons are tested and therefore supported by the Online Editor. The working of other buttons cannot be guaranteed:

•  formatselect
•  bold: this button will allow the user to write bold text.
•  italic: this button will allow the user to write italic text.
•  underline: this button will allow the user to underline text. This button will only appear if the underline custom tag is enabled in content.ini.
•  sub: this button will allow the user to create subscript, which appears below the baseline.
•  sup: this button will allow the user to create superscripts, which appears above the baseline.
•  justifyleft: this button will allow the user to control the alignment on the paragraph, header, custom, table, table cells and table header tags. But this function is only supported on eZ Publish 4.1 and higher, so these buttons will be hidden in 4.0.x.
•  justifycenter: this button will allow the user to control the alignment on the paragraph, header, custom, table, table cells and table header tags. But this function is only supported on eZ Publish 4.1 and higher, so these buttons will be hidden in 4.0.x.
•  justifyright: this button will allow the user to control the alignment on the paragraph, header, custom, table, table cells and table header tags. But this function is only supported on eZ Publish 4.1 and higher, so these buttons will be hidden in 4.0.x.
•  justifyfull: this button will allow the user to control the alignment on the paragraph, header, custom, table, table cells and table header tags. But this function is only supported on eZ Publish 4.1 and higher, so these buttons will be hidden in 4.0.x.
•  bullist: this button will allow the user to create bullet lists.
•  numlist: this button will allow the user to create numbered lists.
•  outdent: this button will allow the user to move text to the left.
•  indent: this button will allow the user to move text to the right.
•  undo: this button will allow the user to undo the last text action.
•  redo: this button will allow the user to redo the last text action.
•  ltr: this button will allow the user to change the text direction to left to right. This button will only be added if the directionality plugin is also enabled in the setting Plugins in the block [EditorSettings].
•  rtl: this button will allow the user to change the text direction to right to left. This button will only be added if the directionality plugin is also enabled in the setting Plugins in the block [EditorSettings].
•  link: this button will allow the user to create a link in text.
•  unlink: this button will allow the user to enable a link in text.
•  anchor: this button will allow the user to create an anchor in text.
•  search: this button will only be added if the searchreplace plugin is also set in the setting Plugins in the block [EditorSettings].
•  replace: this button will only be added if the searchreplace plugin is also set in the setting Plugins in the block [EditorSettings].
•  image: this button will allow the user to add an image in text.
•  object: this button will allow the user to add an object in text.
•  file: this button will allow the user to add a file in text.
•  custom: this button will allow the user to create block and inline elements in text.
•  literal: this button will allow the user to literal text.
•  charmap: this "special character" button will allow the user to insert a special character in text.
•  pagebreak: this button will allow the user to create a pagebreak. This button will only appear if the pagebreak custom tag is enabled in content.ini.
•  pasteword: this button will allow the user to past content from Word.
•  nonbreaking: this button will allow the user to create non breaking entities in text. This button will only be added if the nonbreaking plugin is enabled in the setting Plugins in the block [EditorSettings] and if AllowMultipleSpaces is set to true in ezxml.ini.
•  emotions: this button will allow the user to create smiley images in text. This button will only be added if the ezemotions plugin is also enabled in the setting Plugins in the block [EditorSettings].
•  tablemenu: This setting will put all table related buttons inside a sub menu.
•  table: this button will allow the user to create a table.
•  delete_table: this button will allow the user to drop a table.
•  delete_col: this button will allow the user to drop a table column.
•  col_before: this button will allow the user to add a table column before the current column.
•  col_after: this button will allow the user to add a table column after the current column.
•  delete_row: this button will allow the user to drop a table row.
•  row_before: this button will allow the user to add a table row before the current row.
•  row_after: this button will allow the user to add a table row after the current row.
•  split_cells: this button will allow the user to split table cells.
•  merge_cells: this button will allow the user to merge table cells.
•  code: this button will allow the user to see a pop-up with html markup. It needs rewrite rules to allow html files in design folders if in virtualhost mode
•  visualchars: this button will allow the user to see invisible characters like non breaking space. This button will only be added if the visualchars plugin is enabled in the setting Plugins in the block [EditorSettings].
•  fullscreen: this button will allow the user to see the Online Editor in full screen.
•  help: this button will allow the user to use the help function.
•  disable: this button will allow the user to disable the Online Editor.
•  publish: this button will allow the user to publish the text added in the Online Editor.
•  store: this button will allow the user to store the text added in the Online Editor.
•  discard: this button will allow the user to discard the text added in the Online Editor.
•  spellchecker: this button is used for TinyMCE spellchecker. This button will only be added if the spellchecker plugin is also set in the setting Plugins in the block [EditorSettings].
•  AtD: this button is used for the After the Deadline spellchecker. This button will only be added if the AtD plugin is also set in the setting Plugins in the block [EditorSettings].
•  |: this button will not be clickable, it will just break the toolbar into fields and group buttons.

For more information on the use of buttons in the Online Editor please visit the toolbar chapter the toolbar chapter.

Instead of using the syntax:

Buttons[<type>]=<button name>

It is also possible to list buttons with a "," to separate them, instead of listing each button individually. The syntax will look something like this:

Buttons[<type>]=<button name>,<button name>,<button  name>

This setting is case sensitive.

Example

•  Example 1

[EditorLayout]
Buttons[]
Buttons[]=formatselect
Buttons[]=bold
Buttons[]=italic
Buttons[]=underline
Buttons[]=|
Buttons[]=sub
Buttons[]=sup
Buttons[]=|
Buttons[]=justifyleft
Buttons[]=justifycenter
Buttons[]=justifyright
Buttons[]=justifyfull
Buttons[]=|
Buttons[]=bullist
Buttons[]=numlist
Buttons[]=outdent
Buttons[]=indent
Buttons[]=|
Buttons[]=undo
Buttons[]=redo
Buttons[]=|
Buttons[]=link
Buttons[]=unlink
Buttons[]=anchor
Buttons[]=|
Buttons[]=image
Buttons[]=object
Buttons[]=custom
Buttons[]=literal
Buttons[]=charmap
Buttons[]=pagebreak
Buttons[]=table
Buttons[]=delete_table
Buttons[]=delete_col
Buttons[]=col_after
Buttons[]=delete_row
Buttons[]=row_after
Buttons[]=split_cells
Buttons[]=merge_cells
Buttons[]=|
Buttons[]=fullscreen
Buttons[]=help

These buttons are enabled by default.

•  Example 2

[EditorLayout]
Buttons[]
Buttons[style]=formatselect,bold,italic,underline
Buttons[]=|
Buttons[math]=sub,sup
Buttons[]=|
Buttons[align]=justifyleft,justifycenter,justifyright,justifyfull

It is also possible to list buttons with a "," to separate them, instead of listing each button individually. So the style buttons, the math buttons and group buttons will be grouped together.

•  Example 3

[EditorLayout_mini]
Buttons[]
Buttons[]=bold
Buttons[]=italic
Buttons[]=underline
Buttons[]=|
Buttons[]=undo
Buttons[]=redo

 These are the default buttons for the mini editor.

  Setting: ToolbarLocation

Summary

This sets the toolbar location.

Usage

ToolbarLocation=top | bottom | none

Description

This sets the toolbar location. Possible values are:

•  top
•  bottom
•  none

This setting is case sensitive.

Example

ToolbarLocation=top

This is the default setting.

  Setting: PathLocation

Summary

This setting sets the path location.

Usage

PathLocation=top | bottom | none

Description

This setting sets the path location. Possible values are:

•  top
•  bottom
•  none

This setting is case sensitive.

Example

•  Example 1

[EditorLayout]
PathLocation=bottom

 This the default path location

•  Example 2

[EditorLayout]
PathLocation=bottom
 
[EditorLayout_mini]
PathLocation=none

 Although the path location is set to bottom in the global editor layout block, the setting is superseded by the mini editor layout block. Therefore the mini editor will have no path location.

Configuration Group: [SpellChecker]

This configuration block has the settings related to the TinyMCE SpellChecker plugin.

  Setting: config

Summary

Sets the TinyMCE SpellChecker.

Usage

config[<setting>]=<value>

Description

Sets the TinyMCE SpellChecker config. You need to enable the spellchecker plugin before these settings have any effect. This can be done with the setting Plugins in the block [EditorSettings].

This setting is directly used by the spellchecker plugin, and possible settings are described on the TinyMCE wiki page:
 http://wiki.moxiecode.com/index.php/TinyMCE:Plugins/spellchecker

This setting is case sensitive.

Example

config[general.engine]=PSpellShell
config[PSpellShell.aspell]="c:\Program  Files\Aspell\bin\aspell.exe"
config[PSpellShell.tmp]=c:/temp

 This is an example of the Windows PSpellShell settings.

Configuration Group: [AtD]

This configuration block has the settings related to the After the Deadline spellchecker plugin.

  Setting: api_key

Summary

This setting sets your AtD api key.

Usage

api_key=<AtD API key>

Description

This setting sets your AtD api key. You need to enable the AtD plugin before these settings have any effect. This can be done with the setting Plugins in the block [EditorSettings].
 This setting is left empty and disabled by default.

This setting is case sensitive.