HelpTools[TableOfContents]
Load
add table of contents entries to help database
Calling Sequence
Parameters
Description
Examples
Compatibility
Load(toc, hdb)
toc
-
list of record or record; table of contents entries
hdb
string; path to help database
The Load command adds table of contents entries to help database.
Each entry in table of contents must be based on the following record:
Record('entry', 'priority', 'topic', 'language', 'product', 'category', 'children');
Record⁡entry,priority,topic,language,product,category,children
Attributes of entry record
Attribute
Type
entry
string
text of table of contents entry
priority
positive integer
priority of entry, entries with higher priority are displayed first
topic
help topic that is opened when entry is selected
language
language of entry
product
product of entry
category
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.
with⁡HelpTools:with⁡TableOfContents:
Convert XML to list of records:
xml := "<?xml version=\"1.0\" encoding=\"UTF-8\"?> <toc> <entry priority=\"55\" text=\"What's New\"> <entry priority=\"100\" text=\"Overview\" topic=\"updates,v18\"/> <entry priority=\"50\" text=\"Index of New Commands and Packages\" topic=\"updates,Maple18,index\"/> </entry> </toc>":
toc≔ConvertFromXML⁡xml
toc≔Record⁡entry=What's New,topic=,priority=55,language=en,product=User Help,category=Help Page,children=Record⁡...,Record⁡...
Add table of contents entries:
hdb≔FileTools:-JoinPath⁡maple,toolbox,UserHelp,lib,maple.help,base=homedir
hdb≔C:\Users\jsmith\maple\toolbox\UserHelp\lib\maple.help
Load⁡toc,hdb
The HelpTools[TableOfContents][Load] command was introduced in Maple 18.
For more information on Maple 18 changes, see Updates in Maple 18.
See Also
HelpTools
Download Help Document