1. DocBook menu
Prev |  | Next

## 1. DocBook menu

Table editing commands fully support CALS tables as well as HTML tables.

Menu | Item | Description
--- | --- | ---
Column For a command in this menu to work, click anywhere inside a cell (or explicitly select a cell or an element having a cell ancestor). | Insert Before | Insert a column before column containing specified cell.
Insert After | Insert a column after column containing specified cell.
Cut | Cut to the clipboard the column containing specified cell.
Copy | Copy to the clipboard the column containing specified cell.
Paste Before | Paste copied or cut column before column containing specified cell.
Paste After | Paste copied or cut column after column containing specified cell.
Delete | Delete the column containing specified cell.

Row

For a command in this menu to work, click anywhere inside a cell (or explicitly select a cell or an element having a cell ancestor) or explicitly select a row.

Insert Before

Insert a row before row containing specified cell.

### Note

Note that row editing commands are enabled, not only by implicitly or explicitly selecting a table cell or any of its descendants, but also by explicitly selecting a table row.

Insert After | Insert a row before row containing specified cell.
Cut | Cut to the clipboard the row containing specified cell.
Copy | Copy to the clipboard the row containing specified cell.
Paste Before | Paste copied or cut row before row containing specified cell.
Paste After | Paste copied or cut row after row containing specified cell.
Delete | Delete the row containing specified cell.
Cell For a command in this menu to work, click anywhere inside a cell (or explicitly select a cell or an element having a cell ancestor). | Increment Column Span | Increment the number of columns spanned by specified cell.
Decrement Column Span | Decrement the number of columns spanned by specified cell.
Increment Row Span | Increment the number of rows spanned by specified cell.
Decrement Row Span | Decrement the number of rows spanned by specified cell.

Other commands:

Paste After As

  The entries of this submenu allow to paste the plain text copied to the clipboard, typically using a third-party word processor or spreadsheet, as:

  - one or more paragraphs,

  - OR a `programlisting` element,

  - OR one or more list items,

  - OR an itemized list,

  - OR one or more table rows,

  - OR a table.

  The last two menu entries assume that each text line specifies a table row and that, within a text line, the contents of the table cells are separated by tab characters.

Convert between informal element and element

  Converts an ``informal element'' to/from a ``formal element'' having a title.

  This command currently works for `informaltable`/`table`, `informalfigure`/`figure` and `informalexample`/`example`.

Links callouts

  Links a sequence of `callout` elements to the corresponding sequence of `co` or `area` elements (and, of course, also the other way round).

  Useful information about callouts is found in DocBook XSL: The Complete Guide by Bob Stayton: Program listings, Annotating program listings, Callouts.

  In order to use this command, you need to:

  1. Create a `programlisting` containing a number of `co` elements. No need to specify the ID or `linkends` attributes for these `co` elements.

     Note that this command also works for any element containing `area` elements rather than `co` elements (e.g. a `programlistingco`).

  2. Add a `calloutlist` element somewhere after the `programlisting`. No need to specify the ID or arearefs attributes for the `callout` elements.

     ### Important

     Make sure to create exactly the same number of `co` and `callout` elements. This is needed because the `N`th `co` element will be linked to the `N`th `callout` element.

  3. Explicitly select the node range comprising both the `programlisting` and the `calloutlist` elements.

     In fact, you can select any element containing, at any nesting level, a sequence of `co` elements followed by a sequence of `callout` elements. For example, if your `programlisting` and `calloutlist` elements are contained in a `section` element, you can select just this section.

  4. Select DocBook → Link callouts.

  5. The following dialog box is displayed:

     Specify a prefix for the IDs which will be automatically generated for the `co` and the `callout` elements. The links (`linkends` and `arearefs` attributes) between the `co` and the `callout` elements of course need to refer to these IDs.

  6. Click OK.

  Notice that the above dialog box has a "Discard existing ID and linkends/arearefs attributes" checkbox. This checkbox is needed because the "Links callouts" command has been designed to be used, not only on newly created `programlisting` plus `calloutlist` elements, but also on existing, possibly hand-written, possibly complex[1] `programlisting` plus `calloutlist` elements.

  When the `co` and `callout` elements found inside the node selection are found to already have ID attributes, this checkbox is enabled and, by default, unchecked. When this is the case, running this command will affect only the newly created `co` and `callout` elements. All the existing IDs and links will be left unchanged.

