Reviewing Chunked Topics in Context

dliu
Posts: 3

Reviewing Chunked Topics in Context

Fri Jul 21, 2017 7:31 pm

Hello,

Our Japanese translator has encountered an issue when in-country reviewers (ICRs) review chunked topics.

Our ICRs are engineers who do not have oXygen. The translator gives the ICRs bilingual review docs (Word format) exported from SDL Trados Studio for each DITA topic, as well as the webhelp or PDF output to provide context. The problem is, if the ICR is reviewing a chunked topic, there is no context. The ICR does not know where the chunked topic appears in the output, and must ask the translator to open the ditamap in oXygen in order to understand the context.

Is there an easier/faster way to know where a chunked topic appears in the output, without having to open the ditamap in oXygen? For example, is there an efficient way to generate an easy-to-read map that shows where chunked topics are located in the output?

We currently don’t have a CCMS and are looking for a workaround in the meantime.

Thanks!
Di
Radu
Posts: 5088

Re: Reviewing Chunked Topics in Context

Mon Jul 24, 2017 7:54 am

Hi,

I do not quite understand this. You mentioned that the translators also get the Webhelp and PDF outputs. If they are the outputs for the entire DITA Map, they can probably look in there for context.
You also mentioned:

The problem is, if the ICR is reviewing a chunked topic, there is no context.


But if they review a single topic is there enough context? I do not clearly see the difference between reviewing a single topic and a chunked topic.

Regards,
Radu
Radu Coravu
<oXygen/> XML Editor
http://www.oxygenxml.com
dliu
Posts: 3

Re: Reviewing Chunked Topics in Context

Tue Sep 19, 2017 7:15 pm

Hi Radu,

In SDL Trados Studio (translation software), we export each topic as s a bilingual review doc (Word format).

For example, I have a chunked topic (X) made up of three topics (A, B, C).

The reviewer receives 3 bilingual review docs: A, B, and C.

He also receives the PDF or Webhelp for reference.

You are right, the PDF or Webhelp contains X. However, the reviewer may not know that A, B, and C are not isolated files, but actually chunked together into X. If he does figure this out, he cannot easily find X in the output; he must ask the project manager to look in the root map to provide the location.

Thanks!
Di
Radu
Posts: 5088

Re: Reviewing Chunked Topics in Context

Wed Sep 20, 2017 11:51 am

Hi Di,

I think I understand your use case now.
In the DITA OT 2.x publishing engine bundled with Oxygen there is a plugin we developed:

OXYGEN_INSTALL_DIR\frameworks\dita\DITA-OT2.x\plugins\com.oxygenxml.editlink

which adds an edit link after each topic title in both the PDF and WebHelp output.
There is also an Oxygen XML GitHub open source project for the same plugin:

https://github.com/oxygenxml/dita-reviewer-links/

Based on your feedback, I updated the GitHub project and added a new parameter called "editlink.present.only.path.to.topic" which when set to "true" will present after each topic title in both the PDF and WebHelp output the relative reference to the original DITA topic from which the topic was generated.

Installing a plugin in the DITA OT 2.x bundled with Oxygen:

https://www.oxygenxml.com/doc/versions/19.0/ug-editor/topics/dita-ot-install-plugin.html

So if you download from GitHub and install this updated plugin in the DITA OT installation that you are using to publish to PDF and WebHelp your published content should have references to the original topics after each topic title.

Regards,
Radu
Radu Coravu
<oXygen/> XML Editor
http://www.oxygenxml.com

Return to “DITA (Editing and Publishing DITA Content)”

Who is online

Users browsing this forum: No registered users and 0 guests