Page 1 of 1
How to customize base toc filename in webhelp output?
Posted: Thu Sep 08, 2022 4:20 pm
by AnnetteSo
I'm experimenting with the Oxygen publishing templates. I'm trying the responsive webhelp template. Can I customize the toc base file name to something other than index.html? It would be the equivalent of args.html5.toc, which doesn't work on the webhelp output. I can't find an equivalent webhelp prop.
I need to do this because several of our main level maps are built separately and referenced as peer links in the top level map.
What I'm also finding is that when Oxygen builds the top level map to webhelp, it encodes the child map peer links as ditamap format links, instead of html links.
Re: How to customize base toc filename in webhelp output?
Posted: Mon Sep 12, 2022 2:04 pm
by cosmin_andrei
Hello,
Thank you for contacting us!
Unfortunately this is not possible in the current implementation. We have added an issue in our internal tracking system (you will be notified when/if this will get implemented in a future release of Oxygen)
Re: How to customize base toc filename in webhelp output?
Posted: Mon Sep 12, 2022 2:49 pm
by chrispitude
AnnetteSo wrote: ↑Thu Sep 08, 2022 4:20 pmI need to do this because several of our main level maps are built separately and referenced as peer links in the top level map.
What I'm also finding is that when Oxygen builds the top level map to webhelp, it encodes the child map peer links as ditamap format links, instead of html links.
Hi Annette,
Can you share a sample of your map-to-map references?
Note that you might need some custom processing to handle references to a ditamap, either local by key or peer. While the DITA Open Toolkit supports in-place inclusion of submaps, it does not really have any support for references to maps. Here is some related discussion:
dita-users.groups.io - Does a key reference to a <mapref> have any meaning?
Re: How to customize base toc filename in webhelp output?
Posted: Thu Sep 15, 2022 10:35 pm
by AnnetteSo
Thank you. Here's a snapshot of our map structure. It shows our top level poc_platform_toc.ditamap with child maps. The highlighted map is an example of a map that is built separately, hence the peer attribute.
If I build in standalone dita-ot to html5 format, I can use the args.html5.toc attribute to rename the output top-level file for the highlighted map to care_platform_toc.html instead of index.html, where care_platform_toc.html is the filename that is encoded in the transformed top level map, hence the link resolves correctly in the output html.
Also, when I build with the Oxygen webhelp scenario, the map link in the top level map gets encoded as care_platform_toc.ditamap instead of care_platform_toc.html.
image.png
Re: How to customize base toc filename in webhelp output?
Posted: Fri Sep 16, 2022 2:10 pm
by chrispitude
Hi Annette,
Thank you! Could you also share the text representation of this part of the map?
Re: How to customize base toc filename in webhelp output?
Posted: Fri Sep 16, 2022 5:36 pm
by AnnetteSo
Hi, yes, here it is:
Code: Select all
<?xml version="1.0" encoding="utf-8"?>
<!DOCTYPE map PUBLIC "-//OASIS//DTD DITA Map//EN" "map.dtd">
<map xml:lang="en-us">
<title><keyword conref="wcm/common_files/conrefs_care.dita#reference_nwd_ncp_5pb/singleclient"
/></title>
<topicref href="single_client_solutions.dita" format="dita">
<mapref href="wcm/care_platform_toc.ditamap" scope="peer" navtitle="IBM Watson Care Platform"/>
</topicref>
</map>