DocumentTools

 add an icon file to a Maple help database file

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

 > $\mathrm{with}\left(\mathrm{DocumentTools}\right):$
 > $\mathrm{AddIcon}\left("Task 1 icon",\mathrm{path}="/path/to/icon/file.png"\right)$
 > $\mathrm{AddPaletteEntry}\left("Task_1",\mathrm{palette}="My palette",\mathrm{icon}="Task 1 icon"\right)$

Compatibility

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