Scilab Website | Contribute with GitLab | Mailing list archives | ATOMS toolboxes


tbx_builder_help

Build help pages of a toolbox, with possible subsections (toolbox compilation process)

Syntax

tbx_builder_help(toolbox_path)

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

History

バージョン記述
6.0.0

No longer restricts the build scripts to builder_help.sce. Now any scripts called builder*.sce or builder*.sce is valid for help generation.

No longer requires a builder script, the default behaviour generates the help from all la_LA subdirectory inside the help directory.

Report an issue
<< tbx_builder_gateway Sections builders tbx_builder_macros >>

Copyright (c) 2022-2023 (Dassault Systèmes)
Copyright (c) 2017-2022 (ESI Group)
Copyright (c) 2011-2017 (Scilab Enterprises)
Copyright (c) 1989-2012 (INRIA)
Copyright (c) 1989-2007 (ENPC)
with contributors
Last updated:
Mon Nov 07 15:06:11 CET 2022