check_help

Arguments

moduleName

Scalar string or [] (default value). Name of a Scilab module to inspect, the full path to a single XML help file or the path of a directory congtaining help files. With [], all Scilab modules are checked.

localeName

Scalar string. Locale of the help files to validate, for example "en_US" or "fr_FR". The default value is current Scilab language returned by getlanguage().

xUnitFile

Scalar string or [] (default value). Full path of the XML file where to export the validation results in xUnit (JUnit XML) format. If not provided or empty, no xUnit report is generated.

status

Scalar boolean. %T if no error has been detected. %F if any error has been detected.

Description

check_help validates Scilab XML help files with the Relax NG schema stored in SCI/modules/helptools/schema/scilab.rng.

With no input argument, all modules are scanned for the current language. With one input argument, moduleName can be either a module name or a single XML file path. With two input arguments, the function checks the help tree of one module, or of all modules when moduleName is [], for the locale given by localeName.

Examples

// Validate all help files for the current locale
check_help()

// Validate all english help files of the helptools module
check_help("helptools", "en_US")

// Validate all french help files of all modules
check_help([], "fr_FR")

// Validate a single help page
xmlFile = SCI + "/modules/helptools/help/en_US/utilities/xmltohtml.xml";
check_help(xmlFile)

See also

• doc — queries and displays help pages in the Scilab help browser
• help — Displays an inline summary of a documentation page

History