XMLmind XML Editor - Configuration and Deployment

Hussein Shafie

Pixware

91 rue Gambetta,
78120 Rambouillet,
France,
Phone: +33 (0)1 30 59 81 44,
Web: www.xmlmind.com/xmleditor
Email:  (public mailing list)

March 27, 2014

Abstract

This document describes how to customize and deploy XXE.


Table of Contents

I. Guide
1. Introduction
2. Writing a configuration file for XXE
1. What is a configuration?
2. A configuration for the "Simple Section" document type.
3. Before writing your first configuration
4. Anatomy of a configuration file
5. Specifying which configuration to use for a given document type
6. Associating a schema to the opened document
7. XML catalogs
8. Document templates
9. CSS stylesheets
9.1. Styling images
9.2. Styling tables
10. A specific tool bar
10.1. Text style toggles
11. Element templates
12. A specific menu
12.1. About the table editing command
13. Specific keyboard shortcuts
13.1. About macro commands
14. Interactively resizing an image
15. Miscellaneous configuration elements
16. Converting an XML document to other formats
16.1. About process commands
17. Packaging your configuration for XXE add-on manager
3. Using HTML4 tables or CALS tables in your own custom schema
1. HTML4 tables
1.1. HTML4 table editor command
2. CALS tables
2.1. CALS table editor command
4. Customizing mouse and key bindings used by XXE
1. Bindings specific to a document type
2. Generic bindings
5. Customizing an existing configuration
1. Adding a custom document template
2. Replacing an existing document template
3. Removing an existing document template
4. Adding a custom CSS style sheet
5. Replacing an existing CSS style sheet
6. Removing an existing CSS style sheet
7. Adding buttons to the tool bar
8. Adding items to the menu
9. Parametrizing the XSLT style sheets used in the Convert Document submenu
10. Customizing the XSLT style sheets used in the Convert Document submenu
11. Using a custom CSS style sheet to style the HTML files generated by the Convert Document submenu
6. Deploying XXE
1. Dynamic discovery of add-ons
1.1. The lookup phase during XXE startup
1.2. Files containing the add-ons
2. Centralizing add-ons on a HTTP server
3. Deploying XXE using Java™ Web Start
3.1. The deploywebstart command-line tool
3.2. Deploying XXE using Java™ Web Start, a step by step description
3.3. Comparison between deployment using Java Web Start and just centralizing the add-ons on a HTTP server
4. Deploying XXE as an applet
4.1. Requirements
4.2. Testing the XXE applet, a step by step description
4.3. Integrating the applet with your web application
4.3.1. Dynamically generating an HTML page referencing the applet
4.3.2. The four different kinds of applet
4.3.3. Applet parameters
4.3.4. Applet scripting
II. Reference
7. Configuration elements
1. attributeEditor
2. binding
3. command
3.1. About command names
4. configuration
5. css
6. DTD
7. detect
8. documentResources
9. documentSetFactory
9.1. Bean properties
10. elementTemplate
10.1. Adding empty text nodes to your element templates
10.2. Specificities of selectable="override"
11. help
12. imageToolkit
13. include
14. inclusionScheme
15. linkType
15.1. Using linkType to implement link navigation
15.2. Using linkType to implement link validation
15.3. Using linkType to define custom, specialized, attribute editors
16. menu
16.1. Customizing a menu or a toolBar without redefining it from scratch
16.2. Multiple menus
17. newElementContent
18. property
19. parameterGroup
20. parameterSet
21. preserveSpace
22. relaxng
23. saveOptions
24. schema
25. schematron
25.1. Relationship between schematron and validateHook
26. spellCheckOptions
27. Custom spreadsheet functions
28. template
29. toolBar
29.1. Custom controls
29.1.1. The TextStyleMenu custom control
29.1.2. The TextStyleToggle custom control
29.1.3. The ListTypeMenu custom control
29.2. Multiple toolBars
30. translation
31. validate
32. validateHook
33. windowLayout
34. Custom configuration elements

List of Figures

2.1. The "Simple Section" tool bar
2.2. The "Simple Section" menu
2.3. Resize handles around an image

List of Tables

7.1. TextStyleMenu properties
7.2. TextStyleToggle properties

List of Examples

6.1. -applet viewer example: open a document stored on an HTTP server
6.2. Same example as above, but force the value of the defaultFontSize user preference in order to use a larger font to display the document
6.3. -applet editor1 example: create a new DocBook article
6.4. -jsapplet editor2 example: open a document stored on a WebDAV server requiring the user to authenticate himself
6.5. The online demo of editor1.
7.1. DocBook 4 example
7.2. Simplest TextStyleMenu custom control
7.3. Customizable TextStyleMenu custom control
7.4. Simplest TextStyleToggle custom control
7.5. “Active” TextStyleToggle custom control
7.6. “Active” TextStyleToggle custom control showing a label in addition to an icon
7.7. Simplest ListTypeMenu; may be used in the DITA Topic configuration
7.8. DocBook 5 ListTypeMenu
7.9. XHTML 1.0 Strict ListTypeMenu; most complex specification because the type of the list must be specified using a CSS style