Insert or Edit `indexterm`

  If the caret is anywhere inside an `indexterm` element, this menu item displays an `indexterm` editor dialog box allowing to modify this `indexterm` element.

  If the caret is not inside an `indexterm` element, this menu item displays an `indexterm` editor dialog box allowing to create a new `indexterm` element and then to insert it at caret position.

Go to Opposite Link End

  An element with an `ID`, `IDREF` or `IDREFS` attribute must be implicitly or explicitly selected. Scrolls to and selects opposite link end (if found). For example, will scroll to and select `<section id="foo">` if the command has been invoked with `<link linkend="foo">` selected.

Go to Next Link

  An element with an `IDREF` or `IDREFS` attribute must be implicitly or explicitly selected. Scrolls to and selects next similar link (if found). For example, will scroll to and select following `<callout arearefs="foo bar">` if the command has been invoked with `<link linkend="foo">` selected.

Go to Previous Link

  An element with an `IDREF` or `IDREFS` attribute must be implicitly or explicitly selected. Scrolls to and selects previous similar link (if found). For example, will scroll to and select preceding `<link linkend="foo">` if the command has been invoked with `<link linkend="foo">` selected.

Move Up

  Move selected element up, that is, swap it with its preceding sibling node. Requires the element to be explicitly selected.

Move Down

  Move selected element down, that is, swap it with its following sibling node. Requires the element to be explicitly selected.

Promote

  To make it simple, increase the level of selected subsection (e.g. a `sect2` element is converted to a `sect1` element).

  Requires a ``subsection'' (`section`, `sect1`, `sect2`, `sect3`, `sect4` or `sect5`) or an element which is contained in the body[2] of the section to be explicitly selected.

  - If a subsection is selected, this subsection becomes a sibling of its parent section. Example: `sect2` element having `id`="`C`" is ``promoted'':

        <sect1 id="A">...
          <sect2 id="B">...
          <sect2 id="C">...
          <sect2 id="D">...

    This results in:

        <sect1 id="A">...
          <sect2 id="B">...
        <sect1 id="C">...
          <sect2 id="D">...

  - If another type of child element is selected, this element is wrapped in a newly created section which becomes a sibling of its parent section. Example: `para` element having `id`="`C`" is ``promoted'':

        <sect1 id="A">...
          <para id="B">...
          <para id="C">...
          <sect2 id="D">...

    This results in:

        <sect1 id="A">...
          <para id="B">...
        <sect1>...
          <para id="C">...
          <sect2 id="D">...

Demote

  To make it simple, decrease the level of selected section (e.g. a `sect1` element is converted to a `sect2` element).

  Requires a ``section'' (`chapter`, `appendix`, `section`, `sect1`, `sect2`, `sect3` or `sect4`) or an element which is contained in the body[3] of the section to be explicitly selected.

  - If a section is selected and if this section is preceded by a section of the same type, this section becomes a subsection of its preceding sibling. Example: `sect1` element having `id`="`C`" is ``demoted'':

        <sect1 id="A">...
          <para id="B">...
        <sect1 id="C">...
          <para id="D">...

    This results in:

        <sect1 id="A">...
          <para id="B">...
          <sect2 id="C">...
            <para id="D">...

  - If a section is selected and if this section is not preceded by a section of the same type, a new section is created and selected section becomes a subsection of this new section. Example: `sect2` element having `id`="`C`" is ``demoted'':

        <sect1 id="A">...
          <para id="B">...
          <sect2 id="C">...
            <para id="D">...

    This results in:

        <sect1 id="A">...
          <para id="B">...
          <sect2>...
            <sect3 id="C">...
              <para id="D">...

  - If another type of child element is selected, this element and all the other ``body elements'' which follow it are wrapped in a newly created subsection. Example: `para` element having `id`="`C`" is ``demoted'':

        <sect1 id="A">...
          <para id="B">...
          <para id="C">...
          <para id="D">...
          <sect2 id="E">...

    This results in:

        <sect1 id="A">...
          <para id="B">...
          <sect2>...
            <para id="C">...
            <para id="D">...
          <sect2 id="E">...

