Mini-Toc Please can someone explain this

This forum is for all Flare issues related to the HTML5, WebHelp, WebHelp Plus, and Adobe Air Targets

Mini-Toc Please can someone explain this

Postby srnowlin on Tue Apr 22, 2008 3:24 pm

OMG please please can someone explain Mini-TOC proxy to me in plain understandable english? I've taken a class, they never even touched on it, even after I broched the subject and they said they would get back to it. The knowledge base just plain confuses. And the help in the forums are scattered around that it's hard to find them ( yes I may not be searching correctly - but I don't know what to search for!!! ). If I sound frantic and desperate it's because I am.

Here is my dilemma.
I need to provide navigational links within the body of my pages. But they need to be exposed links..not keywords, not related topics but Actual Links related to the TOC that are choose-able from within the body of the page. The Mini-TOC proxy APPEARS to be the perfect solution since I just create a toc with my navigations etc.

I have 4 topics each topic branches into 3 chapters and each chapter may have an additional sub-chapter and a page or two.
Everything is well and good with the initial topic of my help file. The Mini-TOC links everything dynamically as it should. I can rearrange rename and feel confident that the first topic is well represented in the mini-TOC

My frustrations starts when I try adding the other Topics.
It should be like this:
Overview>First Topic> links chapters what not works great! (using the breadcrumb metaphor)

I link to my second topic from the first topic and the breadcrumbs work, but there is no mini-TOC! on the first page of the second, third or fourth topics! The Chapters and pages after have mini-TOCs.

I'm so confused!!!!!
Sandra Nowlin
Techwriter Monkey - not as functional as Bathroom Monkey
New Tech Computer Systems
srnowlin
Propeller Head
 
Posts: 28
Joined: Mon Oct 01, 2007 10:38 am
Location: Louisiana, US

Re: Mini-Toc Please can someone explain this

Postby forfear on Tue Apr 22, 2008 4:31 pm

What is the mini-toc proxy?
From the Flare help system. Search mini-toc
"....the output will display links to TOC entries below the current topic in the TOC hierarchy ....If a mini-TOC proxy is included in a master page, the output will display links to TOC entries below the current topic in the TOC hierarchy (a "mini-TOC"). This feature requires that first you link the TOC book in question to a topic. "

You want to use it when you want to link people that have found a topic in your help system, and what to see related topics in the same 'book' or chapter. Mini-toc automatically inserts the links to other surrounding topics in the same book chapter. PS. if you have many topics in one chapter, the list is going to be unusably long so, organize and trim your topic count in books if you intend to use it. Give the mini-toc a shot and you will know immediately how it works.

Why is it not working?
Lets troubleshoot....
[list=]Open your master page.
Have you added a Mini-TOC proxy to the Master page.
The default 'Master' Master Page template usually has a Breadcrumb Proxy, Body Proxy and a Mini-TOC proxy.

If not,
Insert > Proxy > Insert Mini-TOC Proxy. Click OK.[/list]

PS. You are on the right track.
If you submit your bug feedback request here, the more likely it'll get fixed or included in a future release
Open Utilities PageLayout Resizer for Flare/Blaze | Batch builder
forfear
Propellus Maximus
 
Posts: 766
Joined: Sat Feb 16, 2008 3:37 am
Location: Jungle Jingles

Re: Mini-Toc Please can someone explain this

Postby srnowlin on Wed Apr 23, 2008 5:26 am

Thanks forfear, and I can't convey this without sounding catty so please don't read it that way, but I already knew that.

As far as trouble shooting, Yes it's added to my MasterPage -- I knew enough to do what you suggested - as I have read the KB, read the forums, read the Help file topic from program itself.

So in essence I've been giving the mini-TOC a shot for quite some time, and I know immediately how I think it SHOULD work, but it does not, thus the post. I was hoping I was missing an essential step.

I've attached a screenshot of the TOC I'm using. The first level as I stated, works perfectly every page that is supposed to have a mini-toc display is there. The area in blue also displays the mini-TOC like expected. BUT it's Parent Book does not have the bread crumb..you can not navigate from it to chapters below it.
You do not have the required permissions to view the files attached to this post.
Sandra Nowlin
Techwriter Monkey - not as functional as Bathroom Monkey
New Tech Computer Systems
srnowlin
Propeller Head
 
Posts: 28
Joined: Mon Oct 01, 2007 10:38 am
Location: Louisiana, US

Re: Mini-Toc Please can someone explain this

Postby Richard Ferrell on Wed Apr 23, 2008 6:30 am

So You are not getting the Mini-Toc to Display in your topic Explore the Interface? Is this topic linked anywhwere else in the Table Of Contents? If you are still having issues, I would open a support ticket

https://www.madcapsoftware.com/support/ ... px?p=flare
Richard Ferrell

Certified Madcap Trainer
Image
Richard Ferrell
Propellus Maximus
 
Posts: 837
Joined: Mon May 01, 2006 10:11 am
Location: Inside California

Re: Mini-Toc Please can someone explain this

Postby srnowlin on Wed Apr 23, 2008 6:46 am

That is correct there are no mini-TOC links in the Explore the Interface subject.

Because we are not using the traditional TOC to the left for navigation, there is a link from the first Rx Work Area topic to the Explore the Interface topic. That link is made in the Related Topics control.

I will be sure to submit a ticket on it as soon as I can determine that it's not me being the idiot.
Sandra Nowlin
Techwriter Monkey - not as functional as Bathroom Monkey
New Tech Computer Systems
srnowlin
Propeller Head
 
Posts: 28
Joined: Mon Oct 01, 2007 10:38 am
Location: Louisiana, US

Re: Mini-Toc Please can someone explain this

Postby Richard Ferrell on Wed Apr 23, 2008 7:43 am

Let us know what you find out.
Richard Ferrell

Certified Madcap Trainer
Image
Richard Ferrell
Propellus Maximus
 
Posts: 837
Joined: Mon May 01, 2006 10:11 am
Location: Inside California

Re: Mini-Toc Please can someone explain this

Postby KevinDAmery on Wed Apr 23, 2008 8:09 am

Under "Explore the Interface," are the books for "Related Links" and "Application Toolbar" linked to actual, unique topics? Or are they just used as organizational entities? AFAIK, the Mini-TOC only works if there are actual topics to link to (they won't link to "empty" books).

HTH.
Until next time....
Image
Kevin Amery
Certified MAD for Flare
KevinDAmery
Propellus Maximus
 
Posts: 1985
Joined: Tue Jan 23, 2007 8:18 am
Location: Darn, I knew I was around here somewhere...

Re: Mini-Toc Please can someone explain this

Postby srnowlin on Wed Apr 23, 2008 10:08 am

yes the Explore the Interface is an actual linked Book icon, as with all of the books below it. And all the books below the Explore the Interface contain the mini-TOC only the Explore one does not.

The Explore the Interface Topic is arranged exactly like the Rx Work Area topic above it (which works). So I'm guessing it's a report ticket?
Sandra Nowlin
Techwriter Monkey - not as functional as Bathroom Monkey
New Tech Computer Systems
srnowlin
Propeller Head
 
Posts: 28
Joined: Mon Oct 01, 2007 10:38 am
Location: Louisiana, US

What I have learned.

Postby srnowlin on Wed Apr 23, 2008 12:08 pm

Well I have not posted a Ticket. Because today with a clearer mind I did some more experimenting and started with a clean TOC.
This is what works. Why it works I do not know.

I create an unlinked over topic and name it something pertinent to the Topic Section I'm working with. In this instance I have
    The Interface (unlinked book)
    Overview (unlinked book)
    How do I (linked book to a blank topic page)

This produces the results I need oddly enough, and doesn't look bad if the reader needs to activate the TOC on the left (the icon is available but it's hidden upon initial opening of the help file).
2.png

3.png

4.png
You do not have the required permissions to view the files attached to this post.
Sandra Nowlin
Techwriter Monkey - not as functional as Bathroom Monkey
New Tech Computer Systems
srnowlin
Propeller Head
 
Posts: 28
Joined: Mon Oct 01, 2007 10:38 am
Location: Louisiana, US

Re: Mini-Toc Please can someone explain this

Postby Dave Lee on Mon Apr 28, 2008 1:53 am

If a mini-TOC doesn't appear for an individual topic, the first thing I would check is that the topic isn't linked to the TOC in more than one place.
Dave Lee
Master Propellus Maximus
 
Posts: 5674
Joined: Mon Mar 05, 2007 8:33 am
Location: UK

Re: Mini-Toc Please can someone explain this

Postby srnowlin on Mon Apr 28, 2008 5:26 am

Dave Lee wrote:If a mini-TOC doesn't appear for an individual topic, the first thing I would check is that the topic isn't linked to the TOC in more than one place.

OH believe me I did, that's what had me tearing my hair out :(,

So far it seems to be on track again, but thanks for the reminder :)
Sandra Nowlin
Techwriter Monkey - not as functional as Bathroom Monkey
New Tech Computer Systems
srnowlin
Propeller Head
 
Posts: 28
Joined: Mon Oct 01, 2007 10:38 am
Location: Louisiana, US


Return to Web-based Outputs

Who is online

Users browsing this forum: Google [Bot] and 3 guests