HelpTools[TableOfContents] - Maple Programming Help

Online Help

All Products    Maple    MapleSim


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

HelpTools[TableOfContents]

  

ConvertFromXML

  

convert table of contents from XML

 

Calling Sequence

Parameters

Description

Examples

Compatibility

Calling Sequence

ConvertFromXML(path, language=language code, product=product name, category=category name)

Parameters

path

-

string; path to a XML file or XML

language

-

optional, string; ISO 639-1 language code, default is "en"

language

-

optional, string; product name, default is "User Help"

category

-

optional, string; category name, default is "Help Page"

Description

• 

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

Description

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

none

help topic that is opened when entry is selected

language

string

value of language parameter

language of entry

product

string

value of product parameter

product of entry

category

string

value of category parameter

category of entry

Examples

withHelpTools&colon;withTableOfContents&colon;

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&comma;topic=&comma;priority=55&comma;language=en&comma;product=User Help&comma;category=Help Page&comma;children=Record...&comma;Record...

(1)

Compatibility

• 

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

HelpTools[TableOfContents]