### 1.1. Convert Document sub-menu

This menu is present only in XMLmind XML Editor Professional Edition.

### Using the profiling stylesheets

Profiling, or conditional text, means that you can create a single XML document with some elements marked as conditional. More information in DocBook XSL: The Complete Guide.

If you need to use the profiling XSL stylesheets rather than the plain XSL stylesheets, use Options → Customize Configuration → Document Conversion Preferences and check option "Use the profiling stylesheets".

Convert to HTML, Convert to HTML [one page], Convert to HTML [one page, no TOC]

  Converts the document being edited to multi page or single page HTML.

  ### Generating XHTML rather than HTML

  If you prefer to generate XHTML rather than HTML, use Options → Customize Configuration → Document Conversion Preferences and check option "Generate XHTML rather than HTML".

Convert to HTML Help

  Converts the document being edited to a `.chm` file. This command is disabled on platforms other than Windows.

  For this command to work, the HTML Help compiler, `hhc.exe`, must have been declared as the helper application associated to files having a "`hhp`" extension. This can be specified by using the Preferences dialog box, Helper Applications section.

Convert to Java Help

  Converts the document being edited to a `.jar` file for use by the Java™ Help system.

  For this command to work, the Java™ Help indexer, `jhindexer`, must have been declared as the helper application associated to files having a "`application/x-java-help-index`" MIME type. This can be specified by using the Preferences dialog box, Helper Applications section.

Convert to Eclipse Help

  Converts the document being edited to Eclipse Help.

  The `eclipse.plugin.name`, `eclipse.plugin.id`, `eclipse.plugin.provider` XSL style sheet parameters must have been specified using the Options → Customize Configuration → Change Document Conversion Parameters facility.

  All HTML files as well as Eclipse's `plugin.xml` and `toc.xml` are generated in the same directory:

  1. This directory must be a subdirectory of the Eclipse `plugins/` directory.

  2. The name of this directory must be identical to the value of the `eclipse.plugin.id` XSL style sheet parameter.

Convert to EPUB

  Converts the document being edited to EPUB.

