MATLAB Programming Fundamentals - MathWorks

(やまだぃちぅ) #1
again, so that MATLAB parses the file. Make sure that the folder you are adding is not
your current folder.

Create helptoc.xml File


The helptoc.xml file defines the hierarchy of help files displayed in the Contents pane
of the Supplemental Software browser.


You can create a helptoc.xml file by using the template included with the MATLAB
documentation. To create and edit a copy of the template file helptoc_template.xml in
your current folder, run this code in the Command Window:


copyfile(fullfile(matlabroot,'help','techdoc','matlab_env',...
'examples','templates','helptoc_template.xml'),pwd)
fileattrib('helptoc_template.xml','+w')
edit('helptoc_template.xml')


Place the helptoc.xml file in the folder that contains your HTML documentation files.
This folder must be referenced as the in your info.xml file.


Each entry in the helptoc.xml file references one of your HTML help files.
The first entry in the helptoc.xml file serves as the initial landing page for
your documentation.


Within the top-level element, the nested elements define the structure
of your table of contents. Each element has a target attribute that provides
the file name. File and path names are case-sensitive.


When you create the helptoc.xml file, make sure that:



  • The location of the helptoc.xml files is listed as the in your
    info.xml file.

  • All file and path names exactly match the names of the files and folders, including
    capitalization.

  • All path names use URL file path separators (/). Windows style file path separators ()
    can cause the table of contents to display incorrectly. For example, if you have an
    HTML help page firstfx.html located in a subfolder called refpages within the
    main documentation folder, the target attribute value for that page
    would be refpages/firstfx.html.


Example helptoc.xml File


Suppose that you have created the following HTML files:


Display Custom Documentation
Free download pdf