This wiki has undergone a migration to Confluence found Here
<meta name="googlebot" content="noindex">

XML Tool Considerations

From HL7Wiki
Jump to navigation Jump to search

Purpose of This Page

This page provides information about two DITA-friendly XML editors:

Note: I urge you to follow the above links (right-click to open in a new tab or window) and download a trial of each product.

Editions

XMetal and oXygen are available in the following editions.

Product Outputs
XMetal Enterprise Edition only
oXygen Author or Enterprise Editions. Enterprise has more full-featured publishing features. For more information about the difference between the editions, see the <oXygen> XML Feature Matrix page.

Possible Outputs

XMetal and oXygen support the following output types.

Product Outputs
XMetal
  • XHTML
  • PDF w/RenderX enhancements
  • PDF w/Anntenna House XSL formatter
  • HTML Help (CHM)
  • Eclipse Help
  • Eclipse Content
  • Docbook
  • RTF
  • TROFF
oXygen
  • XHTML
  • PDF w/Idiom FO plug-in
  • HTML Help (CHM)
  • Eclipse Help
  • Eclipse Content
  • Docbook
  • RTF
  • TROFF

Note: Some outputs (e.g., RTF) require custom configuration, but both tools make customizing relatively easy to do.

Feature Sets

The following table compares features of both products.

Feature XMetal oXygen
Editing window Provides three views:
  • Normal: WYSIWYG view; similar to MS Word
  • Tags On: Wraps elements in selectable tags; provides a clean view of document structure
  • Plain Text: Color-coded markup view w/line numbering; not the best view for editing
Provides three views:
  • Text: Color-coded markup view w/line numbering
  • Grid: Shows document structure in a table view; not always intuitive
  • Author: WYSIWYG; similar to MS Word; can be enhanced with a tags-on view
Editing of multiple topics Has a tabbed interface with tabs on the bottom. Has a tabbed interface with tabs on the top.
Customized work environment Allows saving of named workspaces and workspace switching. Saves whatever configuration you were last using before exiting.
General authoring tools
  • Spell checking
  • Thesaurus
  • Find and replace
  • Change tracking
  • List management: Easily converts bulleted lists to numbered lists with button click.
  • Table management: Menu and toolbar
  • Paragraphs: Easy to change types through dialog boxes
  • Spell checking
  • Find and replace
  • Change tracking
  • List management: To convert bulleted list to numbered list, you have to remove tags and add new tags.
  • Table management: Toolbar
  • Paragraphs: A little more work to change paragraph types; you have to use the pop-up list and drill down to sub-lists.
Working with attributes and elements Has easily accessible panels for attributes and elements to the right of the document editing area. You can double-click an attribute or element to insert it. Also includes an Insert menu. Has easily accessible panels for attributes and elements to the right of the document editing area. You can double-click an attribute or element to insert it. Also includes a DITA > Insert sub-menu. The menu is not as full-featured as the one in XMetal. You have to rely more on the panels.
Metadata Added using a dialog box. Added using a pop-up list in the editing window.
Table Editing
  • Provides a simple dialog box for inserting table types: Normal, Properties, Simple, or Step Choice.
  • Editing in the WYSIWYG view is as simple as table editing in MS Word. You can insert rows above and below, columns to the left and right, etc. The Table Properties dialog box enables you to fine-tune the format at the table, column, row, or cell level.
  • Provides a right-click menu to access table commands, as well as a toolbar.
  • Table types are CALS or simple.
  • Table editing is not as flexible or intuitive. For example, I could insert a row below another row but not above. I had to use the Text (raw tags) view to cut and paste a row above another row.
Images
  • Enables you to apply numerous properties before insertion: alt, description, dimensions, text wrapping, and alignment.
  • A second properties tab in the dialog box provides additional choices such as revision and status (such as new or changed).
  • When you insert a figure caption, XMetal inserts the fig tag and the necessary p tags.
  • Provides menu commands (main and right-click) for image insertion, but you have to add image properties afterward. The properties are available on the Attributes panel.
  • Inserting a figure caption requires extra steps. You have to wrap the img tag with the fig tags and then add a p tag after the opening fig tag.
Links Easy to insert. XMetal automatically assigns an ID to cross-references. Easy to insert, though I had to manually assign IDs.
Change tracking Simple to use. You can turn Track Changes on and off, make changes, and accept or reject them. Setup options are available in the Options dialog box. This feature is very similar to that of MS Word, though with fewer options. Very similar to XMetal's implementation. The main difference is that you can control option settings at the global level or project level.
Reusable components Enables you to select content and convert it to a reusable component. XMetal then creates a separate XML file known as a conref (content reference). This file can then be referenced from other files in a DITA project. Not supported. oXygen Support tells me that at this point you have to assign IDs to elements and reference the IDs. So basically you are simply creating cross-reference links--not reusing content.
Next next next
Next next next
Next next next