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


tbx_build_help

Generate help files (toolbox compilation process)

Syntax

tbx_build_help(title)
tbx_build_help(title, help_path)

Arguments

title

Title of the chapter.

help_path

Directory where the files will be generated ; in a normal toolbox it should be the directory containing the build_help.sce script (which should be the script calling this function). Default is current directory.

Remark:

If you call tbx_build_help in scilab CLI (=NWNI) mode, help files will not be generated.

Examples

// Recommended usage
tbx_build_help("Toolbox Example", get_absolute_file_path('build_help.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_builder_help — Build help pages of a toolbox, with possible subsections (toolbox compilation process)
Report an issue
<< tbx_build_gateway_loader Helper functions tbx_build_help_loader >>

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