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


%helps

global variable: paths to help directories of loaded external modules

Description

The global variable %helps is an N x 2 matrix of strings. Each row refers to the help chapter of a loaded external module:

  • %helps(k,1) is the absolute pathname to its help directory.
  • %helps(k,2) is the title of its help chapter.

This variable must NOT be modified by hand. add_help_chapter must be used to add a new help chapter and update %helps.

Examples

global %helps  // This instruction creates a local %helps variable connected to the global one
%helps
if %helps==[]                    // No help chapter is registered for any external module
    if atomsGetInstalled()==[]   // If no external module is installed
        atomsInstall uman;       //  we install the "uman" one (available for all plateforms)
    end
    atomsLoad(atomsGetInstalled()(1));  // We load the first module, included its help pages
    %helps                       // Now the external chapter should be registered
end

See also

  • add_help_chapter — Add an entry in the help list
  • help — queries and displays help pages in the Scilab help browser
Report an issue
<< manedit utilities xmltohtml >>

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:
Thu Oct 24 11:13:15 CEST 2024