Creating a mini-toc for online help

[dav_lan]

Can someone please tell me if it is possible to add a mini-toc to a topic in my online webHelp. I have looked in Madcap help topics and found very little (or maybe can't find it), mostly related to printed output.
The image I have included shows a topic called Block model basic statistics and I have pasted an image of the section (File, Display, View, Statistics) of the TOC I want to include on my page.

I have created a master page with a mini-toc proxy below the topic body proxy.

According to the madcap help notes for online output, the printed output setting should be set to use the master page that has the mini-toc proxy, but I'm not sure.

If it is possible can someone provide me with easy-to-understand "how to" notes.

Thank you.

PS I am using version 5.0.1

[NorthEast]

To get a mini-toc in your online help, then you'll need to include a mini-toc proxy on the master page used by your online target.

One thing I did notice from your screenshot is that the books inside the 'basic statistics' topic don't have any working links yet. Flare will ignore those empty links, so you'll need to have at least one working link there before the mini-toc will appear in that topic.

[DurtyMat]

once you add topics to the books in your toc and add the mini-toc proxy make sure look for the correct heading levels.

from what i remember this is how the mini toc works in online / print docs:

The Mini-TOC proxy pulls topics by using the heading level in Print documentation, this is based on the h1-h6 styles and the location of the document in the TOC in Online documentation.

side note: let me know if that is incorrect

[NorthEast]

The heading styles are only relevant for print output mini-tocs, the online mini-toc uses your TOC structure.

You set the number of levels displayed in the mini-toc by using the mc-toc-depth property (for MadCap|miniTocProxy).

[dav_lan]

To get a mini-toc in your online help, then you'll need to include a mini-toc proxy on the master page used by your online target.

One thing I did notice from your screenshot is that the books inside the 'basic statistics' topic don't have any working links yet. Flare will ignore those empty links, so you'll need to have at least one working link there before the mini-toc will appear in that topic.

I have added the mini-toc proxy to my master page used by the target.

I have added topics for the missing links.
Saved and built the project, but no mini-toc appears in Basic Statistics topic.
Why?
Is there examples in the Madcap help to assist me to set up the default settings in the master page?
Should I be added something in the Basic Statistics topic for the mini-toc to appear?

[NorthEast]

Saved and built the project, but no mini-toc appears in Basic Statistics topic.
Why?

I'm not sure as you've done all the steps that you need to do.

If you preview a book topic, does it show a placeholder for the mini-TOC?
(it will show where the mini-TOC will appear, but doesn't show your actual links - just "Mini-TOC Level 1, Mini-TOC Level 2,.." etc.)

If you've got more than one master page in the project, then I would double-check that the one containing the mini-TOC proxy is definitely being used by the help target (i.e. it's not set to (default) in the target's Advanced tab).

Is there examples in the Madcap help to assist me to set up the default settings in the master page?

The introductory topic about mini-TOCs has an example screen of the master page...
User Interface Elements - How to Use Each One > About the Mini-TOC Proxy

Should I be added something in the Basic Statistics topic for the mini-toc to appear?

If you're adding the mini-TOC in the master page, then you don't need to do anything to the topic itself.

[KevinDAmery]

I may be misremembering, but I think this was one of those features that doesn't work correctly if there are spaces anywhere in the path to the topic files (I know that breadcrumbs don't work if there are spaces - I think this one doesn't either). This means that your file names AND the names of all of the folders in your path can't have spaces.

[NorthEast]

I may be misremembering, but I think this was one of those features that doesn't work correctly if there are spaces anywhere in the path to the topic files (I know that breadcrumbs don't work if there are spaces - I think this one doesn't either). This means that your file names AND the names of all of the folders in your path can't have spaces.

I've had spaces in my project folders and filenames (going back to Flare v2.5), and I've never had any issues like that with the mini-TOC or breadcrumbs.

[dav_lan]

If you preview a book topic, does it show a placeholder for the mini-TOC?
(it will show where the mini-TOC will appear, but doesn't show your actual links - just "Mini-TOC Level 1, Mini-TOC Level 2,.." etc.)

Yes I can see the placeholders in my topic.

If you've got more than one master page in the project, then I would double-check that the one containing the mini-TOC proxy is definitely being used by the help target (i.e. it's not set to (default) in the target's Advanced tab).

We do use more than one master page and I have set the properties to use the correct master page at the basic statistics topic level.

The introductory topic about mini-TOCs has an example screen of the master page...
User Interface Elements - How to Use Each One > About the Mini-TOC Proxy

Judging by the amount of threads there are about mini-tocs perhaps the help needs more information or more examples. Just a suggestion

Cheers