Display of topics in webhelp

Please post all questions and comments regarding Help & Manual 7 here.

Moderators: Alexander Halser, Tim Green

Display of topics in webhelp

Unread postby Tansy » Thu Apr 04, 2019 12:23 pm

I have a topic named TopicA and a TOC link to the topic named B. They are assigned to different builds and have different headers (and the same content). This works fine for PDF output - for Build A, I have the header TopicA, and for build B the header is TopicB. But that doesn't work for webhelp output as only one of the headers is used, irrespective of the build. How do I make different headers of the same chapter for two different builds in webhelp output?
Tansy
 
Posts: 60
Joined: Wed Aug 25, 2010 11:37 am

Re: Display of topics in webhelp

Unread postby Tim Green » Thu Apr 04, 2019 4:27 pm

Hi Tansy,

How do I make different headers of the same chapter for two different builds in webhelp output?

I'm not 100% sure I understand how you are doing this from your description. However, there are two key things you need to know here:

1) Just excluding the chapter heading with a build option doesn't work on the chapters sub-topics in WebHelp. You need to apply build options explicitly to all the topics, both the chapter and its sub-topics.

2) The TOC entries and the topic files they point to can have separate build options. By default, applying a build option to a TOC entry also applies it to the topic file. However, if you then go down into Project Files > Topic Files you can apply different build options to the topic files.

So basically, you need to make sure that all the TOC entries and topic files you want to include/exclude have the build options you want. Then it should also work in WebHelp.
Regards,
Tim (EC Software Documentation & User Support)

Private support:
Please do not email or PM me with private support requests -- post to the forum directly.
User avatar
Tim Green
Site Admin
 
Posts: 20619
Joined: Mon Jun 24, 2002 9:11 am
Location: Bruehl, Germany

Re: Display of topics in webhelp

Unread postby Tansy » Mon Apr 08, 2019 2:53 pm

Still it doesn't seem to work.

1) Just excluding the chapter heading with a build option doesn't work on the chapters sub-topics in WebHelp. You need to apply build options explicitly to all the topics, both the chapter and its sub-topics.


I know this and I make sure that all build options are applied explicitly to all the topics.

2) The TOC entries and the topic files they point to can have separate build options. By default, applying a build option to a TOC entry also applies it to the topic file. However, if you then go down into Project Files > Topic Files you can apply different build options to the topic files.


I don't get it. The entry in the table of contents (the panel with links to chapters) appears correctly in each build, A for Build A and B for Build B. But I need to have different chapter headers (the ones that appear in the right, befor the chapter text). I tried to illustrate the issue in the screenshot below (sorry I had to paint over the real topics but hopefully it is illustrative enough)

2019-04-08_16-46-33.png
You do not have the required permissions to view the files attached to this post. This may mean that you can't view them at all, or it may just mean that you need to log into the forum to view them.
Tansy
 
Posts: 60
Joined: Wed Aug 25, 2010 11:37 am

Re: Display of topics in webhelp

Unread postby Tim Green » Mon Apr 08, 2019 5:11 pm

Hi Tansy,

But I need to have different chapter headers (the ones that appear in the right, befor the chapter text).

That doesn't work, because you are linking to exactly the same topic file in each case. The TOC is just a list of links and both links are pointing to the same file, and the topic header is part of the file.

However, there is actually a better way of handling this: Delete the second reference to the topic and create a new empty topic. Then use the snippet tool in the project tab to insert the other topic as a linked snippet, so that the snippet is the only content of that new topic (From Topic / Snippet is Linked / Starts a New Paragraph).

Then the second topic is really a topic in its own right and you can edit its header to be different. However, there is still just one topic with the content (the first one) since the snippet is linked, so you still only edit the topic content in the same place.

This has the added advantage that you can also insert additional content above and below the snippet, if necessary. 8)
Regards,
Tim (EC Software Documentation & User Support)

Private support:
Please do not email or PM me with private support requests -- post to the forum directly.
User avatar
Tim Green
Site Admin
 
Posts: 20619
Joined: Mon Jun 24, 2002 9:11 am
Location: Bruehl, Germany

Re: Display of topics in webhelp

Unread postby Tansy » Tue Apr 09, 2019 8:39 am

Thank you Tim, will try that!
Tansy
 
Posts: 60
Joined: Wed Aug 25, 2010 11:37 am


Return to Help & Manual 7 Forum

Who is online

Users browsing this forum: No registered users and 2 guests

cron