3. DITA map reference Previous topic Parent topic Child topic Next topic

3.1. DITA map menu Previous topic Parent topic Child topic Next topic

When a DITA map is opened in XMLmind XML Editor, the XML menu becomes the Map menu and this menu is populated with items which are specific to DITA maps. This reference contains a description of such menu items.
What's described in this section also applies to DITA bookmaps.

Check map

Conditional Processing Profile
Displays a dialog box allowing to specify a conditional processing profile (a .ditaval file) which is to be applied to the map being edited and also the medium targeted by this map. The conditional processing profile is used by the Check Map command and also by all the Convert commands found in the Convert Document menu.
The target medium specified in this dialog box is used only by the Check Map command. If you specifically target a print form (PDF, PostScript, RTF, etc) for your deliverable, check Print. In any other case, check Screen.

Figure 2. The dialog box displayed by menu item "Conditional Processing Profile"

set_filter.png
Remember
Remember
Note that the values specified in the above dialog box are remembered for use during subsequent editing sessions. For example, in the case of the above screenshot, if you reopen the same map later, this map will still be filtered by print.ditaval and its target medium will still be Print, and this even if you do not explicitly use menu item MapConditional Processing Profile during the new editing session.
Check Map
Extensively check the map being edited. This task which can be lengthy is run in background. While this task is running, a non-modal dialog box displays all the errors and warnings found in the map being edited, its submaps and all the topics referenced by these maps. If no errors or warnings are found, the dialog box is automatically closed. Otherwise it stays opened allowing you to review each error or warning. After you are done, you'll have to close the dialog box by clicking Close if you want to be able to re-run Check Map.

Figure 3. The dialog box displayed by menu item "Check Map"

check_map.png
As you can see it in the above screenshot, clicking on an underlined filename or URL opens the corresponding topic or map in XMLmind XML Editor and selects the element having the error or a warning.

Convert Document menu

Attention
Attention
The items of this menu are all disabled if the document being edited needs to be saved to disk.
Convert to XHTML
Convert to XHTML [one page]
Converts the document being edited to multi page or single page XHTML 1.0.
Convert to Web Help
Converts the document being edited to Web Help Opens in new window containing XHTML 5.0 pages.
Convert to HTML Help
Converts the document being edited to a .chm file. This command is disabled on platforms other than Windows.
Requires:
  1. Download and install Microsoft®'s HTML Help Workshop.
  2. Declare the HTML Help compiler, hhc.exe, 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.
Requires:
  1. Download and install JavaHelp Opens in new window.
  2. Declare the Java™ Help indexer, jhindexer (jhindexer.bat on Windows), 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 a directory containing various files for use by the Eclipse Help system.
Convert to EPUB
Converts the document being edited to an .epub file.
Convert to RTF (Word 2000+)
Converts the document being edited to RTF (Rich Text Format) using. The document generated by this command can be edited and printed using Microsoft® Word 2000 and above.
May require downloading and installing the "XMLmind FO Converter XSL-FO processor plug-in " add-on using OptionsInstall add-ons.
Convert to WordprocessingML (Word 2003+)
Converts the document being edited to WordprocessingML. The document generated by this command can be edited and printed using Microsoft® Word 2003 and above.
Same requirements as Convert to RTF.
Convert to Office Open XML (Word 2007+)
Converts the document being edited to Office Open XML (.docx file) . The document generated by this command can be edited and printed using Microsoft® Word 2007 and above.
Same requirements as Convert to RTF.
Convert to OpenDocument (OpenOffice.org 2+)
Converts the document being edited to OpenDocument (.odt file). The document generated by this command can be edited and printed using OpenOffice.org 2.
Same requirements as Convert to RTF.
Convert to PDF
Convert the document being edited to PDF.
May require downloading and installing any of the following add-ons using OptionsInstall add-ons.
  • Apache FOP 1.x XSL-FO processor plug-in;
  • RenderX XEP XSL-FO processor plug-in(1).

Changing the look and contents of the files generated by the Convert Document menu

