XMLmind XML Editor - Online Help

XMLmind XML Editor - Online Help

Hussein Shafie

XMLmind Software

35 rue Louis Leblanc,
78120 Rambouillet,
France,
Phone: +33 (0)9 52 80 80 37,
Web: www.xmlmind.com/xmleditor
Email: <xmleditor-support@xmlmind.com> (public mailing list)

November 15, 2024

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. Installing XMLmind XML Editor (XXE for short)
2. Contents of the installation directory
3. Acknowledgments

2. Getting started with XMLmind XML Editor

II. Reference

1. File menu

1.1. 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

3. Edit menu

3.1. Comment menu
3.2. Processing instruction menu
3.3. Reference menu

4. Search menu

4.1. The "Find and Replace Element" menu
4.2. The "Web Search" menu

5. View menu

5.1. The "XML source" menu item

6. Tools menu

6.1. Remark menu
6.2. Revisions menu
6.3. "Helper Application" menu
6.4. "Record Macro" menu

7. XML menu

8. Options menu

8.1. "Customize Configuration" menu

9. Tab menu

10. Help menu

4. The document view area

5. The main tool bar

1. Buttons which are common to all document types
2. Buttons which are specific to type of the document being edited

6. The node selection bar

1. The node path bar

1.1. Non-editable nodes
1.2. Elements which are in non-validating mode
1.3. Configuring the node path bar to display the value of some attributes

2. Navigation tool bar

1. Edit tool

1.1. Reducing the number of elements displayed by the 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.1.1. Reducing the number of attributes displayed by the attribute table

3.2. Using the attribute form

4. Search tool

5. Characters tool

5.1. The “Favorites” palette

6. Validity tool

7. The "Browse Files" tool

7.1. Opening and comparing revisions of a document

8. The "Search Files" tool

8.1. The "Create or edit an advanced query" dialog box
8.2. Syntax of search queries

9. The Compare tool

9.1. Why use the Compare tool?
9.2. Using the Compare tool

8. Status bar

1. Validity state

2. Document cache indicator

3. Status messages

4. Spell checker

5. Overwrite mode

6. Clipboard utilities

6.1. Clipboard content

9. Dialog boxes

1. The URL chooser dialog box

1.1. The "Document conversion parameters" panel

2. The "Find and Replace Element" dialog box

3. The "Declare Namespace" dialog box

4. The "Attribute Value" dialog box

5. The "Check Spelling" dialog box

6. The "Preferences" dialog box

6.1. New options

6.2. Open options

6.3. Save options

6.4. Print options

6.5. Edit options

6.6. Web search options

6.7. View options

6.7.1. "CSS stylesheet defaults" subsection
6.7.2. "Tree view settings" subsection
6.7.3. Preferences related to images

6.8. Tools options

6.8.1. Master document options
6.8.2. Validate options
6.8.3. Spell options
6.8.4. Revisions options
6.8.5. Helper applications options

6.9. Install add-ons options

6.10. General options

6.10.1. Features Options

6.11. Advanced options

6.11.1. Cached data options
6.11.2. Proxies options

6.12. Add-on options

6.12.1. Apache FOP options
6.12.2. RenderX XEP options
6.12.3. Text format options
6.12.4. JSON format options

7. The "Tree view fonts and colors" dialog box

8. The "Helper Application Editor" dialog box

9. The "Save Document As Template" dialog box

9.1. Organizing the content of the File → New dialog box
9.2. Removing a previously defined document template

10. The "Save Selected Element as Template" dialog box

10.1. Advanced options
10.2. Removing a previously defined element template

11. The "Add Keyboard Shortcut" dialog box

11.1. Removing a previously defined keyboard shortcut

12. The "Customize CSS Stylesheet" dialog box

12.1. Quickly customizing the style of selected element

13. The "Customize Document Conversion Stylesheets" dialog box

13.1. Introduction

13.2. Reference

13.3. The "XMLmind XSL Customizer" application

13.3.1. Introduction
13.3.2. Reference

14. The "Install Add-ons" dialog box

14.1. Automatically upgrading installed add-ons
14.2. How to “manually” install, uninstall or upgrade an add-on

