Thread Subject: Help Browser Table of Contents

Subject: Help Browser Table of Contents

From: Jeffrey

Date: 5 Nov, 2009 22:52:01

Message: 1 of 3

I'm working on creating some help documentation for a custom toolbox in 2009a. I've been able to figure out how to use the info.xml and helptoc.xml to have my help pages show up in the browser, but I'm not seeing any interaction from my page links and the table of contents (the other way works fine).

For example, in a typical Matlab help file, if I click a link to another page, the table of contents is updated on the left, highlighting the new page. This does not happen for my custom documentation.

I've been trying to figure out the missing link (which is clearly undocumented), but I haven't had much luck. Has anyone else been able to solve this?

P.S. On a semi-related undocumented note, I found a way to bring up the product page, although this too does not update the table of contents:

"doc help_files_dir_name" and you need a file named "help_files_dir_name_product_page.html" in that folder.

Thanks!

Subject: Help Browser Table of Contents

From: jonny

Date: 6 Nov, 2009 00:46:10

Message: 2 of 3

On Nov 5, 5:52 pm, "Jeffrey " <jeffshad...@yahoo.com> wrote:
> I'm working on creating some help documentation for a custom toolbox in 2009a. I've been able to figure out how to use the info.xml and helptoc.xml to have my help pages show up in the browser, but I'm not seeing any interaction from my page links and the table of contents (the other way works fine).
>
> For example, in a typical Matlab help file, if I click a link to another page, the table of contents is updated on the left, highlighting the new page. This does not happen for my custom documentation.
>
> I've been trying to figure out the missing link (which is clearly undocumented), but I haven't had much luck. Has anyone else been able to solve this?
>
> P.S. On a semi-related undocumented note, I found a way to bring up the product page, although this too does not update the table of contents:
>
> "doc help_files_dir_name" and you need a file named "help_files_dir_name_product_page.html" in that folder.
>
> Thanks!

I had the same problem. Links from custom help files do not update the
navigation window focus. I use R2009b. This is their reply:
"I am writing regarding your question about 'Custom Toolbox Help
files'. Unfortunately, the ability to synchronise the Contents tab of
the Help Browser, with your custom help files is currently not
available in MATAB. The development team is considering this feature
for a future release. I apologize if this is hindering your work. If
you have any further questions please don't hesitate to email me.
Please be sure to preserve the THREAD ID listed below when replying to
this email."

so, there you have it.

Subject: Help Browser Table of Contents

From: Jeffrey

Date: 11 Nov, 2009 15:49:04

Message: 3 of 3

jonny <jonnazemi@gmail.com> wrote in message <ceb427e5-62ee-4ba9-9bb6-31bfa212ed59@k4g2000yqb.googlegroups.com>...
> On Nov 5, 5:52?pm, "Jeffrey " <jeffshad...@yahoo.com> wrote:
> > I'm working on creating some help documentation for a custom toolbox in 2009a. I've been able to figure out how to use the info.xml and helptoc.xml to have my help pages show up in the browser, but I'm not seeing any interaction from my page links and the table of contents (the other way works fine).
> >
> > For example, in a typical Matlab help file, if I click a link to another page, the table of contents is updated on the left, highlighting the new page. This does not happen for my custom documentation.
> >
> > I've been trying to figure out the missing link (which is clearly undocumented), but I haven't had much luck. Has anyone else been able to solve this?
> >
> > P.S. On a semi-related undocumented note, I found a way to bring up the product page, although this too does not update the table of contents:
> >
> > "doc help_files_dir_name" and you need a file named "help_files_dir_name_product_page.html" in that folder.
> >
> > Thanks!
>
> I had the same problem. Links from custom help files do not update the
> navigation window focus. I use R2009b. This is their reply:
> "I am writing regarding your question about 'Custom Toolbox Help
> files'. Unfortunately, the ability to synchronise the Contents tab of
> the Help Browser, with your custom help files is currently not
> available in MATAB. The development team is considering this feature
> for a future release. I apologize if this is hindering your work. If
> you have any further questions please don't hesitate to email me.
> Please be sure to preserve the THREAD ID listed below when replying to
> this email."
>
> so, there you have it.

Yeah that's ridiculous. I'll have to keep looking for an undocumented approach. The help browser is just another Java widget...

Tags for this Thread

Everyone's Tags:

Add a New Tag:

Separated by commas
Ex.: root locus, bode

What are tags?

A tag is like a keyword or category label associated with each thread. Tags make it easier for you to find threads of interest.

Anyone can tag a thread. Tags are public and visible to everyone.

Tag Activity for This Thread
Tag Applied By Date/Time
undocumented Jeffrey 5 Nov, 2009 17:54:03
toc Jeffrey 5 Nov, 2009 17:54:03
table of contents Jeffrey 5 Nov, 2009 17:54:03
custom Jeffrey 5 Nov, 2009 17:54:03
documentation Jeffrey 5 Nov, 2009 17:54:03
rssFeed for this Thread

Contact us at files@mathworks.com