1ce20ad7495497b08e44ab15655bb1e7ee983a8f
[scilab.git] / scilab / modules / helptools / help / en_US / xmltochm.xml
1 <?xml version="1.0" encoding="UTF-8"?>
2 <!--
3  * Scilab ( http://www.scilab.org/ ) - This file is part of Scilab
4  * Copyright (C) 2009 - DIGITEO - Allan CORNET
5  * 
6  * This file must be used under the terms of the CeCILL.
7  * This source file is licensed as described in the file COPYING, which
8  * you should have received as part of this distribution.  The terms
9  * are also available at
10  * http://www.cecill.info/licences/Licence_CeCILL_V2.1-en.txt
11  *
12  -->
13 <refentry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xmlns:svg="http://www.w3.org/2000/svg" xmlns:ns4="http://www.w3.org/1999/xhtml" xmlns:mml="http://www.w3.org/1998/Math/MathML" xmlns:db="http://docbook.org/ns/docbook" xmlns:scilab="http://www.scilab.org" xml:id="xmltochm" xml:lang="en">
14     <refnamediv>
15         <refname>xmltochm</refname>
16         <refpurpose>
17             converts xml Scilab help files to Microsoft Compressed HTML format (Windows). <emphasis role="bold">This function is obsolete.</emphasis>
18         </refpurpose>
19     </refnamediv>
20     <refsynopsisdiv>
21         <title>Calling Sequence</title>
22         <synopsis>xmltochm(dirs [,titles [,dir_language [default_language]]]]])</synopsis>
23     </refsynopsisdiv>
24     <refsection>
25         <title>Arguments</title>
26         <variablelist>
27             <varlistentry>
28                 <term>dirs</term>
29                 <listitem>
30                     <para>vector of strings: a set of directory paths for which html
31                         manuals are to be generated or <literal>[] </literal>
32                     </para>
33                 </listitem>
34             </varlistentry>
35             <varlistentry>
36                 <term>titles</term>
37                 <listitem>
38                     <para>vector of strings: titles associated to directory paths or
39                         []
40                     </para>
41                 </listitem>
42             </varlistentry>
43             <varlistentry>
44                 <term>dir_language</term>
45                 <listitem>
46                     <para>vector of strings: languages associated to directory paths or
47                         []
48                     </para>
49                 </listitem>
50             </varlistentry>
51             <varlistentry>
52                 <term>default_language</term>
53                 <listitem>
54                     <para>vector of strings: default languages associated to directory
55                         paths or []. If a XML file is missing in the dir_language, it's
56                         copied from the default_language.
57                     </para>
58                 </listitem>
59             </varlistentry>
60         </variablelist>
61     </refsection>
62     <refsection>
63         <title>Description</title>
64         <para>converts xml Scilab help files contained in a set of directories
65             into chm files.
66         </para>
67         <para>
68             <ulink url="http://msdn.microsoft.com/en-us/library/ms669985(VS.85).aspx">Microsoft HTML Help Downloads (Windows)</ulink>
69         </para>
70     </refsection>
71     <refsection>
72         <title>Examples</title>
73         <programlisting role="example"><![CDATA[ 
74 // example_1/
75 // `-- help
76 //     |-- en_US
77 //     |   |-- example_1_function_1.xml
78 //     |   |-- example_1_function_2.xml
79 //     |   `-- example_1_function_3.xml
80 //     `-- fr_FR
81 //         |-- example_1_function_1.xml
82 //         |-- example_1_function_2.xml
83 //         `-- example_1_function_3.xml
84 //     `-- zh_TW
85 //         |-- example_1_function_1.xml
86 //         |-- example_1_function_2.xml
87 //         `-- example_1_function_3.xml
88
89 tmpPath = TMPDIR + "/examples";
90 copyfile("SCI/modules/helptools/examples", tmpPath);
91 my_module_path = pathconvert(tmpPath + "/example_1",%f,%f);
92
93 // Build the french help
94 // =============================================================================
95 my_french_help_dir    =  my_module_path+'/help/fr_FR';
96 my_french_help_title  =  'Example 1 [fr_FR]';
97 res = xmltochm(my_french_help_dir,my_french_help_title,'fr_FR');
98 if getos() == 'Windows' then
99  dos('start ' + res);
100 end
101
102 // Build the english help
103 // =============================================================================
104 my_english_help_dir   =  my_module_path+'/help/en_US';
105 my_english_help_title =  'Example 1 [en_US]';
106 res = xmltochm(my_english_help_dir,my_english_help_title,'en_US');
107 if getos() == 'Windows' then
108  dos('start ' + res);
109 end
110
111 // Build the chinese help
112 // =============================================================================
113 my_chinese_help_dir   =  my_module_path+'/help/zh_TW';
114 my_chinese_help_title =  'Example 1 [zh_TW]';
115 res = xmltochm(my_chinese_help_dir,my_chinese_help_title,'zh_TW');
116 if getos() == 'Windows' then
117  dos('start ' + res);
118 end
119  ]]></programlisting>
120     </refsection>
121     <refsection role="see also">
122         <title>See Also</title>
123         <simplelist type="inline">
124             <member>
125                 <link linkend="help">help</link>
126             </member>
127             <member>
128                 <link linkend="add_help_chapter">add_help_chapter</link>
129             </member>
130         </simplelist>
131     </refsection>
132     <refsection>
133         <title>History</title>
134         <revhistory>
135             <revision>
136                 <revnumber>5.5.0</revnumber>
137                 <revdescription>
138                     Function tagged obsolete. Will be removed in 5.5.1.
139                 </revdescription>
140             </revision>
141         </revhistory>
142     </refsection>
143 </refentry>