webhelp topic tranformed into html file with '-1' appended

ann.jensen
Posts: 240
Joined: Wed Jun 17, 2015 10:19 am

webhelp topic tranformed into html file with '-1' appended

Post by ann.jensen » Fri Dec 02, 2016 3:50 pm

Hi,
I have some standard topics being transformed via WebHelp to html files with '-1' appended to end of file name and I don't understand why.
e.g.

Code: Select all

\system_documentation\dita_files\AGSSystems\AspeniProperties\tasks\Inspection\Off_Cycle_Inspections\condition\t_complete_insp_user_details.dita
is transformed into

Code: Select all

/system_documentation/dita_files/AGSSystems/AspeniProperties/tasks/Inspection/Off_Cycle_Inspections/condition/t_complete_insp_user_details-1.html
This topic is referenced from one ditamap and one reltable entry.
Any advice appreciated,
Regards,
Ann

Radu
Posts: 7094
Joined: Fri Jul 09, 2004 5:18 pm

Re: webhelp topic tranformed into html file with '-1' appended

Post by Radu » Fri Dec 02, 2016 5:18 pm

Hi Ann,

From what I saw DITA OT 2.x seems to generate unique file name suffixes like "-1" when the topic is referenced more than one time in the DITA Map and when it has keyrefs (even when there are no key scopes involved).
I logged the issue here:

https://github.com/dita-ot/dita-ot/issues/2363

So besides the related link, that topic is not referenced twice in the manual, right? Can I get some samples for this?

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

ann.jensen
Posts: 240
Joined: Wed Jun 17, 2015 10:19 am

Re: webhelp topic tranformed into html file with '-1' appended

Post by ann.jensen » Fri Dec 02, 2016 5:30 pm

Hi Radu,
Yes that's right, one reference from a map and one from a reltable. I was just tinkering with it and find that if I set the following on the reltable topicref

Code: Select all

 processing-role="resource-only"
then it doesn't generate a second html file.
I was having trouble with links to this type of file as it wasn't generating the breadcrumbs properly due to there being 2 html files generated.
I will try to send you on a sample shortly.
Regards,
Ann

ann.jensen
Posts: 240
Joined: Wed Jun 17, 2015 10:19 am

Re: webhelp topic tranformed into html file with '-1' appended

Post by ann.jensen » Fri Dec 02, 2016 5:47 pm

Sorry, proving difficult to recreate the problem I was having in our internal project...which I cannot share in its totality with you.
I will keep trying.
Regards,
Ann

ann.jensen
Posts: 240
Joined: Wed Jun 17, 2015 10:19 am

Re: webhelp topic tranformed into html file with '-1' appended

Post by ann.jensen » Mon Dec 05, 2016 3:17 pm

Hi,
I cannot recreate this problem in a simple map :-|
However, I can confirm that the issue is occurring for a topic that is referenced just once from a topicref and once from a reltable.
The topicref is in a map that has a keyscope value set on it. I am not sure if this is part of the problem.
Regards,
Ann

Radu
Posts: 7094
Joined: Fri Jul 09, 2004 5:18 pm

Re: webhelp topic tranformed into html file with '-1' appended

Post by Radu » Mon Dec 05, 2016 3:21 pm

Hi Ann,

It's probably again a DITA OT bug. I'm still digging in that sample project with key scopes an links that you attached, again it is a bug, I will update the other thread when I have something.

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

ann.jensen
Posts: 240
Joined: Wed Jun 17, 2015 10:19 am

Re: webhelp topic tranformed into html file with '-1' appended

Post by ann.jensen » Tue Dec 06, 2016 12:37 pm

Hi Radu,
My interim fix is to change my <reltable> entries to <related-link> entries. This seems to stop the extra html file being generated and so allows me to implement working cross-references.
I look forward to hearing how you get on with it. Good luck.
Regards,
Ann

Radu
Posts: 7094
Joined: Fri Jul 09, 2004 5:18 pm

Re: webhelp topic tranformed into html file with '-1' appended

Post by Radu » Tue Dec 06, 2016 2:48 pm

Hi Ann,

So for our discussion from:

post40638.html#p40675

