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)

June 5, 2009

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 simpara
2.2. Convert a DocBook document to RTF
2.3. Convert ImageDemo document to HTML
3. The convertdoc command line tool
3.1. Example 1: convert a DocBook document to multi-page HTML
3.2. 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. autoSpellChecker
6. bookmark
7. beep
8. cancelSelection
9. center
10. checkValidity
11. confirm
12. convert
13. convertCase
14. copy
15. copyAsInclusion
16. copyChars
17. cut
18. declareNamespace
19. delete
20. deleteChar
21. deleteSelectionOrDeleteChar
22. deleteSelectionOrJoinOrDeleteChar
23. deleteWord
24. editAttributes
25. editMenu
26. editObject
27. editPITarget
28. ensureSelectionAt
29. execute
30. extractObject
31. include
32. insert
33. insertCharByName
34. insertCharSequence
35. insertControlChar
36. insertControlCharOrSplit
37. insertNode
38. insertOrOverwriteString
39. insertSpecialChars
40. insertString
41. insertTextOrMoveDot
42. join
43. joinOrDeleteChar
44. listBindings
45. makeParagraphs
46. moveDotTo
47. moveElement
48. overwriteMode
49. overwriteString
50. paste
51. pasteSystemSelection
52. pick
53. prompt
54. putAttribute
55. recordMacro
56. redo
57. refresh
58. reinclude
59. removeAttribute
60. repeat
61. replace
62. replaceText
63. run
64. search
65. searchReplace
66. selectAt
67. selectBlockAtY
68. selectById
69. selectFile
70. selectConvertedFile
71. selectPrinter
72. selectNode
72.1. List of element names or node types
72.2. OrNone, OrNode, OrElement modifiers
73. selectNodeAt
74. selectText
75. selectTo
76. setProperty
77. setReadOnly
78. setObject
79. showContentModel
80. showMatchingChar
81. spellCheck
82. split
83. start
84. status
85. toggleCollapsed
86. undo
87. uninclude
88. updateInclusions
89. viewObject
90. wrap
91. xIncludeText
92. xpathSearch
93. XXE.close
94. XXE.edit
95. XXE.new
96. XXE.open
97. XXE.save
98. XXE.saveAll
99. XXE.saveAs
100. 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. Paste nodes copied from another document
6.1. MathML example