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 07, 2017

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. ensureSelectionAt
34. execute
35. extendSelectionAt
36. extractObject
37. fail
38. formatTextAs
38.1. Specifying an element template for use by command formatTextAs
38.2. Filtering the text pasted in the document
39. include
40. insert
41. insertCharByName
42. insertCharSequence
43. insertControlChar
44. insertNewlineOrSplitBlock
45. insertNode
46. insertOrOverwriteString
47. insertSpecialChars
48. insertSameBlock
48.1. Specifying splittable blocks
49. insertString
50. insertTextOrMoveDot
51. join
52. listBindings
53. masterDocumentControl
54. moveDotTo
55. moveElement
56. overwriteMode
57. overwriteString
58. pass
59. paste
60. pasteAs
61. pasteImageAs
62. pasteSystemSelection
63. pick
64. preview
65. promoteListItem
66. prompt
67. putAttribute
68. recordMacro
69. redo
70. refresh
71. reinclude
72. remark
73. removeAttribute
74. repeat
75. replace
76. replaceText
77. resizeImage
78. resizeTableTemplate
79. resizeCALSTableTemplate
80. run
81. search
82. searchReplace
83. selectAt
84. selectFile
85. selectConvertedFile
86. selectLink
87. selectNode
87.1. List of element names or node types
87.2. OrNone, OrNode, OrElement modifiers
88. selectNodeAt
89. selectText
90. selectTo
91. setImageMode
92. setProperty
93. setReadOnly
94. setObject
95. showContentModel
96. showElementReference
97. showMatchingChar
98. showTags
99. spellCheck
100. split
101. start
102. status
103. toggleCollapsed
104. toggleTextStyle
105. undo
106. uninclude
107. updateInclusions
108. viewObject
109. webSearch
109.1. Declaring search engines
110. wrap
111. xIncludeText
112. xpathSearch
113. XXE.close
114. XXE.compare
115. XXE.edit
116. XXE.editInclusion
117. XXE.new
118. XXE.open
119. XXE.save
120. XXE.saveAll
121. XXE.setReadOnly
122. XXE.saveAs
123. 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 listItemSpecification
6.2. DITA listItemSpecification
6.3. DocBook 5 listItemSpecification
6.4. MathML example