I added a DITA OT issue and Jarno Elovirta the main DITA OT developer started looking into it.

For the issue reported on this thread I do not yet samples to test with.

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

ann.jensen
Posts: 240
Joined: Wed Jun 17, 2015 10:19 am

Re: webhelp topic tranformed into html file with '-1' appended

Post by ann.jensen » Mon Dec 12, 2016 12:45 pm

Hi Radu,
I have pulled down the latest DITA-OT 2.4.1 which I believe has a fix for issue https://github.com/dita-ot/docs/commit/ ... cb3dc2f02e.
When I transform using webhelp, I am not getting a second html file generated (with -1 appended) for topics that previously did...but I am getting references to such files e.g. from the partent topic.
So duplicate files are not being generated for topics with multiple topicrefs in the same map...but references to such duplicate files are being generated.
Do I need to wait for an updated WebHelp plugin also?
Any advice appreciated,
Regards,
Ann

Radu
Posts: 7094
Joined: Fri Jul 09, 2004 5:18 pm

Re: webhelp topic tranformed into html file with '-1' appended

Post by Radu » Tue Dec 13, 2016 12:19 pm

Hi Ann,

If you see my comments on the issue I added about key scopes and linking:

https://github.com/dita-ot/dita-ot/issues/2538

Jarno's fix is not complete and it does not resolve your reported problem, Jarno wanted to have a better fix in a future DITA OT version.

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

ann.jensen
Posts: 240
Joined: Wed Jun 17, 2015 10:19 am

Re: webhelp topic tranformed into html file with '-1' appended

Post by ann.jensen » Mon Feb 13, 2017 3:30 pm

Hi,
I am just revisiting this issue again and want to confirm the expected outcome for the given scenario.
Using Oxygen XML Author 18.1 build 2017013018, I have a topicref within a submap of a parent map where the parent map has a keyscope set i.e. keyscope="wf_iproperty_scope".

Code: Select all

<topicref href="../../vendor_registration/vendor_reg_mod_ip.dita" collection-type="sequence">
Outside of this submap and its parent map I have a reltable entry that references the same topic.

Code: Select all

 <topicref href="WF_iProperty/vendor_registration/vendor_reg_mod_ip.dita" format="dita"  type="concept" scope="local"/>
This results in the generation of 2 HTML files for that topic i.e. vendor_reg_mod_ip.html and vendor_reg_mod_ip-1.html.

The link generated for the topic's parent links to vendor_reg_mod_ip-1.html. This HTML file contains links to the child topics but does not include the link for the related concept (defined in the reltable).
The generated vendor_reg_mod_ip.html contains the link for the related concept (from the reltable) but does not contain links for its child topics. Also vendor_reg_mod_ip.html is not linked to from anywhere in the generated webhelp.

Is this as expected?
Thanks,
Ann

Radu
Posts: 7094
Joined: Fri Jul 09, 2004 5:18 pm

Re: webhelp topic tranformed into html file with '-1' appended

Post by Radu » Mon Feb 13, 2017 3:51 pm

Hi Ann,

Once you have topics inside key scopes, all the references (especially the outside references like related links in your case) to them should be made using @keyref because using @keyref you can also specify the keyscope of the referenced topic.
So probably in the "wf_iproperty_scope" keyscope you would also define a key for the topic:

Code: Select all

<topicref href="../../vendor_registration/vendor_reg_mod_ip.dita" collection-type="sequence" keys="vendor">
and in the reltable which is probably outside of the keyscope refer to it like:

Code: Select all

 <topicref keyref="wf_iproperty_scope.vendor"/>
I'm not sure if this works or not in the publishing but this it how the DITA content should look like. At some point I added an issue for it and it seems that it was not fixed:

https://github.com/dita-ot/dita-ot/issues/2393

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

ann.jensen
Posts: 240
Joined: Wed Jun 17, 2015 10:19 am

Re: webhelp topic tranformed into html file with '-1' appended

Post by ann.jensen » Mon Feb 13, 2017 6:20 pm

Hi Radu,
Yes, that makes a big difference. The extra html file is no longer being produced and the Related Concepts appear fine and link correctly.
thanks,
Ann

Post Reply