keymap paths not resolving in Oxygen

Post here questions and problems related to editing and publishing DITA content.
AlastairDent
Posts: 21
Joined: Wed May 18, 2016 6:52 pm

keymap paths not resolving in Oxygen

Post by AlastairDent »

Given this structure:

/maps
/images
/ditacontent

where maps contains maps and keymaps, ditacontent contains dita topics.

with a key definition of this:
<keydef keys="image-keyname" href="images/imagefile.JPG" format="jpg"/>

The output will build in the DITA-OT, resolving the keys and inserting the images appropriately.

However it will not resolve the images in the Oxygen editor, nor will it build from Oxygen and insert the images.
Radu
Posts: 9446
Joined: Fri Jul 09, 2004 5:18 pm

Re: keymap paths not resolving in Oxygen

Post by Radu »

Hi Alastair,

I'm sorry but I cannot reproduce the situation on my side. Could you possibly create a small DITA project to reproduce the issue, zip it and send it to support@oxygenxml.com?

From what I know the kind of folder hierarchy you are mentioned (DITA Maps not located on the top level folder) always had publishing problems with the DITA OT:

https://www.oxygenxml.com/doc/versions/ ... -refs.html

But there were never editing problems on such folder structures.
As you mentioned publishing works with DITA OT, do you use your custom DITA OT installation?

Regards,
Radu
Radu Coravu
<oXygen/> XML Editor
http://www.oxygenxml.com
AlastairDent
Posts: 21
Joined: Wed May 18, 2016 6:52 pm

Re: keymap paths not resolving in Oxygen

Post by AlastairDent »

I've emailed a sample project that reproduces this issue.

The graphic displays in Oxygen but can't be found when transformed.

I'm using DITA 2.2.5 with a custom plugin, from C:\Program Files\Oxygen XML Editor 17\frameworks\dita\DITA-OT2.x
Radu
Posts: 9446
Joined: Fri Jul 09, 2004 5:18 pm

Re: keymap paths not resolving in Oxygen

Post by Radu »

Hi Alastair,

Thanks for the samples.
One problem I see with the samples is that the image on disk is called "blob.jpg" but it's referenced in the DITA Map with incorrect path capitalization like "....blob.JPG". So this should be corrected although it does not influence the current behavior (it would if you were running Oxygen on Linux).

Otherwise, the original project is valid and it does not work when published because of DITA Open Toolkit bugs.
So this is why I initially recommended these two workarounds for you:

https://www.oxygenxml.com/doc/versions/ ... -refs.html

Regards,
Radu
Radu Coravu
<oXygen/> XML Editor
http://www.oxygenxml.com
AlastairDent
Posts: 21
Joined: Wed May 18, 2016 6:52 pm

Re: keymap paths not resolving in Oxygen

Post by AlastairDent »

You say this doesn't publish due to DITA-OT bugs, but as I explained earlier, I had no problems with the original structure:
maps
content
images

when publishing from dita-ot using an ANT build file.

I ONLY get problems when doing transformations from Oxygen.
Radu
Posts: 9446
Joined: Fri Jul 09, 2004 5:18 pm

Re: keymap paths not resolving in Oxygen

Post by Radu »

Hi Alastair,

Oxygen starts the DITA OT as an external process.
Could you double check this works from the command line? If so, could you give me more details about how you start the DITA OT processing from the command line? What parameters you send it... If you have a custom build.xml you can also send it via email along with the rest of the details.

Regards,
Radu
Radu Coravu
<oXygen/> XML Editor
http://www.oxygenxml.com
AlastairDent
Posts: 21
Joined: Wed May 18, 2016 6:52 pm

Re: keymap paths not resolving in Oxygen

Post by AlastairDent »

I have triple-checked that I can run this ok from the command line.

I need a different path setup - but it is perfectly possible for me to use the structure:
maps/
content/
images/

with DITA-OT.

I can get a setup where oxygen will generate a pdf with the images ok, but it can't display them.
I think that the issue is that the DITA-OT parses the paths in a particular way (which isn't a bug, it is a set of rules that are quite clear) and Oxygen as an editor struggles with this.
Radu
Posts: 9446
Joined: Fri Jul 09, 2004 5:18 pm

Re: keymap paths not resolving in Oxygen

Post by Radu »

Hi Alastair,
I can get a setup where oxygen will generate a pdf with the images ok, but it can't display them.
Can you provide details about that setup for me? It would help me test things on my side.
I think that the issue is that the DITA-OT parses the paths in a particular way (which isn't a bug, it is a set of rules that are quite clear) and Oxygen as an editor struggles with this.
In most cases it's the other way around.

Regards,
Radu
Radu Coravu
<oXygen/> XML Editor
http://www.oxygenxml.com
AlastairDent
Posts: 21
Joined: Wed May 18, 2016 6:52 pm

Re: keymap paths not resolving in Oxygen

Post by AlastairDent »

With directory structure
maps
images
content

in keymap, where keymap is in maps directory.
<keydef keys="key_D" href="images/someimage.JPG" format="jpg"/>

is parsed successfully by DITA-OT

In bookmap, topicrefs have the form

<topicref href="../content/some_topic_name.dita">
AlastairDent
Posts: 21
Joined: Wed May 18, 2016 6:52 pm

Re: keymap paths not resolving in Oxygen

Post by AlastairDent »

We had settled on a structure where maps where at a lower level than images.

However, a preference has been expressed for this structure:

/corporate
corporate-imagemap
/images

/product
product maps
product-image-maps
/images

I cannot get this to work. Any references to /corporate/images breaks references to all images during transformation. Is this just a flaw in the DITA-OT transform?

Extra info: I have tried setting generate.copy.outer=3 and using dita-ot 2.3.
Radu
Posts: 9446
Joined: Fri Jul 09, 2004 5:18 pm

Re: keymap paths not resolving in Oxygen

Post by Radu »

Hi Alastair,

The DITA OT has always had problems publishing when the published DITA Map is not on the topmost folder, if there are references outside of the main DITA Map folder.
So for this kind of problem right now there are only two possible choices:

https://www.oxygenxml.com/doc/versions/ ... -refs.html

Regards,
Radu
Radu Coravu
<oXygen/> XML Editor
http://www.oxygenxml.com
AlastairDent
Posts: 21
Joined: Wed May 18, 2016 6:52 pm

Re: keymap paths not resolving in Oxygen

Post by AlastairDent »

That option helps somewhat - the images that are outside of the map tree are just omitted (without error message) but at least all other images are included.
Radu
Posts: 9446
Joined: Fri Jul 09, 2004 5:18 pm

Re: keymap paths not resolving in Oxygen

Post by Radu »

Hi Alastair,

Does the validate and check for completeness report any problem?
If you can put together a small sample project and send us the ZIP via email we could take a look at it.

Regards,
Radu
Radu Coravu
<oXygen/> XML Editor
http://www.oxygenxml.com
AlastairDent
Posts: 21
Joined: Wed May 18, 2016 6:52 pm

Re: keymap paths not resolving in Oxygen

Post by AlastairDent »

Validation does not report any problem.

I have emailed a zipped project to support@oxygenxml.com
Post Reply