A mini TOC that only shows pages under that "book"

This forum is for all Flare issues related to the HTML5, WebHelp, WebHelp Plus, and Adobe Air Targets
Post Reply
Eric Lachance
Sr. Propeller Head
Posts: 127
Joined: Thu May 13, 2010 11:51 am
Location: Montreal, Quebec, Canada
Contact:

A mini TOC that only shows pages under that "book"

Post by Eric Lachance »

I'm trying to see if there is a way to create a mini-toc that will automatically (and only) display a list of pages that is one place deeper in the hierarchy, under that page. What I mean is, I create a "New Book" and put a series of topics (which do not always have the same header level) within that book (which can be at different depths) and I want to automatically generate a list of those topics.

The use for this is because I'm updating a scripting language reference manual and there are different sections such as "Functions (by return value data type)", under which there's Integer, Float, String, etc. But as new functions are (and have been) added, it's a bit of a hassle to manage each of those pages individually, so what I did is just added TOC links to the topics in each of the relevant places. I'd like to keep the page that lists them however, instead of relying on the TOC... and if I have to edit that page manually, I defeat the purpose of it.

This project outputs in webhelp only, there are no printed manuals.
Eric Lachance
Technical Trainer
Objectif Lune Inc.
lacastle
Propellus Maximus
Posts: 1028
Joined: Thu Apr 12, 2007 7:28 am
Location: Wilmington, DE
Contact:

Re: A mini TOC that only shows pages under that "book"

Post by lacastle »

You can do this with a mini toc proxy. here is the page in the flare help with more information - http://webhelp.madcapsoftware.com/flare ... _Proxy.htm
Eric Lachance
Sr. Propeller Head
Posts: 127
Joined: Thu May 13, 2010 11:51 am
Location: Montreal, Quebec, Canada
Contact:

Re: A mini TOC that only shows pages under that "book"

Post by Eric Lachance »

Ah, I thought it always referred to the header level and not the toc structure.

As a technical writer, let me take a second to look myself in the mirror and tell my reflection: Dude, RTFM!
Eric Lachance
Technical Trainer
Objectif Lune Inc.
crdmerge
Sr. Propeller Head
Posts: 248
Joined: Tue Dec 16, 2008 5:37 am

Re: A mini TOC that only shows pages under that "book"

Post by crdmerge »

The confusion might be due to the fact that not all HATs implement the "mini-toc" feature in the same manner.

Flare = Automatically lists all topics (pages) under the current "book" topic (no reference to interior headers).

RoboHelp = Automatically lists all headers inside the current topic only (no reference to the TOC).

Who knows what others do? :D


Good luck,
Leon
Eric Lachance
Sr. Propeller Head
Posts: 127
Joined: Thu May 13, 2010 11:51 am
Location: Montreal, Quebec, Canada
Contact:

Re: A mini TOC that only shows pages under that "book"

Post by Eric Lachance »

I have absolutely no excuse in that regards. The only authoring tool I've ever used (and is ever likely to use) is Flare, so whatever MadCap defines as being their standard is also mine. :P
Eric Lachance
Technical Trainer
Objectif Lune Inc.
Post Reply