XMLmind XML Editor - Commands

Hussein Shafie

Pixware

Immeuble Capricorne,
23 rue Colbert,
78180 Montigny Le Bretonneux,
France,
Phone: +33 (0)1 30 60 07 00,
Fax: +33 (0)1 30 96 05 23,
Web: www.xmlmind.com/xmleditor
Email: 

December 2, 2005

Abstract

This documents 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.3.2. Parameters supported by the Batik image toolkit
1.3.3. Parameters supported by the Jimi 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. Convert a DocBook document to multi-page HTML
3.2. Example 2: Convert a DocBook document to PDF
3.3. Example 3: Convert a DocBook document to JavaHelp
6. Commands written in the Java™ programming language
1. alert
2. add
3. addAttribute
4. addBlockInFlow
5. beep
6. cancelSelection
7. center
8. checkValidity
9. confirm
10. convert
11. convertCase
12. copy
13. copyAsInclusion
14. copyChars
15. cut
16. decrSectionLevel
17. declareNamespace
18. delete
19. deleteChar
20. deleteSelectionOrDeleteChar
21. deleteSelectionOrJoinOrDeleteChar
22. editAttributes
23. editMenu
24. editPITarget
25. execute
26. extractImage
27. extractObject
28. include
29. incrSectionLevel
30. insert
31. insertCharByName
32. insertControlChar
33. insertControlCharOrSplit
34. insertNode
35. insertSpecialChars
36. insertString
37. join
38. joinOrDeleteChar
39. listBindings
40. makeParagraphs
41. moveDotTo
42. paste
43. pasteInclusionEnabled
44. pasteSystemSelection
45. pick
46. prompt
47. putAttribute
48. recordMacro
49. redo
50. refresh
51. removeAttribute
52. repeat
53. replace
54. resizeSVG
55. run
56. search
57. searchReplace
58. selectAt
59. selectBlockAtY
60. selectById
61. selectFile
62. selectConvertedFile
63. selectPrinter
64. selectNode
64.1. List of element names or node types
64.2. OrNone, OrNode, OrElement modifiers
65. selectNodeAt
66. selectText
67. selectTo
68. setEditable
69. setImage
70. setObject
71. showContentModel
72. showMatchingChar
73. spellCheck
74. split
75. start
76. status
77. toggleCollapsed
78. undo
79. viewHTML
80. wrap
81. xpathSearch
82. XXE.edit
83. XXE.open
84. XXE.openAsTemplate
85. XXE.openCopy
86. XXE.close
87. XXE.save
88. XXE.saveAs
89. XXE.saveCopy
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 file-drop