tbx_builder_help

Arguments

toolbox_path

Root directory of toolbox sources ; builder_help.sce script will be searched in the help subdirectory of this directory.

Description

tbx_builder_help is used for generating the help of a toolbox.

This macro is usually called from builder.sce scripts when creating a toolbox.

Scans the toolbox_path directory for a help subdirectory. If help is found, looks for a script whose name starts by builder and executes it. If no such script is found, generates the help from all la_LA subdirectories where la_LA is the language and country from ISO 15897.

Exits silently if the help subdirectory is absent.

The toolbox name is retrieved as the basename of the file toolbox_path/etc/*.start. This file must exists, even if it is empty.

Examples

// Recommended usage, from a builder.sce script:
tbx_builder_help(get_absolute_file_path('builder.sce'))

See also

• tbx_builder_help_lang — Run build_help.sce script if it exists (toolbox compilation process)
• tbx_build_help_loader — Generate an addchapter.sce script (toolbox compilation process)
• tbx_build_help — Generate help files (toolbox compilation process)

History