MATLAB Answers

Toolbox helptoc.xml with folder structure

14 views (last 30 days)
Johannes Milvich
Johannes Milvich on 6 May 2015
Answered: Tricia on 11 Jun 2015
Hello,
Matlab allows to create custom help html files as shown in http://de.mathworks.com/help/matlab/matlab_prog/display-custom-documentation.html.
When you create your info.xml file in your main folder, you specify the path where the HTML help files lie. I created a script which automatically creates a helptoc.xml file in that \html\ folder, which uses the folder hierarchy of html help files to create a nested tocitem table.
<?xml version='1.0' encoding="utf-8"?>
<toc version="2.0">
<tocitem target="\HelpFiles\Contents.html"> HelpFiles
<tocitem target="\HelpFiles\Contents.html"> Contents
<\tocitem>
<tocitem target="\HelpFiles\Design\Contents.html"> Design
<tocitem target="\HelpFiles\Design\ClassDefs\Contents.html"> ClassDefs
<tocitem target="\HelpFiles\Design\ClassDefs\TestClass.html"> TST
<\tocitem>
If I press F1, however, the tocitems are not shown in the help browser.
My questions are:
Do all html files have to be directly in the html folder? Is there a way to create an automated hierarchy based on a folder structure?
Best regards,
Johannes

  0 Comments

Sign in to comment.

Answers (1)

Tricia
Tricia on 11 Jun 2015
Hi Johannes, Yes. Your html files should be located in your html folder, or a child folder in your html folder. The F1 command is supported for functions. Be sure that you are using F1 for a function that is on the matlab path and that has matlab file help.

  0 Comments

Sign in to comment.

Community Treasure Hunt

Find the treasures in MATLAB Central and discover how the community can help you!

Start Hunting!

Translated by