Create documentation index files
docindex(d) creates documentation index files info.xml and helptoc.xml and search database helpsearch_v4 in the folder d.
[xml,db] = docindex(...) returns the names of the index files xml and search database folder db created.
| Name | Description | Type | Required |
|---|---|---|---|
d➡️ |
documentation folder, as an absolute or relative path | string | yes |
➡️xml |
index files created, as an absolute path | strings | |
➡️db |
search database folder created, as an absolute path | string |
docindex("mickey/goofy") indexes documentation in the folder mickey/goofy. Note that this path is relative.
docindex("C:\daisy\mickey\goofy") also indexes documentation, this time specified using an absolute path.
info.xml enables MATLAB to find and identify your HTML help files. helptoc.xml contains the table of contents for your documentation that is displayed in the Contents sidebar of the Help browser. The MATLAB documentation contains further details, that you do not need to know about anymore once you are generating rather than hand-writing these files.
helptoc.md should contain:
- a level-1 heading
# Headingwith the name of the toolbox - a nested list of links
* [text](ref.md)to your Markdown documents
For example:
# Ducks Toolbox
* [Getting started](index.md)
* [Huey](huey.md)
* [Louie](louie.md)
* [Dewey](dewey.md)If you need a list item to group child items, specify an empty link URL, e.g. * [Function reference](). Other content in helptoc.md -- including additional links and normal text in list items -- is ignored.
The indexing consists of 4 steps:
- Read
helptoc.mdin the specified folder - Create
info.xmlin the specified folder with<name>content set to the first level-1 heading# Heading
- Create
helptoc.xmlin the specified folder with- nested
<tocitem>s for each list item* [text](ref.md) <tocitem>attributetargetset to the list item link reference, with.mdlinks replaced by.htmlequivalents<tocitem>content set to the list item link text
- nested
- Run
builddocsearchdbin the specified folder to build the documentation search database.
home 🏠 | convert ➡️ | run 🏃 | index 📜 | delete ♻️ | workspace 👷 | about 🐣 | ©️ MathWorks 2024-2026