Documentation Center

Arbortext Editor change tracking support in Contenta S1000D

This topic explains the caveats of using the Arbortext Editor change tracking feature with Contenta S1000D tools.

Even though Arbortext Editor change tracking markup cannot permanently reside in S1000D modules for them to be S1000D specification compliant, authors, reviewers, and editors may find it useful to employ Arbortext Editor's native change tracking capabilities while in internal edit-review cycles.

Perhaps an author in the workpool checks out a module and performs additions and deletions. These changes, and who made them, are tracked and displayed using the Arbortext Editor's native change tracking display mechanisms. When the author checks the module back in, Contenta S1000D preserves this proprietary, non-S1000D specification markup for the next person in the workpool who checks out the module, perhaps an editor or a reviewer. Therefore, edits performed by one person in the workpool can be reviewed by the next person who checks out that same module.

The project manager, or final reviewer, then accepts or rejects the changes before posting the module for publishing or archiving.

The following Contenta S1000D tools have been modified to work with Arbortext Editor change tracking:
  • Arbortext (round-trip edit)
  • Arbortext Check Out
  • Arbortext Check In
  • Arbortext Fetch
  • S1000D PM Builder
  • S1000D Publish
  • Contenta S1000D Arbortext Editor plug-in
These tools detect Arbortext Editor's atict:add (insert), atict:del (delete), atict:info and atict:user (who made the changes), and xmlns:atict (atict namespace) change tracking elements and attributes. You can expect the following behavior:
  • Whether run from inside Arbortext Editor, or directly from Contenta Explorer or Contenta Web, LiveContent Preview and Validate will not display Arbortext Editor change tracking; your changes will not be highlighted, and your deletions will still be visible.
  • To enable check in, Contenta S1000D removes the atict:info and atict:user elements that appear before the module's root element. These same two elements also appear after the root element in the module, along with atict:add (one for each insertion), and atict:del (one for each deletion) .
  • You cannot edit a Publication Module that contains atict:add or atict:del markup. You must first accept or reject all changes in Arbortext Editor before you can run PM Builder on that Publication Module.
  • When publishing from a project, S1000D Publish will not highlight text inserted with Arbortext Editor change tracking on and will display text deleted. However, S1000D Publish will issue warnings if it finds modules that still contain Arbortext Editor add/delete change tracking markup. With publishing from the stable data repository, you will get errors, and Publish will not produce output.