Questions on Duplicated TOC Entries

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

Moderators: Alexander Halser, Tim Green

Questions on Duplicated TOC Entries

Unread postby Olivier Beltrami » Thu Feb 14, 2019 4:59 pm

Hello,

In my help project, I have a chapter with topics and code examples for each of the apx 300 macro functions that are defined. I have used duplicated TOC entries so that each function can be found either in the "Alphabetical List of All Functions" or in one of the 15 sub-groups, such a "String Functions".

• How can I tell in the H&M UI if a TOC is duplicated ?
• When a TOC entry is duplicated, is one of them the "master" ? This is important to me because when the user clicks on previous page or next page, from within the "String Functions" section, for example, suddenly it jumps to a next topic in the "Alphabetical List of All Functions". Is there a way yo force the previous page or next page clicks to browse/remain in the branch where they are visually ?
• If a topic has 2 TOC entries pointing to it, what happens if I delete one of these ?
• What does the Check for Referrers say if I try to delete one of the 2 TOC entries for a given topic ?

Very best regards,

Olivier
Olivier Beltrami
www.qppstudio.net
Worldwide Bank and Public Holidays and Calendar Freeware
User avatar
Olivier Beltrami
 
Posts: 236
Joined: Mon Jul 15, 2002 3:30 pm
Location: Nantes, France

Re: Questions on Duplicated TOC Entries

Unread postby Tim Green » Thu Feb 14, 2019 5:56 pm

Hi Olivier,

Multiple TOC entries are a little tricky. They "work", but there are caveats and limits. The only place where you can really use them with impunity is with the V3 skins from the Premium Pack, where I've done some extensive programming to deal with the normal problems they cause. This is explained here in the PP help:

http://www.it-authoring.com/info/pp3hel ... tries.html

There are two main problems with multiple TOC entries in normal skins: 1) Any external link to the topic file they point to will always highlight the FIRST entry in the TOC pointing to that file (the script searches the TOC from top to bottom and stops at the first hit) and 2) The Previous and Next links in the topic header don't work correctly for them.

Normally, the only way around these two problems is to use snippets and create real, separate topic files for each TOC entry, each with its own unique topic ID. Then the problems above go away. And since you have a snippet for the content of all the files you can still edit them all in one place. See here for instructions for both methods:

https://helpandmanual.com/help/index.ht ... ltiref.htm

Now to your questions:

• How can I tell in the H&M UI if a TOC is duplicated ?

I'm afraid there isn't really a method for identifying them easily. You can generate a project report and check the topic IDs, but you can't sort by topic IDs so it's easy to miss multiple references if you have a large project.

• When a TOC entry is duplicated, is one of them the "master" ?

No, they all have equal status. The only difference is that the one that comes first in the TOC is the one that will get highlighted when you link to the topic file. But that is not because of any status, only because it comes first.

Is there a way yo force the previous page or next page clicks to browse/remain in the branch where they are visually ?

Not with standard skins. This only works in the V3 skins, or if you use the snippet method for creating a separate topic for each duplicate, referenced above.

• If a topic has 2 TOC entries pointing to it, what happens if I delete one of these ?

That is relatively safe. Even if the option for deleting referred files is activated the file won't be deleted if there is still another reference to the topic. I say "relatively", because there is also no indication whether you are deleting the last TOC entry to the topic or not... :?

• What does the Check for Referrers say if I try to delete one of the 2 TOC entries for a given topic ?

Multiple TOC entries aren't covered by Find Referrers. Try it and see: If there are no other links Find Referrers will list zero incoming or outgoing references, no matter how many TOC items point to the topic.
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: 20678
Joined: Mon Jun 24, 2002 9:11 am
Location: Bruehl, Germany

Re: Questions on Duplicated TOC Entries

Unread postby Olivier Beltrami » Thu Feb 14, 2019 6:38 pm

Hi Tim,

Thank you very much.

use snippets and create real, separate topic files for each TOC entry, each with its own unique topic ID


Yes, I had thought of this, and I may yet do this.

I did buy the latest Premium Pack a year ago. But I was reluctant to give-up my tweaked skin and HTML and start anew. The HTML tweaking I have done on my skin is no rocket science but, for me, any foray into HTML is hard work.

Very best regards,

Olivier
Olivier Beltrami
www.qppstudio.net
Worldwide Bank and Public Holidays and Calendar Freeware
User avatar
Olivier Beltrami
 
Posts: 236
Joined: Mon Jul 15, 2002 3:30 pm
Location: Nantes, France


Return to Help & Manual 7 Forum

Who is online

Users browsing this forum: No registered users and 11 guests

cron