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)

July 9, 2014

Abstract

This document describes how to customize and deploy XXE.


Table of Contents

I. Configuration 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
II. Configuration reference
6. 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. preserveSpace
21. relaxng
22. saveOptions
23. schema
24. schematron
24.1. Relationship between schematron and validateHook
25. spellCheckOptions
26. Custom spreadsheet functions
27. template
28. toolBar
28.1. Custom controls
28.1.1. The TextStyleMenu custom control
28.1.2. The TextStyleToggle custom control
28.1.3. The ListTypeMenu custom control
28.2. Multiple toolBars
29. translation
30. validate
31. validateHook
32. windowLayout
33. Custom configuration elements
III. Deploying XXE
7. The XXE desktop application
1. Dynamic discovery of add-ons
1.1. Additional or alternative addon/ directories
8. Deploying XXE using Java™ Web Start
1. What is Java™ Web Start?
2. Deploying XXE using Java™ Web Start, a step by step description
9. Deploying XXE as a Java™ applet
1. What is a Java applet?
2. Deploying XXE as an applet, a step by step description
3. Integrating the XXE applet with your web application
3.1. Applet parameters
3.2. Applet scripting
10. Embedding XXE in a third-party Java™ application
11. The deployxxe command-line tool
1. Why use deployxxe?
2. deployxxe reference

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

6.1. TextStyleMenu properties
6.2. TextStyleToggle properties

List of Examples

6.1. DocBook 4 example
6.2. Simplest TextStyleMenu custom control
6.3. Customizable TextStyleMenu custom control
6.4. Simplest TextStyleToggle custom control
6.5. “Active” TextStyleToggle custom control
6.6. “Active” TextStyleToggle custom control showing a label in addition to an icon
6.7. Simplest ListTypeMenu; may be used in the DITA Topic configuration
6.8. DocBook 5 ListTypeMenu
6.9. XHTML 1.0 Strict ListTypeMenu; most complex specification because the type of the list must be specified using a CSS style
9.1. Open a document found on an HTTP server
9.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
9.3. Create a new DocBook article
9.4. Open a document stored on a WebDAV server requiring the user to authenticate himself
9.5. The Simple XML Editor Applet Demo