Common Questions: Change Markup

All of the standard change markup functions are supported OOTB in Arbortext Editor and publishable through Arbortext Styler or Publishing Engine

This week’s topic: Change Markup

Change markup has traditionally been something that you had to implement yourself in XML publishing. Arbortext supports typical change markup behavior in the standard document types, and with a small amount of configuration for custom doctypes.

All of the standard change markup functions are supported OOTB in Arbortext Editor and publishable through Arbortext Styler or Publishing Engine. OOTB, you have support for Add, Delete, Modify. You can highlight changes, accept changes, and reject changes. You can even compare documents.

When combined with Arbortext Content Manager (ACM), you get the ability to add baselines to documents, to version, to create snapshots in time. You can recreate document output at any point in the document’s history and know that you’re producing today exactly what you froze then.

Today, we’re answering some of the more common and general questions about change markup content in Arbortext. You might want to read the article on reviewing content in XML or consult one of the related articles listed at the bottom of this post.

As always, if you have a question that we haven’t answered or if you want more details, remember to send us your questions or add them to the comments!

Question: Highlighting

Can a writer highlight specific parts of a draft for review?

Answer:

Yes

Question: Comparing Files

Does the ACM have a diff function?

Answer:

Comparisons between source files are handled in the Arbortext Editor not ACM.

Question: x

We would like to know the detailed specification regarding tags for change tracking. What tags does ACM insert into the XML file?

Answer:

ACM does not insert anything with regard to the change tracking functionality.

Change tracking is handled in Arbortext Editor. Change tracking supports the usual features — Add, Delete, Changed. You can highlight changes and accept or reject changes.

Question: Review comments

How are review comments incorporated into the source?

Answer:

Through the Change Markup mechanism

(You might also be interested in the article we wrote previously about reviewing content in XML.)

Question: Change Tracking

Can you simply click Accept/Reject/Modify?

Answer:

Yes

Change tracking happens as expect in most normal editing applications: Add, Delete, Changed, Highlight changes, Accept Changes, Reject changes, compare documents.. All of these are standard OOTB with Arbortext.

Common Questions: Reviewing XML Content

The question of reviewing content is a complex one. Answers to some of the more common and general questions about Reviewing XML content in Arbortext

This week’s topic: Reviewing XML Content in Arbortext

The question of reviewing content is a complex one. Every year, at the annual PTC user conference, this topic gets discussion. No one agrees on how the review process should work or what should be captured or even who’s responsible for what. But everyone agrees that finding a way to improve the effectivity of the review process is critical. And, tracking review comments and associating comments with the original source is essential.

In Arbortext, the question of review is likewise not as easy as it seems at first glance. There’s the use and application of change tracking in the desktop client and the lightweight web client. Some people create review-conscious stylesheets that create a review deliverable. There’s automation through workflow in Arbortext Content Manager, and the automatic association of review comments with originating source content.

It all depends on your business process and what works best in your environment. It’s one of the areas where we get a lot of questions and for which people often want a lot of guidance.

Today, we’re answering some of the more common and general questions about Reviewing XML content in Arbortext.  As always, if you have a question that we haven’t answered or if you want more details, remember to send us your questions or add them to the comments!

Question: Highlighting

Can a writer highlight specific parts of a draft for review?

Answer:

Yes.

Note that reviews can be addressed in multiple ways in Arbortext.

Question: Review Software

What software is required for reviewers? Please list the software applications needed and the associated cost for each license.

Answer:

There is no special software or license.

If you’re looking for a review tool that is integrated with your CCMS and that can create associative links between reviewer comments and the source material, ProductView addresses this need. ProductView provides a mechanism for reviewing content directly from the CCMS without having to check out that content by subject matter experts. ProductView comes packaged with the Arbortext Content Manager out-of-the-box at no additional cost.

Question: Collaborative reviews

Does the ACM support collaborative reviews? In other words, can more than one reviewer access the source content and provide comments at the same time?

Answer:

Yes, to both questions.

Question: Yellow Stickies

Can you add the equivalent of a “yellow stickie” to a file in which a reviewer needs to provide feeback?

Answer:

Yes, through a comparable mechanism that is always associated with the original source in ACM.

Question: Incorporating review comments

How are review comments incorporated into the source?

Answer:

Through the Change Markup mechanism

(We’ll talk more about in a future post…)

Question: Change markup

How can one track/audit the comments that a writer or editor accepts/rejects/modifies for each review?

Answer:

Through the Change Markup mechanism

Question: Viewing comments

Can each reviewer see comments from other reviewers who have previously provided feedback so they do not have to review the same contents twice?

Answer:

Yes, if they have sufficient permissions

Question: Reviewing translated content

Can translated content be integrated into the review process?

Answer:

Yes

Question: Reviewing versioned content

Can you version a commented document or component?

Answer:

Yes