3. Using the Configuration Tool
The Configuration Tool allows the developer to easily customize Ephox EditLive! for Java by manipulating a simple Graphical User Interface (GUI). Each of the following sections outlines all that is needed for the developer to begin successfully using the Configuration Tool.
This document is intended for system administrators, application programmers, and business analysts who will use the Configuration Tool for customizing the various features of EditLive! for Java.
EditLive! for Java uses an XML file to configure its attributes when loaded within an application. This provides developers with a simple way to configure EditLive! for Java without having to resort to complicated API calls. The Configuration Tool provides a simple user interface for building and editing these EditLive! for Java XML configuration files.
The Configuration Tool is used to create and edit existing .xml Ephox EditLive! for Java configuration files. Using the Configuration Tool is the recommended way to create such files.
Alternatively, those familiar with XML and Document Type Definitions (DTD) (view the DTD document), may wish to edit the XML file directly, without the aid of the Configuration Tool.
To run the configuration tool, once you have successfully installed EditLive! for Java (see Installation Guide):
To create a new configuration file do one of the following:
By selecting the Blank XML File option, an empty configuration file is created. The file created contains no configuration information and the entire configuration file must be created from scratch.
By selecting the Default XML File option, a non-empty default configuration file will be created. This file contains the default settings for EditLive! For Java. This will often be a good place to start for most users, as the majority of the settings contained in the Default XML configuration file will be suitable for most users.
In order to open an existing configuration file:
Before you can open a file, you will be asked if you want to save the current configuration file. Please refer to Saving a Configuration File for more information. Once you have finished saving or otherwise the existing configuration file, you will be asked to select the file you would like to open. You should navigate through the file system as necessary to locate the .xml EditLive! for Java configuration file you would like to open.
If you get a File Error when you try to open your configuration file, please check the following:
After you have successfully selected an .xml EditLive! for Java configuration file to open, the selected file will be parsed by the Configuration Tool.
At completion of parsing (or parsing as far as possible), the Configuration Tool will notify the user of the outcome of parsing. The user will be presented with either of the following dialogs:
The user may begin editing the configuration file through the GUI as they please. Refer to Using the Configuration Tool for more information on how to use the Configuration Tool's GUI.
Once you have finished editing the contents of the configuration file through the GUI, you can then save your file in a format that can be used by EditLive! for Java for configuration purposes. In order to save your file simply do one of the following:
Note: If during an attempt to save the file, a dialog with the title File Name Error appears, you are trying to save a file with the name "default.xml" or "blank.xml". These are special reserved names which can not be used, as both "default.xml" and "blank.xml" are special files that are provided with the Configuration Tool.
The save methods of the Configuration Tool work in a What-You-See-Is-What-You-Get (WYSIWYG) manner. This is regardless of the contents of the initial file you may have started with (if you are editing an existing file), the contents of the saved file will match exactly the values contained in the Tool's GUIs. Hence, if a file with errors is opened in the Configuration Tool and saved immediately, only the data from the corrupt file that appears in the GUI objects will be saved out to file (i.e. all errors will thus be removed).
You will also be asked if you would like to save the current file (even if it is the "default.xml" or "blank.xml" files, though obviously you will need to select a new name if this is the case) when ever you try to open an existing or new file or exit. Simply follow the above procedure if you would like to save the file.
Reloading of the configuration file may be a useful facility for some users. Reloading the file simply re-reads the current file, and hence the GUIs are refreshed according the file's contents. The Configuration Tool does not dynamically change the contents of the file being edited. The current file remains completely unchanged (except for the location of the DTD file, which will be changed to the location of the Configuration Tool's DTD file before the file is parsed). To reload a file simply:
This will be generally be a useful facility if:
To quit the Configuration Tool, do one of the following:
When attempting to quit the program, you will be asked if you would like to save changes to the current file before exiting.
The goal of the Configuration Tool is to provide the developer/user with a simple and quick means of creating configuration files for EditLive! for Java. Once you have created your configuration files, you must tell EditLive! for Java which file you wish to use for configuration. Please refer to the article on the EditLive! for Java configuration file property, for details on how to set this property in EditLive! for Java.
You can configure the various Document properties you would like to use in EditLive! for Java.
The following properties are defined in the .xml configuration file for this purpose.
HEAD - Base URL instructs the browser about the URL path to the current document. This URL will be used as the base URL for all relative URL references within this document.
To set HEAD - Base URL:
Example: Base URL = http://www.yourserver.com/folder/
HEAD - Title is the title of the document as displayed in the browser's window title bar.
To set HEAD - Title:
Example: Title = Default Document Title
META tags are used to provide additional, hidden information about the document. META tags can also be used to provide extra information that some search engines may use for indexing and categorizing your document.
A META tag must contain a Content attribute and either a HTTP-EQUIV attribute or a Name attribute. The Content acts as a value in a 'name/value' pair and may contain multiple values, separated by a comma. HTTP-EQUIV can be used to provide extra information when the HTTP Protocol is being used to send a document to a client. Name is often a term to describe the purpose of the particular META tag.
To add a META tag:
Example: <META HTTP-EQUIV = "refresh" CONTENT = "1,http://www.ephox.com/index.html">
Example: <META NAME = "Author" CONTENT = "Mr Brown">
To remove a META tag:
To modify a META tag:
Style sheet links allow the document to establish a link to an external Cascading Style Sheet (CSS). By using a style sheet all content style (e.g. font, font size, type face) can be defined in a central style sheet. All style sheet links will be of type "text/css" and relationship "stylesheet".
To add a style sheet link:
To remove a style sheet link:
To modify a style sheet link:
Body properties can be set up to influence how the actual contents of the document will be displayed.
Example : Background = myPicture.gif , BG Color = white , Link = red , Text = #ff0000, Visited Link = blue , Active Link = #ffcc00 .
BODY - Background property specifies the image file that will be used in the background.
BODY - BG Color property specifies the color that will be displayed behind all content, text or otherwise.
BODY - Link property specifies the color of a hyperlink that has yet to be visited.
BODY - Text property specifies the color of the text in the body of this document.
BODY - Visited Link property specifies the color of a hyperlink after it has been visited by a user.
BODY - Active Link property specifies the color of a hyperlink when it is activated (i.e. being clicked on) by a user.
To modify the properties of the document's body:
Each EditLive! for Java domain will have a license file, provided by Ephox. You can configure a list of EditLive! for Java license files, so that a different configuration file will not be required for each domain. This is done by selecting license files to add to a list of license files for your configuration file. For more information on EditLive! for Java licensing information, please contact our support team.
To add a license file:
To remove a license file:
In the Selected Licenses list, only Domain, Type and Licensee are displayed. These values will be unique for each license. To see more information, view properties.
To view the properties of a license file:
If you need more information regarding licenses, or the meanings of any of the Licensee property fields, please contact our support team.
Disabling the splash screen.
The EditLive! splash screen can be disabled by unchecking "Show Splash Screen When Starting Up".
You can add any appropriate spell checker .jar you choose to act as the spell checker in EditLive! for Java. You only have to provide the URL address of the spell checker .jar location.
To set the spell checker for EditLive! for Java:
HTML Filter allows various filtering configurations to be set.
The following properties are defined in the .xml configuration file for this purpose.
Character Encoding sets what character set will be used to encode the HTML. The only supported encodings currently available are ascii or latin.
To set the character encoding:
Wrap Length sets the default wrap margin. The default is 68.
To set the wrap length:
Logical Emphasis option, when added, replaces 'i' by 'em' and 'b' by 'strong'.
Uppercase Attributes option, when added, outputs attributes in upper not lower case.
Uppercase Tags option, when added, outputs tags in upper not lower case.
Remove Font Tags option, when added, discards presentation tags.
Quote Marks option, when added, outputs " marks as "
Indent Content option, when added, indents the content of appropriate tags.
Output XHTML option, when added, outputs extensible HTML.
Output XML option, when added, creates output as XML.
To add any of the above options:
To remove any of the options that have been added:
This option will set how import from Microsoft Word 2000 for Windows will be handled.
EditLive! for Java provides a full integrated Image Management service.
Users can add images from a local computer and have these images automatically uploaded to a web server. When inserting and uploading images to a remote server, EditLive! for Java uses the HTTP POST protocol for greater security. HTTP image upload is utilized when a user wishes to insert a local image, while using EditLive! for Java. The following properties are defined in the .xml configuration file for this purpose.
A list of server images can also be added to the configuration file. This allows site developers to build and deploy a central server-based image library. This central image library can then be easily accessed by your users of EditLive! for Java. The various properties of each image can be manipulated in the Configuration Tool. The image properties supported by EditLive! for Java are:
The following settings for image upload MUST be set up in the Configuration Tool in order for the image upload functionality within EditLive! for Java to work correctly.
HTTP Image Upload URL is the location of the upload script responsible for uploading images.
In order to upload local images to the remote server via HTTP, you will need a server-side image upload handler script that accepts the images on the server and stores them in the correct directory. This script is the same script that would be used for uploading any file to the server via the HTTP POST method. For example, when you use a file input element (i.e. <INPUT type="file">), the script specified in the ACTION attribute of the form element is used to upload the file to the server. This is the same script specified in EditLive! for Java to upload local images inserted into EditLive! for Java to the remote server.
We have available for download some sample image upload handler scripts for certain server-side languages. Please click on the relevant links below to obtain these.
To set the HTTP image upload URL value:
Example: URL = http://www.yourServer.com/upload/upload.asp
HTTP Image Upload Base is the location of the base URL for your images. Your images, after being uploaded, can be found by pointing a browser to the base address you supply here.
To set the HTTP image upload Base value:
Example : Base = http://www.yourServer.com/userimages/
In some situations it may be desirable to specify addition HTTP headers when uploading an image.
To provide additional HTTP headers:
Preventing User Specified Images
Users can be prevented from inserting and uploading local images by unchecking "Allow users to insert local images". In addition to this, users can be prevented from specifying URLs for images by unchecking "Allow users to type in image paths". To restrict users to only using the images specified in the image list, uncheck both these boxes.
Site developers can build a central image library for users to access. This is done by adding the images you would like to make available to the Image List within the Configuration Tool. The properties for an image you can edit are defined below. Please note that some of these properties are compulsory.
Name property defines a unique name you give to the image. COMPULSORY FIELD.
URL property defines the URL of the image file. COMPULSORY FIELD.
Description property is any description the user may wish to attach to the image. COMPULSORY FIELD.
Title property provides an advisory description of the element. Some browsers may use this property value as a ToolTip for the image.
Height, Width properties define the dimensions of the space that will reserved for the image on the page. This does not have to be the actual dimensions of the image.
Border property defines the thickness of the border around the image.
VSpace property defines the vertical padding applied around the image, in pixels.
HSpace property defines the horizontal padding applied around the image, in pixels.
Alignment property defines how the image will be rendered in physical relation to the surrounding content. Acceptable values for this field are : "bottom", "left", "middle", "right", "top".
Alt Text property defines a text value for the image, for users whose can not, or choose not to download images.
To add an image to the Image List:
To remove an image from the Image List:
To modify an image from the Image List:
EditLive! for Java provides a full integrated Hyperlink Management service.
A list of hyperlinks and e-mail addresses can be added to the configuration file. The various properties of each hyperlink and e-mail address can be manipulated in the Configuration Tool. This allows site developers to build and deploy a central server-based hyperlink library. This central hyperlink library can then easily be accessed by your users of EditLive! for Java. The hyperlink properties supported by EditLive! for Java are:
The e-mail properties supported by EditLive! for Java are:
Site developers can build a central hyperlink library for users to access. This is done by adding the hyperlinks you would like to make available to the Hyperlink list. The properties for a hyperlink you can edit are defined below:
Description property is any description the user may wish to attach to the hyperlink. COMPULSORY FIELD.
URL property sets the destination of the hyperlink. COMPULSORY FIELD.
Target property defines the window or frame name in which the destination document is to be loaded into, if it is not going to be loaded into the current window.
Title property provides an advisory description of the element. Some browsers may use this property value as a ToolTip for the hyperlink.
Name property can be used to specify an anchor within a document. An anchor is a link to another section of the same document.
To add a hyperlink:
To remove a hyperlink:
To modify a hyperlink:
Site developers can build a central e-mail address library for users to access. This is done by adding the e-mail addresses you would like to make available to the E-mail Link list. The properties for an e-mail link you can edit are defined below:
Description property is any description the user may wish to attach to the e-mail address. COMPULSORY FIELD.
E-mail property sets the e-mail address you wish to add. COMPULSORY FIELD.
To add an e-mail link:
To remove an e-mail link:
To modify an e-mail link:
EditLive! for Java allows its menus to be completely customized. You can set the menu names to be whatever you please, and specify which menu items you wish to include in each menu. You do not have to include all available menu items if you do not want to, but the same menu item cannot be in two different menus.
By holding down the Control button on your keyboard, you can select multiple menu items at the one time. Also, by pushing CTRL+A you can select all menu items in the selected list.
A menu separator is a thin line that separates items in a menu. You can have as many menu separators are you choose. They are represented as "< Menu Separator >" in the lists.
A menu name is the name of a menu. e.g. File.
A menu item is the name of the item in a menu. e.g. The File menu contains an Open menu item.
To add a new menu name:
Note: The order that your menu names appear in the Menu Name list, is the same order the menus will appear in EditLive! for Java.
To remove a new menu name:
Note: Removing a menu name makes all the menu items selected by that menu available again.
The supported menu items are:
To add one or more menu items to a menu:
Note: The order that your menu items appear in the Selected Menu Items list, is the same order the menu items will appear in EditLive! for Java.
To remove one or more menu items from a menu:
Note: We recommend using the standard names, "Edit", "View", "Insert", "Table" for your menu names. The recommended layout for these menus can be found by loading a new Default XML file and clicking the Menus tab.
EditLive! for Java allows its shortcut menu to be completely customized. You can add the items you would like in the order you would like to see them in your shortcut menu.
By holding down the Control button on your keyboard, you can select multiple menu items at once. Also, by pushing CTRL+A you can select all menu items in the selected list.
A menu separator is a thin line that separates items in a menu. You can have as many menu separators are you choose. They are represented as "< Menu Separator >" in the lists.
The supported shortcut menu items are:
To add one or more menu items to the shortcut menu:
To remove one or more menu items from the shortcut menu:
Note: The order that your menu items appear in the Selected Menu Items list, is the same order the menu items will appear in the EditLive! for Java shortcut menu.
EditLive! for Java provides users with two toolbars, the Format Toolbar and the Command Toolbar. The contents and layout of these two toolbars are fully customizable. As well as toolbar buttons, three combo boxes can be added to the toolbars; Style, Size and Face ( Font ).
The actual toolbars you will see in EditLive! for Java will appear exactly the same as you set them up in the Configuration Tool. The default size of the toolbars in EditLive! for Java is shown by a thin vertical line labelled as Default Size of Standard Toolbar. You should ensure that all toolbar items you add to your toolbar fit within this boundary, otherwise your toolbar may not be represented correctly in EditLive! for Java.
Toolbar Buttons Configuration
The supported toolbar buttons are:
A Toolbar Button Group, is a group of buttons that will be added. You can not add the buttons in a button group individually. The supported Toolbar Buttons Groups are:
To add a toolbar button or button group to a toolbar:
To remove one or more toolbar buttons from a toolbar:
A toolbar separator is a thin line that separates items in a toolbar. You can have as many toolbar separators are you choose.
To add a toolbar separator:
You can only remove a toolbar separator when it is the end item on the toolbar.
To remove a toolbar separator:
EditLive! for Java toolbar supports three types of Combo Boxes:
Style Combo Box allows you to select which HTML styles you wish to support and the text you would like to associate with each style (i.e. what text you wish to appear in the combo box to represent that style). To add a style, select the style tag checkbox you wish to add and then edit its text box. To remove a style tag, simply clear its corresponding style tag checkbox. The styles supported by the Style Combo Box are:
Size Combo Box allows you to select what standard font sizes you would like to support. To add a size, select the size tag checkbox you wish to add and then edit its text box. To remove a size tag, simply clear its corresponding size tag checkbox. The sizes supported by the Size Combo Box are:
Font Combo Box allows you to select all the fonts you would like to be displayed in your Font Combo Box. All the fonts on your current system will be displayed in the Available Fonts list. To add a font simply select all the fonts from the Available Fonts list you would like to add and the click > (right arrow button), or click Other Font to add some other font not in the Available Fonts list. To remove a font, simply select all the fonts from the Selected Fonts list you would like to remove and the click < (left arrow button). The order of the fonts in the combo box will always be in alphabetical order.
To modify the properties of a combo box item:
In order to directly edit .xml EditLive! for Java configuration files, without the aid of the Configuration Tool, we strongly recommend you follow the following procedure:
Note: This is not the recommended procedure for creating .xml EditLive! for Java configuration files. We recommend using the Configuration Tool itself to create and edit the necessary files to ensure that EditLive! for Java's interface is configured correctly.
There are two possible types of parsing errors that may occur, and below outlines some ways of handling these situations. Any .xml EditLive! for Java configuration file created with the Configuration Tool will not contain any parsing errors. Only files creating by editing xml files directly will contain these errors. For this reason, it is recommended that you use the Configuration Tool to create your configuration files.
If you find the Configuration Tool will not load up correctly (i.e. it does not load up with default.xml), please ensure the following is not occurring:
If are having trouble loading in an xml configuration file please ensure that it is not Read-Only, or the Configuration Tool probably won't be able to read in the data at all.
Copyright © 2001-2004 Ephox Corporation. All Rights Reserved.