WebHelp TOC Level Definition
-
LASSE_MLE
- Posts: 38
- Joined: Mon Dec 05, 2022 3:24 pm
WebHelp TOC Level Definition
SW: oXygen/> XML Editor 24.1, build 2022030807
Scenario: DITA Map WebHelp Responsive
Hello,
Currently generating a WbeHelp for our technical documentation package, I am searching for a parameter to set the level/granularity of the TOC displayed in the index.html page of the WebHelp. I don't even know if it is available but I look for a display that goes deeper than the second level.
The picture below summarizes the situation And my wish is to display the items with question mark in the index.html.
I have searched in the parameters available in the DITA Map WebHelp Responsive Parameters tab but I did not succeed
Is it even possible? And if yes, how can we change the default behavior?
Thank you in advance for your help.
BR,
ML
Scenario: DITA Map WebHelp Responsive
Hello,
Currently generating a WbeHelp for our technical documentation package, I am searching for a parameter to set the level/granularity of the TOC displayed in the index.html page of the WebHelp. I don't even know if it is available but I look for a display that goes deeper than the second level.
The picture below summarizes the situation And my wish is to display the items with question mark in the index.html.
I have searched in the parameters available in the DITA Map WebHelp Responsive Parameters tab but I did not succeed
Is it even possible? And if yes, how can we change the default behavior?
Thank you in advance for your help.
BR,
ML
You do not have the required permissions to view the files attached to this post.
-
chrispitude
- Posts: 922
- Joined: Thu May 02, 2019 2:32 pm
Re: WebHelp TOC Level Definition
Hi ML,
I think your screen capture is from the WebHelp output's home page, right? If so, I think this is meant only to be a summary of the help structure, not a full TOC. I don't know if its depth can be configured.
But once you navigate into one of the actual topics, then you should see a full TOC available, either in the menus or on the left (depending on your WebHelp configuration).
Note that the WebHelp topic TOC defaults to showing only the navigation of the current top-level map heading. If you want the WebHelp TOC to show everything, then set the webhelp.publication.toc.links parameter to all.
- Chris
I think your screen capture is from the WebHelp output's home page, right? If so, I think this is meant only to be a summary of the help structure, not a full TOC. I don't know if its depth can be configured.
But once you navigate into one of the actual topics, then you should see a full TOC available, either in the menus or on the left (depending on your WebHelp configuration).
Note that the WebHelp topic TOC defaults to showing only the navigation of the current top-level map heading. If you want the WebHelp TOC to show everything, then set the webhelp.publication.toc.links parameter to all.
- Chris
-
LASSE_MLE
- Posts: 38
- Joined: Mon Dec 05, 2022 3:24 pm
Re: WebHelp TOC Level Definition
Hi Chris,
Thank you for your quick answer.
Yes, my screenshot was the Webhelp output home page. And I wish to have all the embedded unitary documents on a unique page because our support department used to have that on our previous documentation implementation.
When they reply to a support ticket, they always have this page where they can easilly and quickly collect links to unitary docs.
That's why my idea was to auto-generate and not rebuilt it manually (which was my boss first idea).
I will try with the webhelp.publication.toc.links parameter and keep you posted.
ML
Thank you for your quick answer.
Yes, my screenshot was the Webhelp output home page. And I wish to have all the embedded unitary documents on a unique page because our support department used to have that on our previous documentation implementation.
When they reply to a support ticket, they always have this page where they can easilly and quickly collect links to unitary docs.
That's why my idea was to auto-generate and not rebuilt it manually (which was my boss first idea).
I will try with the webhelp.publication.toc.links parameter and keep you posted.
ML
-
LASSE_MLE
- Posts: 38
- Joined: Mon Dec 05, 2022 3:24 pm
Re: WebHelp TOC Level Definition
Hi Chris,
I've tested the webhelp.publication.toc.links parameter to all and it looks like it was the thing I searched
Our support will get the list of links they want. To the unitary SOP but also even to the topics contained in these SOP!
Thank you for your support (as always!).
BR,
ML
I've tested the webhelp.publication.toc.links parameter to all and it looks like it was the thing I searched
Our support will get the list of links they want. To the unitary SOP but also even to the topics contained in these SOP!
Thank you for your support (as always!).
BR,
ML