XMLmind XML Editor - Commands
		Next

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: <xmleditor-support@xmlmind.com>

July 21, 2008

Abstract

This document contains the reference of all native XXE commands and explains how to write custom macro-commands.

Table of Contents

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. 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

3. addAttribute

4. addBlockInFlow

5. autoSpellChecker

7. cancelSelection

9. checkValidity

10. confirm

11. convert

12. convertCase

14. copyAsInclusion

15. copyChars

17. declareNamespace

19. deleteChar

20. deleteSelectionOrDeleteChar

21. deleteSelectionOrJoinOrDeleteChar

22. deleteWord

23. editAttributes

24. editMenu

25. editObject

26. editPITarget

27. ensureSelectionAt

28. execute

29. extractObject

30. include

32. insertCharByName

33. insertCharSequence

34. insertControlChar

35. insertControlCharOrSplit

36. insertNode

37. insertSpecialChars

38. insertString

39. insertOrOverwriteString

41. joinOrDeleteChar

42. listBindings

43. makeParagraphs

44. moveDotTo

45. moveElement

46. overwriteMode

47. overwriteString

49. pasteSystemSelection

52. putAttribute

53. recordMacro

55. refresh

56. reinclude

57. removeAttribute

59. replace

60. replaceText

63. searchReplace

64. selectAt

65. selectBlockAtY

66. selectById

67. selectFile

68. selectConvertedFile

69. selectPrinter

70. selectNode

70.1. List of element names or node types
70.2. OrNone, OrNode, OrElement modifiers

71. selectNodeAt

72. selectText

73. selectTo

74. setReadOnly

75. setObject

76. showContentModel

77. showMatchingChar

78. spellCheck

82. toggleCollapsed

84. uninclude

85. updateInclusions

86. viewObject

88. xpathSearch

89. XXE.close

90. XXE.edit

91. XXE.new

92. XXE.open

93. XXE.save

94. XXE.saveAll

95. XXE.saveAs

96. 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

		Next
		Part I. Guide