Chapter 6. Commands written in the Java™ programming language
Prev | Part II. Reference | Next

## Chapter 6. Commands written in the Java™ programming language

In the following command reference:

selected node

  means

  - the explicitly selected single node;

  - OR the node (text, comment, processing-instruction or element) containing the caret, if there is no explicit node selection and if the `[implicitNode]` option is used in the parameter of the command;

  - OR the element containing the textual node (text, comment, processing-instruction) containing the caret, if there is no explicit node selection and if the `[implicitElement]` option is used in the parameter of the command.

selected nodes

  means

  - the explicitly selected single node or node range;

  - OR the node (text, comment, processing-instruction or element) containing the caret, if there is no explicit node selection and if the `[implicitNode]` option is used in the parameter of the command;

  - OR the element containing the textual node (text, comment, processing-instruction) containing the caret, if there is no explicit node selection and if the `[implicitElement]` option is used in the parameter of the command.

argument node

  means

  - an empty text node, if the parameter of the command ends with `#text`;

  - OR an automatically generated empty element (see configuration element `newElementContent` in Section 14, “newElementContent” in XMLmind XML Editor - Configuration and Deployment), if the parameter of the command ends with an element name;

  - OR a copy of an element template (see configuration element `elementTemplate` in Section 8, “elementTemplate” in XMLmind XML Editor - Configuration and Deployment), if the parameter of the command ends with an element template name.

  If the argument node is not explicitly specified in the parameter of a command, a dialog box is displayed and the user will have to interactively specify it.

  Note that namespace prefixes cannot be used inside the parameter of a command. Notation {`namespace_URI`}`local_name` must be used instead.

  Example 1: `{http://www.w3.org/1999/xhtml}p` means `p` in the `http://www.w3.org/1999/xhtml` namespace.

  Example 2: `p` means `p` with no namespace.

These non-terminals are sometimes used in the synopsis of a parameter of a command:

    implicit_selection -> '[implicitNode]' | '[implicitElement]'

    argument_node -> '#text' |
                     element_name |
                     '#template(' element_name ',' template_name ')'

    element_name -> Name | '{' namespace_URI '}' NCName

    namespace_uri -> anyURI

In the synopsis of a parameter of a command, `S` means space.

Note that whitespace is not allowed inside the `#template()` construct. That is, "`#template( figure, image )`" will not work while "`#template(figure,image)`" will work.

Prev | Up | Next
3.2. Example 2: convert a DocBook document to PDF | Home | 1. alert