HelpTools[TableOfContents]
ConvertFromXML
convert table of contents from XML
Calling Sequence
Parameters
Description
Examples
Compatibility
ConvertFromXML(path, language=language code, product=product name, category=category name)
path
-
string; path to a XML file or XML
language
optional, string; ISO 639-1 language code, default is "en"
optional, string; product name, default is "User Help"
category
optional, string; category name, default is "Help Page"
The ConvertFromXML command converts table of contents entries from XML format to a nested list of records, so that they can be stored in help database.
Encoding of XML file or XML string must be UTF-8.
An example of XML format:
<?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>
Attributes of entry element
Attribute
Type
Default Value
text
string, required
none
text of table of contents entry
priority
positive integer
0
priority of entry, entries with higher priority are displayed first
topic
string
help topic that is opened when entry is selected
value of language parameter
language of entry
product
value of product parameter
product of entry
value of category parameter
category of entry
withHelpTools:withTableOfContents:
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>":
ConvertFromXMLxml
Recordentry=What's New,topic=,priority=55,language=en,product=User Help,category=Help Page,children=Record...,Record...
The HelpTools[TableOfContents][ConvertFromXML] command was introduced in Maple 18.
For more information on Maple 18 changes, see Updates in Maple 18.
See Also
HelpTools
Download Help Document
