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


add_help_chapter

Add an entry in the help list

Syntax

ok = add_help_chapter(title,path[,mode])

Arguments

title

String array, Help chapter title

path

String array, Help chapters path

mode

A boolean, if TRUE, the chapter is considered as belongs to a internal modules, otherwise, the chapter is added as external module. It is an optional input argument and its default value is %F.

ok

A vector of booleans. The same size as the path variable. If the chapter page number i was not existing in the help system then ok(i) is set to %t.

Description

This function adds a new entry in the help list. If the path is already present in the help list, add_help_chapter skips the add. The function checks if the directory exist.

See also

  • help — queries and displays help pages in the Scilab help browser
  • del_help_chapter — Delete an entry in the help list
Report an issue
<< utilities utilities del_help_chapter >>

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