Online Help

Existing .hdb file

hdb_database := Maplets:-Examples:-GetFile('title' = "Help Database", 'filefilter'="hdb");

New .help database

help_database := cat(hdb_database[1..-4], "help");

Language

help_language := "en";

Product

help_product := "User Help";

Category

help_category := "Help Page";

Temporary directory into which the contents from .hdb file will be saved

temp_dir := StringTools:-Join([FileTools:-TemporaryDirectory(), "helpmigration", FileTools:-Basename(hdb_database)], kernelopts('dirsep'));

Create temporary directory if it does not exist

if not FileTools:-Exists(temp_dir) then FileTools:-MakeDirectory(temp_dir, 'recurse'=true); end if;

Create new help database, if it does not exist

if not FileTools:-Exists(help_database) then help_database := HelpTools:-Database:-Create(help_database); end if;

The ExtractContentsFromHDB command returns a table with three entries, "help pages", table of contents", and "task icons".

contents := HelpTools:-Database:-ExtractContentsFromHDB(temp_dir, hdb_database):

Here you can examine and adjust the value of the contents variable.

List of all worksheets extracted from .hdb file:

indices(contents["help pages"], 'nolist');

HelpTools:-Worksheet:-Store(contents["help pages"], help_database, 'language' = help_language, 'product' = help_product, 'category' = help_category);

for toc in HelpTools:-TableOfContents:-ConvertFromXML(contents["table of contents"]) do
HelpTools:-TableOfContents:-Load(toc, help_database);
end do:

for icon_file in indices(contents["task icons"], 'nolist') do
DocumentTools:-AddIcon(contents["task icons"][icon_file], 'path' = icon_file, 'hdb' = help_database);
end do:

HelpTools:-Database:-Add(help_database):