Skip to content

Latest commit

 

History

History
68 lines (47 loc) · 2.88 KB

docindex.md

File metadata and controls

68 lines (47 loc) · 2.88 KB

docindex 📜

Create documentation index files

Syntax

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

Examples

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.

Details

info.xml and helptoc.xml

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.

Table of contents requirements

helptoc.md should contain:

  • a level-1 heading # Heading with 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.

Steps

The indexing consists of 4 steps:

  1. Read helptoc.md in the specified folder
  2. Create info.xml in the specified folder with
    • <name> content set to the first level-1 heading # Heading
  3. Create helptoc.xml in the specified folder with
    • nested <tocitem>s for each list item * [text](ref.md)
    • <tocitem> attribute target set to the list item link reference, with .md links replaced by .html equivalents
    • <tocitem> content set to the list item link text
  4. Run builddocsearchdb in the specified folder to build the documentation search database.

home 🏠 | convert ➡️ | run 🏃 | index 📜 | delete ♻️ | workspace 👷 | about 🐣 | ©️ MathWorks 2024-2026