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)

September 3, 2024

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. checkExternalRefs
10. checkValidity
11. commentOut
12. confirm
13. contextualMenu
14. convert
15. convertCase
16. copy
17. copyAsInclusion
18. copyChars
19. copyImage
20. cut
21. declareNamespace
22. demoteListItem
22.1. Configuring the promoteListItem and demoteListItem commands
23. delete
24. deleteChar
25. deleteSelectionOrDeleteChar
26. deleteSelectionOrJoinBlockOrDeleteChar
27. deleteWord
28. diffSupport
29. drag
30. drop
31. editAttribute
32. editAttributes
33. editObject
34. editPITarget
35. editMediaInfo
36. ensureSelectionAt
37. execute
38. executeMenuItem
39. extendSelectionAt
40. extractObject
41. fail
42. formatTextAs
42.1. Specifying an element template for use by command formatTextAs
42.2. Filtering the text pasted in the document
43. include
44. insert
45. insertCharByName
46. insertCharSequence
47. insertControlChar
48. insertNewlineOrSplitBlock
49. insertNode
50. insertOrOverwriteString
51. insertSpecialChars
52. insertSameBlock
52.1. Specifying splittable blocks
53. insertString
54. insertTextOrMoveDot
55. join
56. listAnchors
57. listBindings
58. listPlugins
59. listRepeatable
60. moveDotTo
61. moveElement
62. normalizeWhiteSpacePre
63. overwriteMode
64. overwriteString
65. pass
66. paste
67. pasteAs
68. pasteImageAs
69. pasteSystemSelection
70. pick
71. preview
72. promoteListItem
73. prompt
74. putAttribute
75. recordMacro
76. redo
77. refresh
78. reinclude
79. remark
80. removeAttribute
81. repeat
82. replace
83. resizeImage
84. resizeTableTemplate
85. resizeCALSTableTemplate
86. run
87. search
88. searchReplace
89. searchReplaceElement
90. selectAt
91. selectFile
92. selectConvertedFile
93. selectLink
94. selectNode
94.1. List of element names or node types
94.2. OrNone, OrNode, OrElement modifiers
95. selectNodeAt
96. selectText
97. selectTo
98. setProperty
99. setReadOnly
100. setObject
101. showContentModel
102. showElementReference
103. showMatchingChar
104. showColumnRowLabels
105. spellCheck
106. split
107. start
108. status
109. toggleCollapsed
110. toggleTextStyle
111. undo
112. uninclude
113. updateInclusions
114. viewObject
115. webSearch
115.1. Declaring search engines
116. wrap
117. xIncludeText
118. xpathSearch
119. XXE.close
120. XXE.compare
121. XXE.edit
122. XXE.editInclusion
123. XXE.masterDocumentControl
124. XXE.new
125. XXE.open
126. XXE.save
127. XXE.saveAll
128. XXE.setReadOnly
129. XXE.saveAs
130. 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 checkExternalRefs property
6.4. DITA checkExternalRefs property
6.5. TEI Lite checkExternalRefs property
6.6. DocBook 5+ checkExternalRefs property
6.7. XHTML listItemSpecification
6.8. DITA listItemSpecification
6.9. DocBook 5 listItemSpecification
6.10. TEI listItemSpecification
6.11. LwDITA listItemSpecification
6.12. Implementing a “click to follow link” facility using executeMenuItem
6.13. MathML example