xmltohtml
converts xml Scilab help files to HTML format
Syntax
xmltohtml(dirs [,titles [,dir_language [default_language]]]]])
Arguments
- 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 a 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 HTML files.
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 tmpPath = TMPDIR + "/examples"; copyfile("SCI/modules/helptools/examples", tmpPath); my_module_path = pathconvert(tmpPath + "/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]'; my_french_html_dir = xmltohtml(my_french_help_dir,my_french_help_title,'fr_FR') // Build the english help // ============================================================================= my_english_help_dir = my_module_path+'/help/en_US'; my_english_help_title = 'Example 1 [en_US]'; my_english_html_dir = xmltohtml(my_english_help_dir,my_english_help_title,'en_US') // Build the chinese help // ============================================================================= my_chinese_help_dir = my_module_path+'/help/zh_TW'; my_chinese_help_title = 'Example 1 [zh_TW]'; my_chinese_html_dir = xmltohtml(my_chinese_help_dir,my_chinese_help_title,'zh_TW')
See also
- help — queries and displays help pages in the Scilab help browser
- add_help_chapter — Add an entry in the help list
| Report an issue | ||
| << manedit | utilities | xmltojar >> |