Name

xmltochm — converts xml Scilab help files to Microsoft Compressed HTML format (Windows)

Calling Sequence

xmltochm(dirs [,titles [,dir_language [default_language]]]]])

Parameters

dirs

vector of strings: a set of directory paths for which html manuals are to be generated or []

titles

vector of strings: titles associated to directory paths or []

dir_language

vector of strings: languages associated to directory paths or []

default_language

vector of strings: default languages associated to directory paths or []. If an XML file is missing in the dir_language, it's copied from the default_language.

Description

converts xml Scilab help files contained in a set of directories into chm files.

Microsoft HTML Help Downloads (Windows)

Examples

 
// example_1/
// `-- help
//     |-- en_US
//     |   |-- example_1_function_1.xml
//     |   |-- example_1_function_2.xml
//     |   `-- example_1_function_3.xml
//     `-- fr_FR
//         |-- example_1_function_1.xml
//         |-- example_1_function_2.xml
//         `-- example_1_function_3.xml
//     `-- zh_TW
//         |-- example_1_function_1.xml
//         |-- example_1_function_2.xml
//         `-- example_1_function_3.xml

my_module_path = pathconvert(SCI+'/modules/helptools/examples/example_1',%f,%f)

// Build the french help
// =============================================================================
my_french_help_dir    =  my_module_path+'/help/fr_FR';
my_french_help_title  =  'Example 1 [fr_FR]';
res = xmltochm(my_french_help_dir,my_french_help_title,'fr_FR');
if MSDOS then
 dos('start ' + res);
end

// Build the english help
// =============================================================================
my_english_help_dir   =  my_module_path+'/help/en_US';
my_english_help_title =  'Example 1 [en_US]';
res = xmltochm(my_english_help_dir,my_english_help_title,'en_US');
if MSDOS then
 dos('start ' + res);
end

// Build the chinese help
// =============================================================================
my_chinese_help_dir   =  my_module_path+'/help/zh_TW';
my_chinese_help_title =  'Example 1 [zh_TW]';
res = xmltochm(my_chinese_help_dir,my_chinese_help_title,'zh_TW');
if MSDOS then
 dos('start ' + res);
end

See Also

help , add_help_chapter