XMLmind XML Editor - Commands

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)

October 28, 2010

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. Examples
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. 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 print
1.10. Element read
1.11. Element mkdir
1.12. Element rmdir
1.13. Element delete
1.14. Element copy
1.15. Element zip
1.16. Element jar
1.17. Element shell
1.18. Element invoke
1.19. Element subProcess
1.20. 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
3. The convertdoc command-line tool
3.1. Using convertdoc
3.2. Example 1: convert a DocBook document to multi-page HTML
3.3. Example 2: convert a DocBook document to PDF
6. Commands written in the Java™ programming language
1. alert
2. add
3. addAttribute
4. addBlockInFlow
5. addLink
6. autoSpellChecker
7. bookmark
8. beep
9. cancelSelection
10. center
11. checkValidity
12. confirm
13. convert
14. convertCase
15. copy
16. copyAsInclusion
17. copyChars
18. cut
19. declareNamespace
20. delete
21. deleteChar
22. deleteSelectionOrDeleteChar
23. deleteSelectionOrJoinOrDeleteChar
24. deleteWord
25. editAttributes
26. editMenu
27. editObject
28. editPITarget
29. ensureSelectionAt
30. execute
31. extractObject
32. fail
33. followLink
34. formatTextAs
34.1. Specifying an element template for use by command formatTextAs
35. include
36. insert
37. insertCharByName
38. insertCharSequence
39. insertControlChar
40. insertControlCharOrSplit
41. insertNode
42. insertOrOverwriteString
43. insertSpecialChars
44. insertString
45. insertTextOrMoveDot
46. join
47. joinOrDeleteChar
48. listBindings
49. moveDotTo
50. moveElement
51. overwriteMode
52. overwriteString
53. pass
54. paste
55. pasteAfterAs
56. pasteSystemSelection
57. pick
58. prompt
59. putAttribute
60. recordMacro
61. redo
62. refresh
63. reinclude
64. removeAttribute
65. repeat
66. replace
67. replaceText
68. run
69. search
70. searchReplace
71. selectAt
72. selectBlockAtY
73. selectById
74. selectFile
75. selectConvertedFile
76. selectPrinter
77. selectNode
77.1. List of element names or node types
77.2. OrNone, OrNode, OrElement modifiers
78. selectNodeAt
79. selectText
80. selectTo
81. setImageMode
82. setProperty
83. setReadOnly
84. setObject
85. showContentModel
86. showMatchingChar
87. spellCheck
88. split
89. start
90. status
91. toggleCollapsed
92. undo
93. uninclude
94. updateInclusions
95. viewObject
96. webSearch
96.1. Declaring search engines
97. wrap
98. xIncludeText
99. xpathSearch
100. XXE.close
101. XXE.edit
102. XXE.new
103. XXE.open
104. XXE.save
105. XXE.saveAll
106. XXE.saveAs
107. A generic, parametrizable, table editor command
7. XPath functions
1. Extension functions
2. Java™ methods as extension functions

List of Figures

5.1. Excerpts of docb.toHTML
5.2. docb.toPSFile and excerpts of docb.toPS

List of Examples

3.1. Contextual menus
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 4 para to a formalpara
6.1. MathML example