XMLmind XML Editor - Online Help

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)

April 2, 2013

Abstract

This online help contains, in addition to a short tutorial, the reference manual of all the menus, tool bars and dialog boxes of XMLmind XML Editor (XXE for short).


Table of Contents

I. Getting started
1. Install
1. Installing XMLmind XML Editor (XXE for short)
2. Contents of the installation directory
3. Acknowledgments
2. Getting started with XMLmind XML Editor
II. Reference
3. Menus
1. File menu
1.1. "Document Set" menu
1.2. Folder menu
2. Select menu
2.1. The selection in XXE
2.1.1. Text selection
2.1.2. Node selection
2.1.3. Implicit element selection
2.2. Select menu items
2.2.1. Link submenu
2.2.2. Navigation submenu
3. Edit menu
3.1. Comment menu
3.2. Processing instruction menu
3.3. Reference menu
4. Search menu
4.1. Web Search menu
5. View menu
6. Tools menu
6.1. Remark menu
6.2. Changes menu
6.3. "Helper Application" menu
6.4. Spreadsheet menu
6.5. "Record Macro" menu
7. XML menu
8. Options menu
8.1. "Customize Configuration" menu
9. Window menu
10. Help menu
4. The document view area
5. Main tool bar
6. The node selection bar
1. The node path bar
1.1. Non-editable nodes
1.2. Elements which are in non-validating mode
2. Navigation tool bar
7. Tools
1. Edit tool
2. Include tool
2.1. Working with ``XML variables''
2.2. Using the Include tool
3. Attributes tool
3.1. Using the attribute table
3.2. Using the attribute form
4. Search tool
5. Spell tool
6. Character tool
6.1. The “Favorites” palette
7. Validity tool
8. The "Document Set" tool
8.1. What is a document set?
8.2. How to open a document set in XXE?
8.3. The "Document Set" tool
8.4. Using the "Document Set" tool
9. The "Browse Files" tool
10. The "Search Files" tool
10.1. The "Create or edit an advanced query" dialog box
10.2. Syntax of search queries
11. The Compare tool
11.1. Why use the Compare tool?
11.1.1. A common use case
11.2. Using the Compare tool
8. Status bar
1. Validity state
2. Document cache indicator
3. Status messages
4. Automatic spell checker
5. Overwrite mode
6. Clipboard utilities
6.1. Clipboard content
9. Dialog boxes
1. The URL chooser dialog box
2. The "Find Element" dialog box
2.1. The "Simple" tab
2.2. The "Advanced" tab
3. The "Declare Namespace" dialog box
4. The spreadsheet formula editor
5. The "Preferences" dialog box
5.1. New options
5.2. Open options
5.2.1. Document Set options
5.3. Save options
5.4. Print options
5.5. Edit options
5.6. Web search options
5.7. View options
5.7.1. "CSS stylesheet defaults" subsection
5.7.2. "Tree view settings" subsection
5.8. Tools options
5.8.1. Validate options
5.8.2. Spell options
5.8.3. Changes options
5.8.4. Helper applications options
5.8.5. Spreadsheet options
5.9. Window options
5.10. Install add-ons options
5.11. General options
5.11.1. Features Options
5.12. Advanced options
5.12.1. Cached data options
5.12.2. Proxies options
6. The "Tree view fonts and colors" dialog box
7. The "Helper Application Editor" dialog box
8. The "Save Document As Template" dialog box
8.1. Organizing the content of the FileNew dialog box
8.2. Removing a previously defined document template
9. The "Save Selected Element as Template" dialog box
9.1. Advanced options
9.2. Removing a previously defined element template
10. The "Add Keyboard Shortcut" dialog box
10.1. Removing a previously defined keyboard shortcut
11. The "Customize Document Conversion Stylesheets" dialog box
11.1. Introduction
11.2. Reference
11.3. The "XMLmind XSL Customizer" application
11.3.1. Introduction
11.3.2. Reference
12. The "Change Document Conversion Parameters" dialog box
12.1. The "Parameter Set Chooser" dialog box
13. The "Install Add-ons" dialog box
14. Dialog box allowing to edit “text style” menu items
14.1. Dialog box allowing to edit a “text style” menu item
A. Command line options
1. Command line
2. Preference keys
3. Environment variables
4. System properties
B. Description of the XML differencing algorithm implemented in the Compare tool
1. Comparison with other approaches
2. Elements are given serial numbers
3. A simple XML differencing algorithm

List of Figures

2.1. A newly created chapter
2.2. The node path bar
2.3. The text selection
2.4. The "Convert to emphasis" toolbar button
2.5. The Edit tool
2.6. Explicitly selected section
2.7. The "Add table" toolbar button
2.8. The Clipboard tool
2.9. Before pressing the Ins key
2.10. After pressing the Ins key
2.11. The Attributes tool
2.12. A modular book including a chapter found in a separate document
3.1. Perform a web search using Google by pressing F3 and then g
3.2. A remark made by use bart and its tooltip.
3.3. The "Helper Application Not Found" dialog box
4.1. Tab corresponding to the active document
4.2. Tab corresponding to the active document when it is in read-only mode
7.1. A document set specified by a DITA map and 3 topic members opened in XXE
7.2. A document set specified by a modular DocBook book and 3 chapter or section members opened in XXE
7.3. A document set specified by a glob pattern and 3 XHTML page members opened in XXE
7.4. The "Document Set" tool showing the document set corresponding to the map of our DITA tutorial
7.5. The "Browse Files" tool showing the source files of our DITA tutorial
7.6. Search our DITA tutorial for topic files (*.dita) containing substring "link"
7.7. The "Create or edit an advanced query" dialog box
7.8. The Compare tool showing the differences existing between doc.xml (the initial document) and docB.xml (a revision of doc.xml), displayed side by side
7.9. The Compare tool showing change #1 (involving a remark made by user bart) expanded
9.1. Composition area displayed below the caret
9.2. Dialog box allowing to add or edit a web search service specification
9.3. Converting an XML document to an XSL-FO based format
9.4. Converting an XML document to an HTML-based format
9.5. The "Customize Document Conversion Stylesheets" dialog box showing the stylesheets used when a DITA map is converted to single-page XHTML
9.6. "XMLmind XSL Customizer" main window
9.7. The Add/Edit attribute dialog box
9.8. The Add/Edit parameter dialog box
9.9. The "Parameter Set Chooser" dialog box
9.10. Toggles found at the beginning of the DocBook tool bar
9.11. Customizing the items of the DocBook' “italic text style” menu
9.12. The menu item editor

List of Tables

2.1. Edit tool commands
9.1. Lock Types
9.2. Substituted Variables

List of Examples

3.1. A use case for command Force Deletion
3.2. Example: book referencing chapters
7.1. Default language versus actual language example
7.2. A simple use case
9.1. When converting a DITA map to PDF, use a 12pt base font size and give a light gray background to all the topic titles
9.2. When converting a DITA map to single-page XHTML, use a 12pt base font size and give a light gray background to all the topic titles
9.3. When converting a DITA map to PDF, give a light gray background to all the topic titles
9.4. When converting a DITA map to PDF, use a 12pt base font size