Builds the multilingual help pages of a toolbox, with possible subsections
tbx_builder_help(toolbox_path) tbx_builder_help(toolbox_path, languages)
"en_US"
, specifying the subset of the
languages for which help pages must be built.
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"
.
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.
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
.
~/help/builder*
is found,
tbx_builder_help(…)
executes it, and then returns.
In this case, the languages
option is ignored.tbx_builder_help(…)
generates the help pages
from all la_LA
subdirectories, where la_LA
specifies the language and country according to ISO 15897.
If the languages
option is used, pages are generated only
for existing and selected languages.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. |
// Recommended usage, from a builder.sce script: tbx_builder_help(get_absolute_file_path('builder.sce'))
Version | Description |
6.0.0 | No longer restricts the build scripts to No longer requires a builder script, the default behaviour generates the help
from all |
6.1.2 | languages input option added. |