Publication TOC on chunked ditamap

Having trouble installing Oxygen XML WebHelp? Got a bug to report? Post it all here.
hugi
Posts: 4
Joined: Tue Sep 08, 2020 12:05 pm

Publication TOC on chunked ditamap

Post by hugi »

Hi there,
I hope I'm not asking something that has already been answered, but I haven't found any posts on this exact matter on the forum.

I have been tasked to generate a single-page WebHelp output in addition to the standard output from a ditamap containing numerous topics.
I used the chunk attribute with the value "to-content" on the map and, in another test sample, the "root-chunk-override" argument juste to see if there would be any differences, to achieve the desired result. While I’m able to customize the whole thing with fragments, I’m stuck on the publication TOC. I’ve been asked to include the publication TOC in the single-page output, but I understand that oXygen automatically removes it from this type of output, and I'm left with the topic TOC, which only contains what is considered as sections.

So my question is: is it possible to get a standard publication TOC (starting to level 1 entries) on a single-page WebHelp output as one would have on the left of a standard WebHelp output?
I guess it would be possible by using an HTML transformation scenario, or a DITA-OT plugin, but the responsive aspect would be harder to manage.
The thing is that the solution needs to be simple enough to be easily adapted and/or modified in the future by other people, which is why I have doubts about an HTML output or adding a DITA-OT plugin, especially since we use a CCMS.

Thank you for your help.

Hugo
Hugo Sylvestre
Post-scriptum - Technical authoring, Publishing, Workshops, Translation
julien_lacour
Posts: 800
Joined: Wed Oct 16, 2019 3:47 pm

Re: Publication TOC on chunked ditamap

Post by julien_lacour »

Hi Hugo,

You can generate a single page WebHelp output using a structure similar to this one:

Code: Select all

<map>
    <title>Map</title>
    <topicref href="index.dita" chunk="to-content">
        <topicref href="first.dita">
            <topicref href="topic.dita"/>
        </topicref>
        <topicref href="second.dita"/>
        <topicref href="third.dita"/>
    </topicref>
</map>
In this situation you will use index.dita as the actual main page. You will need to enable the 'webhelp.skip.main.page.generation' so that default index.html is not generated.

By default this output will not have the publication TOC as there's a single topic without siblings. The topic TOC will contains both topics and sections titles.
If you only want the publication TOC, you can disable both 'webhelp.publication.toc.hide.chunked.topics' and 'webhelp.show.topic.toc', you will then get it with the topics titles.

Regards,
Julien
hugi
Posts: 4
Joined: Tue Sep 08, 2020 12:05 pm

Re: Publication TOC on chunked ditamap

Post by hugi »

Hi Julien,

Thank you for your reply.

I did try using 'webhelp.publication.toc.hide.chunked.topics' and 'webhelp.show.topic.toc' without any luck, but hadn't considered trying 'webhelp.skip.main.page.generation'.
I'll give it a go with my custom transformation scenario.

Thanks again!

Hugo
Hugo Sylvestre
Post-scriptum - Technical authoring, Publishing, Workshops, Translation
Post Reply