There are three ways to change the look and contents of the files generated by the items of the Convert Document menu.
  1. Specifying custom XSLT stylesheet parameters. This is done by selecting any of the items of menu "Convert Document" and then, when the URL chooser dialog box is displayed, clicking "Document conversion parameters" to expand the conversion parameters pane.
    For example, adding parameter center with value "fig table" allows to center figures and tables in the generated files.
    The reference manual of the parameters of the XSLT stylesheets used to perform the conversion is found in XMLmind DITA Converter Manual - XSLT stylesheets parameters. This reference manual can be directly accessed from the "Document conversion parameters" pane.
  2. Using menu item OptionsCustomize ConfigurationCustomize Document Conversion Stylesheets is also a relatively simple way to influence the layout and style of the deliverable (PDF, RTF, HTML, etc) which results from the document conversion.
    The document being edited is converted to other formats by the means of XSLT stylesheets. This menu item allows to:
    • select an XSLT stylesheet other the default one,
    • create a custom XSLT stylesheet on the fly,
    • invoke a specialized editor —XMLmind XSL Customizer— to modify a user-created XSLT stylesheet.
    However, when the document being edited is converted to an HTML-based format (Web Help, EPUB, HTML Help, etc), the HTML pages which are automatically generated by the aforementioned XSLT stylesheets are styled mainly by CSS stylesheets. When this is the case, this menu item allows additionally to:
    • select a CSS stylesheet other the default one,
    • create a custom CSS stylesheet on the fly,
    • invoke a helper application (generally, a text editor) to modify a user-created CSS stylesheet.
  3. To a lesser extent, changing the options of the XMLmind DITA Convert (ditac) preprocessor. This is done by using OptionsCustomize ConfigurationPreprocessing Options.
    For example, selecting option group "Convert to PDF, PostScript" and then selecting "Generate as backmatter" in the Index combobox allows to add an index at the end of the generated PDF files.
    More information about this facility in Section 8. Preprocessing options.
Note that a technical writer is not expected to know which parameter, option or style is to be specified to get the desired effect. Unless she/he is the local guru, a technical writer is expected to post a support request to the xmleditor-support Opens in new window public, moderated, mailing list in order to learn this. But at least the three above facilities allow her/him to customize her/his deliverables without having to hand edit configuration files.

Syntax highlighting

You can automatically colorize the source code contained in <pre>, <codeblock> or any other element specializing <pre>. This feature, commonly called syntax highlighting, has been implemented using an open source software component called "XSLT syntax highlighting Opens in new window".
If you want to turn on syntax highlighting in a DITA document, suffice to add attribute @outputclass to a <pre>, <codeblock> or any other element specializing <pre>. The value of attribute @outputclass must be any of: language-c, language-cpp, language-csharp, language-delphi, language-ini, language-java, language-javascript, language-m2, language-perl, language-php, language-python, language-ruby, language-tcl, language-xml.
If you want to customize syntax highlighting for an HTML-based output format (XHTML, EPUB, etc), redefine any of the following CSS styles:
  • .hl-keyword (keywords of a programming language),
  • .hl-string (string literal),
  • .hl-number (number literal),
  • .hl-comment (any type of comment),
  • .hl-doccomment (comments used as documentation, i.e. javadoc, or xmldoc),
  • .hl-directive (preprocessor directive or in XML, a processing-instruction),
  • .hl-annotation (annotations or "attributes" as they are called in .NET),
  • .hl-tag (XML tag, i.e. element name),
  • .hl-attribute (XML attribute name),
  • .hl-value (XML attribute value),
  • .hl-doctype (<!DOCTYPE>and all its content).
Example:
.hl-keyword {
    font-weight: bold;
    color: #602060;
}
This can be done from within XXE using OptionsCustomize ConfigurationCustomize Document Conversion Stylesheets.
If you want to customize syntax highlighting for an XSL-FO-based output format (PDF, RTF, etc), redefine any of the following <attribute-set>s: hl-keyword, hl-string, hl-number, hl-comment, hl-doccomment, hl-directive, hl-annotation, hl-tag, hl-attribute, hl-value, hl-doctype.
Example:
<xsl:attribute-set name="hl-keyword" use-attribute-sets="hl-style">
  <xsl:attribute name="font-weight">bold</xsl:attribute>
  <xsl:attribute name="color">#602060</xsl:attribute>
</xsl:attribute-set>
This can be done from within XXE using OptionsCustomize ConfigurationCustomize Document Conversion Stylesheets.

3.2. DITA map tool bar Previous topic Parent topic Child topic Next topic

