AddIcon - Maple Help
For the best experience, we recommend viewing online help using Google Chrome or Microsoft Edge.
Our website is currently undergoing maintenance, which may result in occasional errors while browsing. We apologize for any inconvenience this may cause and are working swiftly to restore full functionality. Thank you for your patience.

Online Help

DocumentTools

  

AddIcon

  

add an icon file to a Maple help database file

 

Calling Sequence

Parameters

Description

Examples

Compatibility

Calling Sequence

AddIcon(icon_name, path=source, hdb=target)

Parameters

icon_name

-

string ; the name to use when storing the icon in the HELP file

source

-

string ; the path to the file containing the icon image

target

-

(optional) string ; the path to the Maple help database file in which to store the icon (default: your default tasks.help file)

Description

• 

The AddIcon function stores an icon image into a help database file.  This is a necessary step before an icon can be used in a custom Snippets palette.

• 

Once stored, the icon can be referenced by the name icon_name when associating the icon with a task in a Snippets palette (see DocumentTools[AddPaletteEntry] for details).

• 

If hdb=target is not given, the icon will be stored in your default tasks.help file.

• 

The pathname(s) to the icon image file and/or .help file can be absolute or relative to currentdir.

• 

For information regarding the specification of filename and pathname, see filename and backslash.

Examples

withDocumentTools:

AddIconTask 1 icon,path=/path/to/icon/file.png

AddPaletteEntryTask_1,palette=My palette,icon=Task 1 icon

Compatibility

• 

The DocumentTools[AddIcon] command was introduced in Maple 16.

• 

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

See Also

About Help Databases

Arrange Palettes

backslash

currentdir

DocumentTools

DocumentTools[AddPalette]

DocumentTools[AddPaletteEntry]

filename

 


Download Help Document