HelpTools[TableOfContents] - Maple Programming Help

Online Help

All Products    Maple    MapleSim


Home : Support : Online Help : System : HelpTools : TableOfContents : HelpTools/TableOfContents/Load

HelpTools[TableOfContents]

  

Load

  

add table of contents entries to help database

 

Calling Sequence

Parameters

Description

Examples

Compatibility

Calling Sequence

Load(toc, hdb)

Parameters

toc

-

list of record or record; table of contents entries

hdb

-

string; path to help database

Description

• 

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');

Recordentry,priority,topic,language,product,category,children

(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

withHelpTools:withTableOfContents:

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>":

tocConvertFromXMLxml

tocRecordentry=What's New&comma;topic=&comma;priority=55&comma;language=en&comma;product=User Help&comma;category=Help Page&comma;children=Record...&comma;Record...

(2)

Add table of contents entries:

hdbFileTools:-JoinPathmaple&comma;toolbox&comma;UserHelp&comma;lib&comma;maple.help&comma;base=homedir

hdbC:\Users\jsmith\maple\toolbox\UserHelp\lib\maple.help

(3)

Loadtoc&comma;hdb

Compatibility

• 

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

HelpTools[TableOfContents]