MATLAB Programming Fundamentals - MathWorks

Display Custom Documentation

In this section...

“Overview” on page 30-27

“Create HTML Help Files” on page 30-28

“Create info.xml File” on page 30-29

“Create helptoc.xml File” on page 30-31

“Build a Search Database” on page 30-33

“Address Validation Errors for info.xml Files” on page 30-34

Overview

If you create a toolbox that works with MathWorks products, even if it only contains a few

functions, you can include custom documentation in the form of HTML help files. Custom

documentation for your toolbox can include figures, diagrams, screen captures,

equations, and formatting to make your toolbox help more usable.

To display properly, your custom documentation must contain these files:

• HTML help files — These files contain your custom documentation information.


• info.xml file — This file enables MATLAB to find and identify your HTML help files.


• helptoc.xml file — This file contain the Table of Contents for your documentation
  that displays in the Contents pane of the Help browser. This file must be stored in the
  folder that contains your HTML help files.


• Search database (optional) — These files enable searching in your HTML help files.

To view your custom documentation, open the Help browser and navigate to the home

page. At the bottom right of the home page, under Supplemental Software, click the

name of your toolbox. Your help opens in the current window.

Display Custom Documentation