55c68d4140b8a12e8f6bbb49911c12c1ef936103
[scilab.git] / scilab / modules / helptools / help / en_US / xmltopdf.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) 2008 - INRIA
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="xmltopdf" 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>xmltopdf</refname>
20     <refpurpose>converts xml Scilab help files to pdf format</refpurpose>
21   </refnamediv>
22   <refsynopsisdiv>
23     <title>Calling Sequence</title>
24     <synopsis>xmltopdf(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 pdf
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 pdf files.</para>
64   </refsection>
65   <refsection>
66     <title>Examples</title>
67     <programlisting role="example">
68
69
70 // example_1/
71 // `-- help
72 //     |-- en_US
73 //     |   |-- example_1_function_1.xml
74 //     |   |-- example_1_function_2.xml
75 //     |   `-- example_1_function_3.xml
76 //     `-- fr_FR
77 //         |-- example_1_function_1.xml
78 //         |-- example_1_function_2.xml
79 //         `-- example_1_function_3.xml
80 //     `-- zh_TW
81 //         |-- example_1_function_1.xml
82 //         |-- example_1_function_2.xml
83 //         `-- example_1_function_3.xml
84
85 my_module_path = pathconvert(SCI+'/modules/helptools/examples/example_1',%f,%f)
86
87 // Build the french help
88 // =============================================================================
89 my_french_help_dir    = my_module_path+'/help/fr_FR';
90 my_french_help_title  = 'Example 1 [fr_FR]';
91 my_french_pdf         = xmltopdf(my_french_help_dir,my_french_help_title,'fr_FR')
92
93
94 // Build the english help
95 // =============================================================================
96 my_english_help_dir   = my_module_path+'/help/en_US';
97 my_english_help_title = 'Example 1 [en_US]';
98 my_english_pdf        = xmltopdf(my_english_help_dir,my_english_help_title,'en_US')
99
100 // Build the chinese help
101 // =============================================================================
102 my_chinese_help_dir   = my_module_path+'/help/zh_TW';
103 my_chinese_help_title = 'Example 1 [zh_TW]';
104 my_chinese_pdf        = xmltopdf(my_chinese_help_dir,my_chinese_help_title,'zh_TW')
105
106     </programlisting>
107   </refsection>
108   <refsection>
109     <title>See Also</title>
110     <simplelist type="inline">
111       <member>
112         <link linkend="help">help</link>
113       </member>
114       <member>
115         <link linkend="add_help_chapter">add_help_chapter</link>
116       </member>
117     </simplelist>
118   </refsection>
119 </refentry>