When a DITA map is opened in XMLmind XML Editor, buttons which are specific to this kind of document are automatically added to the tool bar. This reference contains a description of such buttons.
What's described in this section also applies to DITA bookmaps.
Button Description
topicref_before.png Insert Topicref Before
Insert a topicref before selected topicref. Displays a dialog box allowing to specify the @href attribute and/or the @navtitle of the topicref to be inserted.
topicref_into.png Insert Topicref Into
Insert a topicref as the last child of selected topicref. Displays a dialog box allowing to specify the @href attribute and/or the @navtitle of the topicref to be inserted.
topicref_after.png Insert Topicref After
Insert a topicref after selected topicref. Displays a dialog box allowing to specify the @href attribute and/or the @navtitle of the topicref to be inserted.
edit_topicref.png Edit Topicref
Displays a dialog box allowing to change the @href attribute and/or the @navtitle of selected topicref.
up.png Move Up
Move selected element up, that is, swap it with its preceding sibling node. Requires the element to be explicitly selected.
down.png Move Down
Move selected element down, that is, swap it with its following sibling node. Requires the element to be explicitly selected.
left.png Promote
Decrease the nesting level of selected topicref, possibly changing its type (e.g. a <topicref> element becomes a <chapter> element).
right.png Demote
Increase the nesting level of selected topicref, possibly changing its type (e.g. a <chapter> element becomes a <topicref> element).
table_menu.png Add reltable
Displays a menu allowing to add a <reltable> without or with a <relheader> after selected element.
Tip
Tip
The entries of this menu are generally disabled unless you select the last element (or any descendant of last element) of the map.
column_menu.png Reltable column Displays a menu similar to the "Table column" menu found in Table editor.
row_menu.png Reltable row Displays a menu similar to the "Table row" menu found in Table editor.
show_level_menu.png Show Level
Displays a menu containing "Show Level 1", "Show Level 2", ..., "Show Level 9" items. "Show Level N" means: expand all the collapsible elements of the map up to nesting level N and recursively collapse all the collapsible elements having a nesting level greater than N.
viewDocument.png Edit Referenced Topic or Map in Read-only Mode
Opens in read-only mode the topic or map referenced in the selected topicref.
editDocument.png Edit Referenced Topic or Map
Opens in normal read-write mode the topic or map referenced in the selected topicref.

The "Edit topicref" dialog box

The following dialog box is displayed when you click the "Insert topicref Before", "Insert topicref Into", "Insert topicref After" or the "Edit topicref" toolbar buttons. See above.

Figure 4. A "Edit topicref" dialog box used to edit a <bookabstract> (a kind of <topicref> found in the <frontmatter> of a <bookmap>)

edit_topicref_dialog.png
  • If you want to set the @href attribute of the edited or newly inserted <topicref>:
    1. Click the browse.png Browse button and use the file chooser to select a file containing one or more DITA topics.
      After the topic file is selected, the status fields of the dialog box are updated to reflect the type and title of the first topic found in the file. The "Topic ID" combobox is updated too and contains the IDs of all the topics found in the selected file.
    2. In case the file selected in the previous step contains several topics, optionally select the ID of the target topic. This option adds a fragment #topic_ID to the value of the @href attribute.
  • If you want to set the @href attribute of the edited or newly inserted <topicref> to a newly created topic, click the create.png Create button. This displays the same dialog box as menu item FileNew. Make sure to create a DITA topic.
  • If you want to set the @navtitle attribute of the edited or newly inserted <topicref>:
    1. Type the title of the <topicref> in the "Navigation Title" field.
    2. Optionally click "Override default navigation title" if you want this <topicref> title to replace the referenced topic title in the deliverable (HTML, PDF, RTF, etc) which is to be generated out of the DITA map. This option adds a locktitle="yes" attribute to the edited or newly inserted <topicref>.

3.3. DITA map bindings Previous topic Parent topic Child topic Next topic

When a DITA map is opened in XMLmind XML Editor, additional keyboard shortcuts which are specific to this kind of document are automatically made available to the user. This reference contains a description of such keyboard shortcuts.
What's described in this section also applies to DITA bookmaps.
Action Description
Up If a topicref is selected, select preceding topicref; elsewhere, default behavior.
Down If a topicref is selected, select following topicref; elsewhere, default behavior.
Enter Insert Topicref After
Shift-Enter Insert Topicref Before
Ctrl+Shift-Enter Insert Topicref Into
Esc e Edit Topicref
Alt+Shift-Up Move Up
Alt+Shift-Down Move Down
Alt+Shift-Left Promote
Alt+Shift-Right Demote
Double-click On a topicref, Edit Referenced Topic or Map; elsewhere default behavior.
Esc o Edit Referenced Topic or Map
Esc O Edit Referenced Topic or Map in Read-Only Mode
Drag Dragging selected topicref drags the value of its @href attribute. Elsewhere, default drag behavior.
Drop Dropping a file or URL onto a topicref displays a popup menu containing Insert Topicref Before, Insert Topicref Into, Insert Topicref After, Edit Topicref and Cancel. Elsewhere, default drop behavior.

 (1) Unlike all the other add-ons, the RenderX XEP XSL-FO processor plug-in is not self-contained. You'll need to download, install and activate RenderX XEP Opens in new window (for example, free Personal Edition Opens in new window) prior to using the RenderX XEP XSL-FO processor plug-in.