HelpTools[Worksheet] - Maple Programming Help

Online Help

All Products    Maple    MapleSim


Home : Support : Online Help : System : HelpTools : Worksheet : HelpTools/Worksheet/Store

HelpTools[Worksheet]

  

Store

  

store worksheets in help database

 

Calling Sequence

Parameters

Description

Examples

Compatibility

Calling Sequence

Store(worksheets, library, language=language code, product=product name, category=category name, preview=preview of worksheet)

Parameters

worksheets

-

table; information about worksheets

library

-

string; path to help database

language

-

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

product

-

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

category

-

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

preview

-

(optional) string; preview of help page, default is "" (automatically generate)

Description

• 

The Store command saves all worksheets in the specified help database.

• 

The worksheets parameter is a table with path to the worksheet as the key and table of help properties (language, product, category) as the value. Typically it is the output from the Find command.

• 

If preview option is "" then preview for worksheet is generated using the GeneratePreview command.

Examples

withHelpTools:withWorksheet:withDatabase:

dirFileTools:-JoinPatheBookTools,base=datadir

hdbFileTools:-JoinPathmaple,toolbox,UserHelp,lib,MyHelpDatabase.help,base=homedir

wksFinddir

Storewks,hdb

Compatibility

• 

The HelpTools[Worksheet][Store] command was introduced in Maple 18.

• 

For more information on Maple 18 changes, see Updates in Maple 18.

See Also

eBookTools[CreateMW]

HelpTools[Worksheet][Find]

HelpTools[Worksheet][GeneratePreview]