Responsive: highlight, related-links & passthrough

Tristan
Posts: 30
Joined: Tue Jun 02, 2015 2:01 pm

Responsive: highlight, related-links & passthrough

Post by Tristan » Mon Oct 24, 2016 2:53 pm

Hi,
I'm a big fan of the responsive webhelp output, a huge step forward from the former webhelp.
Upon tweaking it I found a few issues, especially number 2 has a larger impact when switching to the responsive webhelp.

1. In DITA: when having the word 'Undefined' in an inline element (keyword, span,... ) this is on output translated to a <span>.
The highlight script however picks up this word and highlights 'undefined' for no reason whatsoever. Probably a small code bug.

2. In DITA: <related-links> are interesting to put related information right behind the relevant topic. Links via Reltables are interesting to have listed at the end of a collection of topics which are grouped on the same output page. In the responsive webhelp, the links from <related-links> are however taken away from their position (behind the topic they are associated with) and moved to a position behind the last topic.

3. Ditaval passthrough profiling values are great for making content filtering possible on your output. In the 'old' webhelp these were applied on nearly all locations such as on the links in the large TOC. In the responsive design this is also still present in the topmenu; this information is however missing in the 'chapter' side menu of a topic page. It would be great if the profiling attribute could also be present on those links.

Best regards,

Tristan

alin
Site Admin
Posts: 142
Joined: Thu Dec 24, 2009 11:21 am

Re: Responsive: highlight, related-links & passthrough

Post by alin » Tue Oct 25, 2016 10:09 am

Hello,

Thank you for reporting these problems.
For cases 1 & 3 I have registered an issue on our issue tracking tool. You will be notified when they are fixed.

For number 2, if you set the "webhelp.merge.nested.topics.related.links" parameter to "no", then the related links sections from subtopics will not be moved at the end of the parent topic. Note that this parameter is available since oXygen / WebHelp Plugin 18.1.

Regards,
Alin
Alin Balasa
Software Developer
<oXygen/> XML Editor
http://www.oxygenxml.com

Tristan
Posts: 30
Joined: Tue Jun 02, 2015 2:01 pm

Re: Responsive: highlight, related-links & passthrough

Post by Tristan » Tue Oct 25, 2016 10:37 am

Thanks for the quick reply and creating tickets, I'm looking forward to a solution.

I'm happy there is an easy 'solution' for 2.
I would expect the default value of webhelp.merge.nested.topics.related.links to be "yes" as this is what is described as the standard behavior:
https://www.oxygenxml.com/dita/stylegui ... ement.html

Best regards,

Tristan

alin
Site Admin
Posts: 142
Joined: Thu Dec 24, 2009 11:21 am

Re: Responsive: highlight, related-links & passthrough

Post by alin » Wed Oct 26, 2016 12:52 pm

Hello,

The values for the "webhelp.merge.nested.topics.related.links" parameter have the following meaning:
  • yes - The related links sections will be extracted from the subtopics content and merged with the one in the parent topic.
  • no - The related links sections are left in their original location.
The default value is "yes".
This is a WebHelp Responsive specific parameter. It was not intended to be compliant with the DITA Style Guide or with the DITA Specifications.
It was created because many of our users wanted that all related links to be grouped in a single section in case of nested topics.

Regards,
Alin
Alin Balasa
Software Developer
<oXygen/> XML Editor
http://www.oxygenxml.com

Post Reply