Scilab Website | Contribute with GitLab | Mailing list archives | ATOMS toolboxes
Scilab Online Help
2024.1.0 - English


tbx_builder_help

Builds the multilingual help pages of a toolbox, with possible subsections

Syntax

tbx_builder_help(toolbox_path)
tbx_builder_help(toolbox_path, languages)

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 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".

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.

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(…) 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.

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
  • xmltojar — converts xml Scilab help files to javaHelp 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 — Generate help files (toolbox compilation process)

History

VersionDescription
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.

6.1.2 languages input option added.
Report an issue
<< tbx_builder_gateway Sections builders tbx_builder_macros >>

Copyright (c) 2022-2024 (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 Jun 17 17:49:22 CEST 2024