Technical Writing with oXygen

For oXygen I have to thank my colleague Mark. He was looking for an XML editor for script programming and downloaded a test version of oXygen. Soon we found out that with oXygen we could easily create XML documentation in common standards like DITA or Docbook. We bought a floating license for the oXygen XML Editor, which we intended to share.

At the same time, some of our customers requested oXygen. We started to use the program productively for authoring. Poor Mark was left with nothing – our floating license was now constantly in use by me. Fortunately, you can always buy more licenses.

Versions

In addition to the full version, oXygen offers two limited versions: XML Developer is suitable for things like schema design and XSLT development. XML Author provides all functionality for writing XML-based documentation. Those looking for a tool to only create standard DITA files, should go for XML Author.

Learning Curve

Technical writers, who have used Word or unstructured FrameMaker so far, may find it more difficult to switch to oXygen. They are probably not familiar with the basic principles of XML-based documentation, such as:

  • Separation of layout and content
  • Thinking in elements and rule-based content structures instead of paragraph styles
  • Variant management and output control using attributes
  • Topic-oriented authoring (not really an XML principle, but used in many XML environments)

Technical writers who have already worked with XML will quickly feel at home. They will also be pleased that they won’t have to install a number of plug-ins or edit configuration files before they can produce a first result (hello FrameMaker!).

Instant Output

What I liked straightaway: I could open a DITA map that I had created in FrameMaker in a default oXygen installation – and at the click of a button, produce a web help and a PDF file. Of course, the results are not yet suitable for publishing. They have to be adjusted to corporate standards. But they are good for a review anyway.

Mouse vs Keyboard

oXygen offers flexible views and handling. Authors who are used to WYSIWYG editors will prefer the Author mode where they can completely hide the XML tags. Authors with a more technical background might use the Text mode that displays raw XML. In both modes, you have many possibilities to add elements and attributes, for example, auto completion, pop-up menus, or catalogs .

Oxygen_DITA

1 – DITA Maps Manager: Lets you edit the map in the tree structure.
2 – Outline: Hierarchical content view, similar to the structur view in FrameMaker.
3 – Editor in the Author mode: Lets you configure which XML tags you see or hide the tags altogether.
4 – Elements Catalogue: At the current position, invalid elements are displayed in grey.
5 – Transformation Scenarios: The currently configured output format.

Perfect Layout?

If I have the choice to edit DITA files in FrameMaker or oXygen, I go for oXygen. The only fly in the ointment: You cannot easily adjust the PDF layout. FrameMaker lets you create templates grafically with onboard tools. oXygen requires knowledge in XSLT or CSS to customize the layout. Plus, you cannot manually manipulate page breaks and the like before printing. But if your focus is on automation rather than a perfect layout, you should be all right.

Blog

tcworld 2018: What's New with iiRDS?

iiRDS was one of the central topics at the tcworld conference 2018: at the new iiRDS Café, in lectures, showcases, and tutorials. There was also a discussion on Twitter, among other things about the name, which is so difficult to pronounce. more ...

tcworld 2018 part 3: Creative online videos for technical documentation

Clear the stage! At the beginning of his workshop "Creating thrilling online videos", Stephan Schneider showed two pictures. more ...

tcworld 2018 part 2: Virtual and actual highlights

The sun is shining brightly as I arrive for my first tekom. Inside, the conference is already in full swing. Two days of presentations, workshops, fair impressions and conversations await. more ...

tcworld 2018 part 1: Legal Requirements vs Readability

At this year's tcworld conference, there were a lot of discussions about standards and regulations for technical documentation. Experts such as Jens-Uwe Heuer-James and Torsten Gruchmann came together for a panel discussion where the following was repeatedly said: "We need an IEC 82079-1!" more ...

Working in self-organizing teams. Or: how we get rid of management

Today's world is VUCA : volatile, uncertain, complex, and ambiguous. Companies are facing complex challenges such as Industry 4.0 and the Internet of Things. Those who do not respond fast, may be driven out of the market. more ...
  • linkedin
  • xing