HelpTools[TableOfContents]

Parameters

 toc - list of record or record; table of contents entries hdb - string; path to help database

Description

 > Record('entry', 'priority', 'topic', 'language', 'product', 'category', 'children');
 ${\mathrm{Record}}{}\left({\mathrm{entry}}{,}{\mathrm{priority}}{,}{\mathrm{topic}}{,}{\mathrm{language}}{,}{\mathrm{product}}{,}{\mathrm{category}}{,}{\mathrm{children}}\right)$ (1)
 • Attributes of entry record

 Attribute Type Description entry string text of table of contents entry priority positive integer priority of entry, entries with higher priority are displayed first topic string help topic that is opened when entry is selected language string language of entry product string product of entry category string category of entry children list of records or NULL child entries

 • It is an error for entry to have children entries if it has topic.
 • Errors, if there were any, are returned in an array.

Examples

 > $\mathrm{with}\left(\mathrm{HelpTools}\right):$$\mathrm{with}\left(\mathrm{TableOfContents}\right):$

Convert XML to list of records:

 > xml := "                 ":
 > $\mathrm{toc}≔\mathrm{ConvertFromXML}\left(\mathrm{xml}\right)$
 ${\mathrm{toc}}{≔}\left[{\mathrm{Record}}{}\left({\mathrm{entry}}{=}{"What\text{'}s New"}{,}{\mathrm{topic}}{=}\left(\right){,}{\mathrm{priority}}{=}{55}{,}{\mathrm{language}}{=}{"en"}{,}{\mathrm{product}}{=}{"User Help"}{,}{\mathrm{category}}{=}{"Help Page"}{,}{\mathrm{children}}{=}\left[{\mathrm{Record}}{}\left({\mathrm{...}}\right){,}{\mathrm{Record}}{}\left({\mathrm{...}}\right)\right]\right)\right]$ (2)

 > $\mathrm{hdb}≔\mathrm{FileTools}:-\mathrm{JoinPath}\left(\left["maple","toolbox","UserHelp","lib","maple.help"\right],\mathrm{base}=\mathrm{homedir}\right)$
 ${\mathrm{hdb}}{≔}{"C:\Users\jsmith\maple\toolbox\UserHelp\lib\maple.help"}$ (3)
 > $\mathrm{Load}\left(\mathrm{toc},\mathrm{hdb}\right)$

Compatibility

 • The HelpTools[TableOfContents][Load] command was introduced in Maple 18.