Convert to RTF (Word 2000+), Convert to RTF [no TOC]

  Converts the document being edited to RTF (Rich Text Format) using XMLmind FO Converter (see http://www.xmlmind.com/foconverter/). The document generated by this command can be edited and printed using Microsoft® Word 2000 and above.

Convert to WordprocessingML (Word 2003+)., Convert to WordprocessingML [no TOC]

  Converts the document being edited to WordprocessingML using XMLmind FO Converter. The document generated by this command can be edited and printed using Microsoft® Word 2003 and above.

Convert to Office Open XML (Word 2007+), Convert to Office Open XML [no TOC]

  Converts the document being edited to Office Open XML (`.docx` file) using XMLmind FO Converter. The document generated by this command can be edited and printed using Microsoft® Word 2007 and above.

Convert to OpenDocument (OpenOffice.org 2+), Convert to OpenDocument [no TOC]

  Converts the document being edited to OpenDocument (`.odt` file) using XMLmind FO Converter. The document generated by this command can be edited and printed using OpenOffice.org 2.

Print PostScript, Print PostScript [no TOC]

  Converts the document being edited to PostScript® using RenderX XEP (see http://www.renderx.com/), if its plug-in has been installed, and Apache FOP otherwise (see http://xmlgraphics.apache.org/fop/), and then, sends the generated file to the chosen printer.

Convert to PDF, Convert to PDF [no TOC]

  Converts the document being edited to PDF (Adobe® Portable Document Format, also known as Acrobat®) using RenderX XEP (see http://www.renderx.com/), if its plug-in has been installed, and Apache FOP otherwise (see http://xmlgraphics.apache.org/fop/).

All the above Convert commands display the URL chooser dialog box rather than the standard file chooser dialog box.

For all Convert commands except for the "Convert to HTML" command, you must specify the URL (Uniform Resource Locator) of a save file. The "Convert to HTML" command creates multiple HTML pages with a first page called `index.html`, therefore you need to specify the URL of a save directory.

Note that these commands can create directories on the fly, if needed to. For example, if you specify `http://www.acme.com/docs/report43/mydoc.html` as the URL of the save file and if directory `report43/` does not exist, this directory will be created during command execution.

### 1.2. Using the `indexterm` editor

This dialog box, displayed by menu item DocBook → Insert or Edit indexterm, allows to edit the selected `indexterm` element if any, or to create a new `indexterm` element and then insert it at caret position otherwise.

Note that this editor does not allow to modify `indexterm` elements which are invalid, inconsistent or simply too complex. In such case, you'll have to revert using the normal editing tool (Edit tool, Attributes tool, etc) in order to modify such `indexterm` elements. However, this `indexterm` editor is sufficiently powerful to fulfill the vast majority of needs.

We'll explain with examples how to use the `indexterm` editor.

- If you want to get this kind of entry in your back of the book index:

      P
      Pet 12

  specify Term\Primary=`Pet`.

- Back of the book index:

      P
      Pet
          Cat 26

  specify Term\Primary=`Pet`, Term\Secondary=`Cat`.

- Back of the book index:

      P
      "+" 54

  specify Term\Primary=`"+"`, Sort As\Primary=`plus`. Without this Sort As specification, the index entry corresponding to `"+"` would have been found in the Symbols category:

      Symbols
      "*" 53, 78
      "+" 54
      "-" 55, 91-95
      ...

- Back of the book index:

      D
      Domesticated animals 34 See also Pet

  specify Term\Primary=`Domesticated animals`, See Also=`Pet`.

  Note that the content of the See Also field must refer to an existing index entry. That's why instead of typing "`Pet`", you can select this index entry by using the dialog box displayed by the Pick from list button found at the right of the See Also row.

  It is possible to specify up to two See Also entries for a Term.

- Back of the book index:

      I
      IT See Information Technology

  specify Term\Primary=`IT`, See=`Information Technology`. (In the above example, notice that `IT` has no associated page number.)

  Like See Also, the content of the See field must refer to an existing index entry. Unlike See Also, a See entry is merely a redirection to an actual index entry.

- Back of the book index:

      O
      Operation
          Additive
              "+" 87-90

  1. Insert a first `indexterm` element at the beginning the range (this will give us page number 87).

     In order to do that, use DocBook → Insert or Edit indexterm and specify Term\Primary=`Operation`, Term\Secondary=`Additive`, Term\Tertiary=`"+"`, Sort As\Tertiary=`plus`.

     Then check Range/Start and give your `indexterm` element an ID by specifying "`plus_reference`" in the Range field.

  2. Insert another `indexterm` element at the end the range (this will give us page number 90).

     In order to do that, use DocBook → Insert or Edit indexterm, check Range/End and specify the same ID, "`plus_reference`", in the Range field. All the other fields must be left blank.

     Note that instead of typing "`plus_reference`" in the Range field, you can select this ID by using the dialog box displayed by the Pick from list button found at the right of the Range row.

[1] For example, containing a `callout` element linked to several `co` elements. In such case, the numbering of `co` and `callout` elements done on screen by XMLmind XML Editor will not reflect what you'll get when you'll convert your document to HTML or PDF. However this limitation should not prevent you from specifying such multi-`co` `callout` elements if needed to.

[2] That is, it is not possible to ``promote'' the title of a section.

[3] That is, it is not possible to ``demote'' the title of a section.

Prev |  | Next
XMLmind XML Editor - DocBook Support | Home | 2. Custom bindings