15. Dialog box allowing to edit “text style” menu items

15.1. Dialog box allowing to edit a “text style” menu item

16. The media player dialog box

16.1. Adding audio or video to your document

16.2. Using the media player dialog box

16.2.1. The Media tab
16.2.2. The Setup tab

17. The "Edit Image Map" dialog box

17.1. Adding an image map to your document

17.2. Using the image map editor

17.2.1. The toolbar of the image map editor
17.2.2. Specifying the link target and optionally the link text of selected area

17.3. Creating and using an annotated variant of image file

A. Command line options

1. Command line
2. Preference keys
3. Environment variables
4. System properties

List of Figures

3.1. Perform a web search using Google by pressing F3 and then g
3.2. A remark made by user hussein and its tooltip.
3.3. Remark editor #1 displayed when a new remark is to be inserted in the document
3.4. Remark editor #2 lets the user reply to a remark made by another user or modify her/his own remark or delete it
3.5. The "Open Revision" dialog box, here allowing to compare the document being edited (revision #4; latest one) to the initial revision (revision #1)
3.6. 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. Menu when an XHTML5 document is opened in XXE (inserting an element after a li)
7.2. Menu when a DITA topic is opened in XXE
7.3. The "Browse Files" tool showing the source files of our DITA tutorial
7.4. The "List Revisions" dialog box
7.5. Search our DITA tutorial for topic files (*.dita) containing substring "link"
7.6. The "Create or edit an advanced query" dialog box
7.7. The Compare tool showing the differences existing between doc.xml 1 (initial revision) and doc.xml (latest revision), displayed side by side
7.8. The Compare tool showing change #2
8.1. The clipboard viewer dialog box
9.1. An URL chooser dialog box having an expanded "Document conversion parameters" panel
9.2. The "Find and Replace Element" dialog box
9.3. The "Find Element" dialog box
9.4. The popup list displayed by the "History" button.
9.5. Composition area displayed below the caret
9.6. Dialog box allowing to add or edit a web search service specification
9.7. The "Install add-ons" preferences sheet
9.8. The "FOP" preferences sheet
9.9. The "Choose a TTF font and specify its aliases" dialog box
9.10. The "Text format" preferences sheet
9.11. The "Customize CSS Stylesheet" dialog box
9.12. Right-click popup menu of the "Customize CSS Stylesheet" dialog box
9.13. An easy to use style editor
9.14. The "CSS Source" tab of the style editor
9.15. Converting an XML document to an XSL-FO based format
9.16. Converting an XML document to an HTML-based format
9.17. The "Customize Document Conversion Stylesheets" dialog box showing the stylesheets used when a DITA map is converted to single-page XHTML
9.18. "XMLmind XSL Customizer" main window
9.19. The Add/Edit attribute dialog box
9.20. The Add/Edit parameter dialog box
9.21. The "Install Add-ons" dialog box
9.22. The Uninstall tab
9.23. Toggles found at the beginning of the DocBook tool bar
9.24. Customizing the items of the DocBook' “italic text style” menu
9.25. The menu item editor
9.26. Two embedded media players, one for video and the other for audio, both having controls
9.27. The right-click popup menu of a media player (audio only, no controls)
9.28. The Media tab of the media player dialog box
9.29. The Setup tab of the media player dialog box
9.30. The right-click, contextual, popup menu has an "Edit Image Map" entry
9.31. The "Edit Image Map" dialog box
9.32. The "Edit image map area" dialog box
9.33. The popup menu displayed by clicking the "Create and use an annotated variant of image file" toolbar button
9.34. Example of annotated image preceding an XHTML map

List of Tables

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
3.3. Example explaining the enhanced cross-reference creation/validation provided by a master document
9.1. DocBook example: change the ID of an element and update all links to this element
9.2. XHTML example: add attribute target="_blank" to all external links
9.3. Default language versus actual language example
9.4. 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.5. 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.6. When converting a DITA map to PDF, give a light gray background to all the topic titles
9.7. When converting a DITA map to PDF, use a 12pt base font size


		Part I. Getting started