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.

languages

Vector of strings like "en_US", specifying a subset of the languages of the help. The images of all the languages being generated at once, the help is built as soon as one of the selected languages exists. The shortcuts "en", "fr", "pt", "ja", "ru" can be used. They are automatically expanded into "en_US", "fr_FR", "pt_BR", "ja_JP", "ru_RU".

Description

tbx_builder_help is used for building the help of a toolbox. The help browser renders the DocBook XML pages of the toolbox directly from its help/la_LA directories: building the help consists in pre-generating the images these pages display, as described in tbx_build_help.

This macro is usually called from builder.sce scripts when creating a toolbox, once the libraries of the toolbox are built: the images of the examples are generated with the toolbox loaded.

It scans the toolbox_path directory for a help subdirectory. If ~/help is found, tbx_builder_help(…) looks for a script whose name starts by builder.

• If a file ~/help/builder* is found, tbx_builder_help(…) executes it, and then returns. In this case, the languages option is ignored.

• Otherwise: tbx_builder_help(…) calls tbx_build_help once on the ~/help directory, which pre-generates the images of the pages of all its la_LA subdirectories, where la_LA specifies the language and country according to ISO 15897. If the languages option is used and none of the selected languages exists, nothing is done.

If the ~/help directory is missing, tbx_builder_help(…) exits silently.

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

• man — on line help XML file description format
• 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 — Pre-generates the images of the help pages of a toolbox (toolbox compilation process)

History