add CDATA + role in the helptools module
[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-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" version="5.0-subset Scilab" xml:id="xmltochm" xml:lang="en">
14   <info>
15     <pubdate>$LastChangedDate: 2008-03-14 11:58:09 +0100 (ven, 14 mar 2008)
16     $</pubdate>
17   </info>
18   <refnamediv>
19     <refname>xmltochm</refname>
20     <refpurpose>converts xml Scilab help files to Microsoft Compressed HTML format (Windows)</refpurpose>
21   </refnamediv>
22   <refsynopsisdiv>
23     <title>Calling Sequence</title>
24     <synopsis>xmltochm(dirs [,titles [,dir_language [default_language]]]]])</synopsis>
25   </refsynopsisdiv>
26   <refsection>
27     <title>Parameters</title>
28     <variablelist>
29       <varlistentry>
30         <term>dirs</term>
31         <listitem>
32           <para>vector of strings: a set of directory paths for which html
33           manuals are to be generated or <literal>[] </literal></para>
34         </listitem>
35       </varlistentry>
36       <varlistentry>
37         <term>titles</term>
38         <listitem>
39           <para>vector of strings: titles associated to directory paths or
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           []</para>
48         </listitem>
49       </varlistentry>
50       <varlistentry>
51         <term>default_language</term>
52         <listitem>
53           <para>vector of strings: default languages associated to directory
54               paths or []. If an XML file is missing in the dir_language, it's
55               copied from the default_language.</para>
56         </listitem>
57       </varlistentry>
58     </variablelist>
59   </refsection>
60   <refsection>
61     <title>Description</title>
62     <para>converts xml Scilab help files contained in a set of directories
63     into chm files.</para>
64     
65     <para>
66 <ulink url="http://msdn.microsoft.com/en-us/library/ms669985(VS.85).aspx">Microsoft HTML Help Downloads (Windows)</ulink>
67     </para>
68   </refsection>
69   <refsection>
70     <title>Examples</title>
71     <programlisting role="example"><![CDATA[ 
72 // example_1/
73 // `-- help
74 //     |-- en_US
75 //     |   |-- example_1_function_1.xml
76 //     |   |-- example_1_function_2.xml
77 //     |   `-- example_1_function_3.xml
78 //     `-- fr_FR
79 //         |-- example_1_function_1.xml
80 //         |-- example_1_function_2.xml
81 //         `-- example_1_function_3.xml
82 //     `-- zh_TW
83 //         |-- example_1_function_1.xml
84 //         |-- example_1_function_2.xml
85 //         `-- example_1_function_3.xml
86
87 my_module_path = pathconvert(SCI+'/modules/helptools/examples/example_1',%f,%f)
88
89 // Build the french help
90 // =============================================================================
91 my_french_help_dir    =  my_module_path+'/help/fr_FR';
92 my_french_help_title  =  'Example 1 [fr_FR]';
93 res = xmltochm(my_french_help_dir,my_french_help_title,'fr_FR');
94 if MSDOS then
95  dos('start ' + res);
96 end
97
98 // Build the english help
99 // =============================================================================
100 my_english_help_dir   =  my_module_path+'/help/en_US';
101 my_english_help_title =  'Example 1 [en_US]';
102 res = xmltochm(my_english_help_dir,my_english_help_title,'en_US');
103 if MSDOS then
104  dos('start ' + res);
105 end
106
107 // Build the chinese help
108 // =============================================================================
109 my_chinese_help_dir   =  my_module_path+'/help/zh_TW';
110 my_chinese_help_title =  'Example 1 [zh_TW]';
111 res = xmltochm(my_chinese_help_dir,my_chinese_help_title,'zh_TW');
112 if MSDOS then
113  dos('start ' + res);
114 end
115  ]]></programlisting>
116   </refsection>
117   <refsection>
118     <title>See Also</title>
119     <simplelist type="inline">
120       <member>
121         <link linkend="help">help</link>
122       </member>
123       <member>
124         <link linkend="add_help_chapter">add_help_chapter</link>
125       </member>
126     </simplelist>
127   </refsection>
128 </refentry>