Ephox EditLive! for XML Developer's Guide

Version 3.1

Ephox Corporation

All rights reserved. This document forms part of Ephox products and is licensed under the same terms as the software. The authors have made every effort in the preparation of this book to ensure the accuracy of the information. However, the information contained in this book is sold without warranty, either express or implied. Ephox Corporation, nor its dealers or distributors will be held liable for any damages caused or alleged to be caused either directly or indirectly by this book.


Table of Contents

1. Introduction
Ephox EditLive! for XML Product Information
System Requirements
2. EditLive! for XML Install Guide
General Server Install Instructions
Ephox EditLive! for XML Generic Installation Guide
Ephox EditLive! for XML IIS Installation Guide
Ephox EditLive! for XML Sample Java Server Installation with Apache Tomcat
Deploying to an External Web Server
EditLive! for XML Client Install
3. Getting Started
EditLive! for XML Configuration
EditLive! for XML Configuration Tool
Licensing EditLive! for XML
EditLive! for XML Overview
Load Time Troubleshooting
Run Time Troubleshooting
4. Integrating EditLive! for XML
Basic Integrations
Default Values of EditLive! for XML Load-Time Properties
Retrieving Content from Ephox EditLive! for XML
Submitting EditLive! for XML Content Directly Via HTTP POST
Encoding Content for Use with EditLive! for XML
5. Visual Designer
Deploying the Visual Designer
Using the Visual Designer
6. Cascading Style Sheet Support
Ephox EditLive! for XML and CSS
Using Ephox CSS Extensions with Custom Tags
7. Deployment Optimizations
Minimizing an EditLive! for XML Deployment
Optimizing EditLive! for XML Load Times
8. Customizing EditLive! for XML
Creating Custom Dictionaries for Ephox EditLive! for XML
Customizing the EditLive! for XML Interface
Custom Menu and Toolbar Items
9. Using JavaScript for Customization
Custom Properties Dialogs for EditLive! for XML
Raising a JavaScript Event from Ephox EditLive! for XML
10. Multimedia Support
HTTP Upload Support for Images and Multimedia
Embedded Object (Multimedia) Support
Image Insertion Dialog's Browser Component
11. Using WebDAV with EditLive! for XML
Using WebDAV with EditLive! for XML
Enabling WebDAV on a Web Server
12. Internationalization Support
Using Different Dictionaries with Ephox EditLive! for XML
Using Different Character Sets with EditLive! for XML
13. EditLive! Equation Editor
EditLive! Equation Editor Integration
14. Ephox CSS Extensions for Custom Tags
display Attribute
ephox-end-icon Attribute
ephox-end-label Attribute
ephox-icon Attribute
ephox-label Attribute
ephox-start-icon Attribute
ephox-start-label Attribute
15. Using EditLive! for XML Without The Visual Designer
Creating XSLTs Without The Visual Designer
Using Ephox XSLT Extensions
ephox:button Element
ephox:autoaddbuttons Attribute
ephox:displayas Attribute
ephox:items and ephox:displayitems Attributes
ephox:readonly Attribute
ephox:if Element
16. Instantiation API
EditLive! for XML JavaScript Constructor
Visual Designer JavaScript Constructor
addView Method
addViewAsText Method
addXSDAsText Method
show Method
showAsButton Method
addJar Property
AutoSubmit Property
BaseURL Property
ConfigurationFile Property
ConfigurationText Property
Cookie Property
DebugLevel Property
Document Property
DownloadDirectory Property
HideButtonIconURL Property
HideButtonText Property
HttpLayerManager Property
JREDownloadURL Property
LocalDeployment Property
Locale Property
MinimumJREVersion Property
OnInitComplete Property
OutputCharset Property
Preload Property
setSolution Method
ShowButtonIconURL Property
ShowButtonText Property
ShowSystemRequirementsError Property
UseMathML Property
UseWebDAV Property
XSDAsText Property
XSDURL Property
17. JavaScript Runtime API
GetCharCount Function
GetDocument Function
GetSelectedText Function
GetWordCount Function
InsertHTMLAtCursor Function
InsertHyperlinkAtCursor Function
IsValid Function
PostDocument Function
SetDocument Function
SetProperties Function
SetXMLNodeValue Function
UploadImages Function
18. XML Configuration API
<editLive> Configuration Element
<document> Configuration Element
<html> Configuration Element
<head> Configuration Element
<base> Configuration Element
<link> Configuration Element
<style> Configuration Element
<ephoxLicenses> Configuration Element
<license> Configuration Element
<otherLicenses> Configuration Element
<webeqLicense> Configuration Element
<spellCheck> Configuration Element
<htmlFilter> Configuration Element
<wysiwygEditor> Configuration Element
<xmlEditor> Configuration Element
<customTags> Configuration Element
<doubleClickActions> Configuration Element
<action> Configuration Element
<sourceEditor> Configuration Element
<wordImport> Configuration Element
<htmlImport> Configuration Element
<mediaSettings> Configuration Element
<httpUpload> Configuration Element
<httpUploadData> Configuration Element
<images> Configuration Element
<httpImageUpload> Configuration Element
<imageList> Configuration Element
<image> Configuration Element
<webdav> Configuration Element
<repository> Configuration Element
<imageBrowser> Configuration Element
<multimedia> Configuration Element
<types> Configuration Element
<type> Configuration Element
<param> Configuration Element
<authentication> Configuration Element
<realm> Configuration Element
<hyperlinks> Configuration Element
<hyperlinkList> Configuration Element
<hyperlink> Configuration Element
<mailtoList> Configuration Element
<mailtolink> Configuration Element
<menuBar> Configuration Element
<menu> Configuration Element
<menuItem> Configuration Element
<designerMenuItem> Configuration Element
<menuItemGroup> Configuration Element
<menuSeparator> Configuration Element
<customMenuItem> Configuration Element
<submenu> Configuration Element
<toolbars> Element
<toolbar> Configuration Element
<toolbarButtonGroup> Element
<toolbarSeparator> Configuration Element
<toolbarButton> Element
<toolbarComboBox> Element
<comboBoxItem> Configuration Element
<customToolbarButton> Configuration Element
<customToolbarComboBox> Configuration Element
<customComboBoxItem> Configuration Element
<shortcutMenu> Configuration Element
<shrtMenu> Configuration Element
<shrtMenuItem> Configuration Element
<shrtMenuSeparator> Configuration Element
<elementMenu> Configuration Element
<elementMenuItem> Configuration Element
Index