Including H2s in the Table of Contents

This forum is for all Flare issues related to the Microsoft HTML Help target.
This target produces "CHM" files in the output.
Post Reply
Gary Niemen
Sr. Propeller Head
Posts: 222
Joined: Fri Sep 12, 2008 1:57 am

Including H2s in the Table of Contents

Post by Gary Niemen »

For one of our products, we publish the release information in a .chm.
Each new release gets a topic. Each topic has about 30 H2s.
At the moment, the Table of Contents just lists the topics.
What I would like to do is list the topics and underneath each topic, its H2s.
Can anyone advise me? What would be the quickest/easiest way to set this up.
wclass
Propellus Maximus
Posts: 1238
Joined: Mon Feb 27, 2006 5:56 am
Location: Melbourne, Australia

Re: Including H2s in the Table of Contents

Post by wclass »

On the TOC entry properties page, there is an option to auto-generate parts of the TOC - you set how many levels you want. I have tried this out during testing and it works, but I have never used it for real, so I can't say how good the results are. Worth a try.

The slow way would be to create a TOC entry for each heading you want, and link to the right heading. I can't see anyway to drag and drop the headings, and it would have to be maintained manually.
Margaret Hassall - Melbourne
Gary Niemen
Sr. Propeller Head
Posts: 222
Joined: Fri Sep 12, 2008 1:57 am

Re: Including H2s in the Table of Contents

Post by Gary Niemen »

Yippee - suggestion number 1 worked very well indeed.

Here's the TOC Properties window:
TOC_properties.png
You do not have the required permissions to view the files attached to this post.
Gary Niemen
Sr. Propeller Head
Posts: 222
Joined: Fri Sep 12, 2008 1:57 am

Re: Including H2s in the Table of Contents

Post by Gary Niemen »

I have just noticed that some of the automatically generated links do not work. In other words, all of my H2s become sub-headings in the TOC - but only some of the links actually work. Out of, say, 20, 15 work (you click them and they go to the H2) whereas the other 5 don't work (you click them and they don't go anywhere). Any clues where I might look to investigate this.
Gary Niemen
Sr. Propeller Head
Posts: 222
Joined: Fri Sep 12, 2008 1:57 am

Re: Including H2s in the Table of Contents

Post by Gary Niemen »

Solved it. Avoid using the colon (:) in headings.
tscott
Jr. Propeller Head
Posts: 2
Joined: Tue Oct 01, 2013 8:03 am

Re: Including H2s in the Table of Contents

Post by tscott »

So, 4 years later I've just run into this problem (and this post).

Topic names with colons in them result in bad links when sent to HTML5 output, in Flare V9.
The workaround is still to avoid colons in the names.

I'll submit this bug (?) to MadCap support.
LTinker68
Master Propellus Maximus
Posts: 7247
Joined: Thu Feb 16, 2006 9:38 pm

Re: Including H2s in the Table of Contents

Post by LTinker68 »

tscott wrote:I'll submit this bug (?) to MadCap support.
Colons are a reserved character in URLs; they're usually used to denote that a port number follows the colon. I'm kind of surprised Flare didn't remove that character altogether or give you a warning about it when you tried to create the topic. You also shouldn't use ampersands (&) because they're used to append parameters to URLs. Basically, you should avoid all special characters in file names except underscores. I'd even avoid spaces, although that is a valid character in a URL, but it can sometimes get translated to the character equivalent of a space, which can screw up links and such.
Image

Lisa
Eagles may soar, but weasels aren't sucked into jet engines.
Warning! Loose nut behind the keyboard.
Post Reply