XMLmind XML Editor - Commands

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:  (public mailing list)

April 26, 2022

Abstract

This document contains the reference of all native XXE commands and explains how to write custom macro-commands.


Table of Contents
I. Guide
1. What is a command?
2. Writing macro-commands
1. How commands are executed
2. A sequence of commands
3. Alternative commands
4. Testing if a command can be executed
5. The "%_" variable
6. Macro-variables
7. Simple use of named variables
8. General use of get
9. Variables mapped to the selection in XXE
10. Contextual commands
II. Reference
3. Menu commands
1. Reference
2. Redefining or extending the right-click, contextual, popup menu
4. Macro commands
1. Reference
1.1. Pass and fail cheat sheet
1.2. Macro-variables
1.3. XPath variables
1.3.1. User variables
1.3.2. Predefined variables
2. Running XED scripts in a macro
3. Examples
5. Process commands
1. Reference
1.1. Attributes
1.2. Element copyDocument
1.2.1. Attributes
1.2.2. Element extract
1.2.3. Element resources
1.3. Element convertImage
1.3.1. Parameters supported by the built-in Java image toolkit
1.4. Element copyProcessResources
1.5. Element transform
1.5.1. Using a custom XSLT style sheet
1.6. Element processFO
1.7. Element upload
1.8. Element post
1.9. Element read
1.10. Element mkdir
1.11. Element rmdir
1.12. Element delete
1.13. Element copy
1.14. Element zip
1.15. Element jar
1.16. Element shell
1.17. Element invoke
1.18. Element subProcess
1.19. Process variables
2. Commented examples
2.1. Convert explicitly or implicitly selected para to a formalpara
2.2. Convert a DocBook document to RTF
2.3. Convert ImageDemo document to HTML
6. Commands written in the Java™ programming language
1. alert
2. add
3. addAttribute
4. addBlockInFlow
5. autoSpellChecker
6. beep
7. cancelSelection
8. center
9. checkValidity
10. confirm
11. contextualMenu
12. convert
13. convertCase
14. copy
15. copyAsInclusion
16. copyChars
17. copyImage
18. cut
19. declareNamespace
20. demoteListItem
20.1. Configuring the promoteListItem and demoteListItem commands
21. delete
22. deleteChar
23. deleteSelectionOrDeleteChar
24. deleteSelectionOrJoinBlockOrDeleteChar
25. deleteWord
26. diffSupport
27. drag
28. drop
29. editAttribute
30. editAttributes
31. editObject
32. editPITarget
33. editMediaInfo
34. ensureSelectionAt
35. execute
36. executeMenuItem
37. extendSelectionAt
38. extractObject
39. fail
40. formatTextAs
40.1. Specifying an element template for use by command formatTextAs
40.2. Filtering the text pasted in the document
41. include
42. insert
43. insertCharByName
44. insertCharSequence
45. insertControlChar
46. insertNewlineOrSplitBlock
47. insertNode
48. insertOrOverwriteString
49. insertSpecialChars
50. insertSameBlock
50.1. Specifying splittable blocks
51. insertString
52. insertTextOrMoveDot
53. join
54. listAnchors
55. listBindings
56. listPlugins
57. listRepeatable
58. moveDotTo
59. moveElement
60. normalizeWhiteSpacePre
61. overwriteMode
62. overwriteString
63. pass
64. paste
65. pasteAs
66. pasteImageAs
67. pasteSystemSelection
68. pick
69. preview
70. promoteListItem
71. prompt
72. putAttribute
73. recordMacro
74. redo
75. refresh
76. reinclude
77. remark
78. removeAttribute
79. repeat
80. replace
81. resizeImage
82. resizeTableTemplate
83. resizeCALSTableTemplate
84. run
85. search
86. searchReplace
87. searchReplaceElement
88. selectAt
89. selectFile
90. selectConvertedFile
91. selectLink
92. selectNode
92.1. List of element names or node types
92.2. OrNone, OrNode, OrElement modifiers
93. selectNodeAt
94. selectText
95. selectTo
96. setProperty
97. setReadOnly
98. setObject
99. showContentModel
100. showElementReference
101. showMatchingChar
102. showColumnRowLabels
103. spellCheck
104. split
105. start
106. status
107. toggleCollapsed
108. toggleTextStyle
109. undo
110. uninclude
111. updateInclusions
112. viewObject
113. webSearch
113.1. Declaring search engines
114. wrap
115. xIncludeText
116. xpathSearch
117. XXE.close
118. XXE.compare
119. XXE.edit
120. XXE.editInclusion
121. XXE.masterDocumentControl
122. XXE.new
123. XXE.open
124. XXE.save
125. XXE.saveAll
126. XXE.setReadOnly
127. XXE.saveAs
128. A generic, parameterizable, table editor command
A. Description of the XML differencing algorithm implemented by the Compare tool
1. Comparison with other approaches
2. Elements are given serial numbers
3. A simple XML differencing algorithm
B. Format of the revision history
List of Figures
6.1. The "Document conversion parameters" panel once expanded
List of Examples
3.1. Whatever the configuration, add extra menu items to the right-click, contextual, popup menu
3.2. DITA topic configuration: when an image is selected, allow to edit it using a helper application
3.3. Any of the two XHTML 1.0 configurations: when some text is selected, display a special, simpler, popup menu
4.1. Using sequence and choice
4.2. Macro-variables
4.3. The "%_" macro-variable
4.4. Using the fail construct
4.5. Using the XPath-based constructs match and set
4.6. A contextual drop
4.7. Insert nodes copied from another document
4.8. Convert a DocBook 5 para to a formalpara
6.1. XHTML example
6.2. TEI example
6.3. XHTML listItemSpecification
6.4. DITA listItemSpecification
6.5. DocBook 5 listItemSpecification
6.6. TEI listItemSpecification
6.7. LwDITA listItemSpecification
6.8. Implementing a “click to follow link” facility using executeMenuItem
6.9. MathML example