add CDATA + role in the helptools module
[scilab.git] / scilab / modules / helptools / help / en_US / manedit.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:mml="http://www.w3.org/1998/Math/MathML" xmlns:db="http://docbook.org/ns/docbook" version="5.0-subset Scilab" xml:lang="en" xml:id="manedit">
14   <info>
15     <pubdate>$LastChangedDate$</pubdate>
16   </info>
17   <refnamediv>
18     <refname>manedit</refname>
19     <refpurpose>editing a manual item</refpurpose>
20   </refnamediv>
21   <refsynopsisdiv>
22     <title>Calling Sequence</title>
23     <synopsis>manedit(manitem)</synopsis>
24   </refsynopsisdiv>
25   <refsection>
26     <title>Parameters</title>
27     <variablelist>
28       <varlistentry>
29         <term>manitem</term>
30         <listitem>
31           <para>character string (usually, name of a function)</para>
32         </listitem>
33       </varlistentry>
34     </variablelist>
35   </refsection>
36   <refsection>
37     <title>Description</title>
38     <para><literal>edit(manitem)</literal> opens the xml file associated to <literal>manitem</literal>
39     in the scipad editor.</para>
40     <para>If there is no xml file associated with <literal>manitem</literal> and
41       <literal>manitem</literal> is the name of a Scilab function scipad opens with
42       the skeleton of the xml file produced by <link linkend="help_skeleton">help_skeleton</link>. This
43     file is located in TMPDIR.</para>
44   </refsection>
45   <refsection>
46     <title>Examples</title>
47     <programlisting role="example"><![CDATA[ 
48 manedit('manedit')
49
50 function [x,y,z]=foo123(a,b),
51 x=a+b,y=a-b,z=a==b
52 endfunction
53 manedit foo123
54  ]]></programlisting>
55   </refsection>
56   <refsection>
57     <title>See Also</title>
58     <simplelist type="inline">
59       <member>
60         <link linkend="help">help</link>
61       </member>
62       <member>
63         <link linkend="help_skeleton">help_skeleton</link>
64       </member>
65     </simplelist>
66   </refsection>
67 </refentry>