<< helptbx_getpath helptbx helptbx_iscontentupdte >>
helptbx >> helptbx > helptbx_helpupdate

helptbx_helpupdate

Update the help and the demos from the .sci files.

Calling Sequence

helptbx_helpupdate ( funarray , helpdir , macrosdir )
helptbx_helpupdate ( funarray , helpdir , macrosdir , demosdir , modulename )
helptbx_helpupdate ( funarray , helpdir , macrosdir , demosdir , modulename , verbose )

Parameters

funarray :

a m-by-1 matrix of strings, the list of functions to update

helpdir :

a 1-by-1 matrix of strings, the help directory

macrosdir :

a 1-by-1 matrix of strings, the macros directory

demosdir :

a 1-by-1 matrix of strings (default demosir=[]), the demonstration directory

modulename:

a 1-by-1 matrix of strings (default modulename=""), the name of the module to update

verbose:

a 1-by-1 matrix of booleans (default verbose = %f), verbose = %t prints messages

nbxmlfiles :

a 1-by-1 matrix of floating point integers, the number of xml files updated.

isdemgwutd :

a 1-by-1 matrix of booleans, isdemgwutd==[] if demosdir is empty, isdemgwutd is true if demodir is non-empty and the demonstration gateway was not change, isdemgwutd is false if demodir is non-empty and the demonstration gateway was changed.

Description

Update the .xml help files and the demos scripts from the macros corresponding to the function array of strings funarray. The existing .xml files in the help dir which correspond to file in the funarray are overwritten (Caution !). Generates the .xml and the .sce files from the help_from_sci function.

Generates a demonstration gateway. If demosdir is an empty matrix, do not generate the demonstrations. The name of the demonstration gateway is computed from the modulename variable.

Examples

// Update the help of this module.
path = helptbx_getpath (  );
helpdir = fullfile(path,"help","en_US");
funmat = [
"helptbx_helpupdate"
"helptbx_iscontentupdte"
"helptbx_updtifneeded"
];
macrosdir = fullfile(path,"macros");
demosdir = fullfile(path,"demos");
modulename = "helptbx";
[nbxmlfiles , isdemgwutd] = helptbx_helpupdate ( funmat , helpdir , macrosdir , demosdir , modulename , %t )

// Do not print messages.
[nbxmlfiles , isdemgwutd] = helptbx_helpupdate ( funmat , helpdir , macrosdir , demosdir , modulename )

// Do not update demos.
[nbxmlfiles , isdemgwutd] = helptbx_helpupdate ( funmat , helpdir , macrosdir )

Authors


Report an issue
<< helptbx_getpath helptbx helptbx_iscontentupdte >>