oxygenxml
Chunking attribute not affecting TOC
- [ ] Applying the chunk attribute "to-content" to a topicref causes the sub-topics to be rendered as a single page, but does not change the nesting of the sub-topics in the TOC, which is still displayed as if they were separate topics, and links into a location within the combined topic page. This makes the TOC seem longer and more daunting, so we need a way to make the TOC just show actual pages.
- [ ] Also, there is no page TOC created within the page. A page TOC would improve page navigation, so we need a way to create one.
For a topicref that merges all contained topicrefs due to a chunk="to-content" attribute I suggest a parameter that could be added to the Webhelp transformation and that will remove/hide all the references to the contained topicrefs from the left-side Content pane and will add a mini-TOC with these references to the top of the combined (merged) topic page in the right-side pane. For example a parameter called webhelp.merged.minitoc.location with two possible values:
- toc - for leaving the references to contained topicrefs in the current location, which is in the left-side TOC pane,
- page - for removing/hiding the references to contained topicrefs from the left-side TOC tree and adding them to the top of the right-side pane.
Sounds like a good idea to me.
Would these be triggering some flags provided by the DITA OT, or would they be implementing new functionality that the OT does not provide?
The new parameter would implement new functionality that DITA-OT does not provide. The left-side Content pane is added by the Oxygen Webhelp plugin and the mini-TOC at the top of a Webhelp page would also be added by the Webhelp plugin.
I have noticed another issue with chunk="to-content". When I have several topicrefs marked as chunk="to-content", I get a number of errors related to linking:
System ID: C:\Users\Mark B\oXygen\userguide\DITA\UserManual.ditamap Scenario: Editor User Manual - WebHelp Input file: C:\Users\Mark B\oXygen\userguide\DITA\UserManual.ditamap Engine name: DITA-OT Severity: error Description: [DOTX031E]: The file file:/C:/Users/Mark%20B/oXygen/userguide/DITA/temp/webhelp/oxygen_dita_temp/references/topics/../topics/copyright.dita is not available to resolve link information. The location of this problem was at (File = C:\Users\Mark B\oXygen\userguide\DITA\UserManual.ditamap, Element = notices:1;34:44) Start location: 34:44 URL: http://www.oxygenxml.com/DITA-messages.html#msgs__DOTX031E
System ID: C:\Users\Mark B\oXygen\userguide\DITA\UserManual.ditamap Scenario: Editor User Manual - WebHelp Input file: C:\Users\Mark B\oXygen\userguide\DITA\UserManual.ditamap Engine name: DITA-OT Severity: error Description: [DOTX031E]: The file file:/C:/Users/Mark%20B/oXygen/userguide/DITA/temp/webhelp/oxygen_dita_temp/references/topics/../topics/introduction.dita is not available to resolve link information. The location of this problem was at (File = C:\Users\Mark B\oXygen\userguide\DITA\UserManual.ditamap, Element = topicref:2;39:37) Start location: 39:37 URL: http://www.oxygenxml.com/DITA-messages.html#msgs__DOTX031E
System ID: C:\Users\Mark B\oXygen\userguide\DITA\UserManual.ditamap Scenario: Editor User Manual - WebHelp Input file: C:\Users\Mark B\oXygen\userguide\DITA\UserManual.ditamap Engine name: DITA-OT Severity: error Description: [DOTX031E]: The file file:/C:/Users/Mark%20B/oXygen/userguide/DITA/temp/webhelp/oxygen_dita_temp/tasks/topics/../topics/installation.dita is not available to resolve link information. The location of this problem was at (File = C:\Users\Mark B\oXygen\userguide\DITA\UserManual.ditamap, Element = chapter:2;44:73) Start location: 44:73 URL: http://www.oxygenxml.com/DITA-messages.html#msgs__DOTX031E
System ID: C:\Users\Mark B\oXygen\userguide\DITA\UserManual.ditamap Scenario: Editor User Manual - WebHelp Input file: C:\Users\Mark B\oXygen\userguide\DITA\UserManual.ditamap Engine name: DITA-OT Severity: error Description: [DOTX031E]: The file file:/C:/Users/Mark%20B/oXygen/userguide/DITA/temp/webhelp/oxygen_dita_temp/tasks/topics/../topics/set-parameter-in-startup-script.dita is not available to resolve link information. The location of this problem was at (File = C:\Users\Mark B\oXygen\userguide\DITA\UserManual.ditamap, Element = topicref:24;88:75) Start location: 88:75 URL: http://www.oxygenxml.com/DITA-messages.html#msgs__DOTX031E
System ID: C:\Users\Mark B\oXygen\userguide\DITA\UserManual.ditamap Scenario: Editor User Manual - WebHelp Input file: C:\Users\Mark B\oXygen\userguide\DITA\UserManual.ditamap Engine name: DITA-OT Severity: error Description: [DOTX031E]: The file file:/C:/Users/Mark%20B/oXygen/userguide/DITA/temp/webhelp/oxygen_dita_temp/tasks/topics/../topics/start-application.dita is not available to resolve link information. The location of this problem was at (File = C:\Users\Mark B\oXygen\userguide\DITA\UserManual.ditamap, Element = topicref:26;92:91) Start location: 92:91 URL: http://www.oxygenxml.com/DITA-messages.html#msgs__DOTX031E
These do not seem to be caused by actual links in other parts of the content, as I can't find references to the topic IDs elsewhere in the project. I think they are being caused when the web help tries to create forward and back links.
This is the only reason I can think of that there would be an issue with copyright.dita, since it immediately precedes a topicref with a chunk attribute. However, forward and back links are being created to and from copyright from introduction, so I'm not entirely sure what the issue is.
This issue can be seen in checkin abaaa23bf4f26c1c0f97554ced1e1324137f969b in the dev branch.
Hi Mark,
We traced this issue inside the DITA-OT processing code, somewhere inside the Java classes from the dost.jar library. This seems to be recorded also as a DITA-OT issue at https://github.com/dita-ot/dita-ot/issues/1470 We also were not able to see a specific problem in the output and the issue cannot be reproduced with DITA-OT 2.0 so I am not sure it makes sense to investigate that enough to provide a fix.
Regards, George
