Add or format some examples in Xcos
[scilab.git] / scilab / modules / xcos / help / en_US / scilab_utilities_functions / importXcosDiagram.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) 2010 - DIGITEO - ClĂ©ment DAVID
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:ns3="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="importXcosDiagram">
14     <refnamediv>
15         <refname>importXcosDiagram</refname>
16         <refpurpose>Import a Xcos diagram on Scilab</refpurpose>
17     </refnamediv>
18     <refsynopsisdiv>
19         <title>Calling Sequence</title>
20         <synopsis>[result]=importXcosDiagram(filename)</synopsis>
21     </refsynopsisdiv>
22     <refsection id="Module_importXcosDiagram">
23         <title>Module</title>
24         <itemizedlist>
25             <listitem>
26                 <para>
27                     <link linkend="xcos">xcos</link>
28                 </para>
29             </listitem>
30         </itemizedlist>
31     </refsection>
32     <refsection id="Description_importXcosDiagram">
33         <title>Description</title>
34         <para>Import a Xcos file into Scilab.</para>
35     </refsection>
36     <refsection>
37         <title>Examples</title>
38         <programlisting role="example">
39             filename=SCI+"/modules/xcos/demos/demo_Datatype.xcos";
40             [result]=importXcosDiagram(filename)
41         </programlisting>
42     </refsection>
43     <refsection id="Parameters_importXcosDiagram">
44         <title>Arguments</title>
45         <itemizedlist>
46             <listitem>
47                 <para>
48                     <emphasis role="bold">result:</emphasis> The status of the
49                     operation.
50                 </para>
51             </listitem>
52             <listitem>
53                 <para>
54                     <emphasis role="bold">filename:</emphasis> The Xcos file to
55                     load.
56                 </para>
57             </listitem>
58         </itemizedlist>
59     </refsection>
60 </refentry>