Add an entry in the help list (original) (raw)

Scilab 5.3.3

• Scilab help
• Online help management
• add_help_chapter
• apropos
• del_help_chapter
• help
• help_from_sci
• help_skeleton
• Link toolbox help with Scilab one
• man
• manedit
• %helps
• xmltochm
• xmltohtml
• xmltojar
• xmltopdf
• xmltops

Please note that the recommended version of Scilab is 2026.0.1. This page might be outdated.
See the recommended documentation of this function

Scilab help >> Online help management > add_help_chapter

add_help_chapter

Add an entry in the help list

Calling Sequence

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.

Authors

Serge Steer , INRIA