Add a closeEditvar() function
[scilab.git] / scilab / modules / ui_data / help / en_US / editvar.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) Jaime Urzua
5  * Copyright (C) Allan CORNET - DIGITEO - 2010
6  * Copyright (C) Sylvestre Ledru - Scilab Enterprises - 2011
7  * 
8  * This file must be used under the terms of the CeCILL.
9  * This source file is licensed as described in the file COPYING, which
10  * you should have received as part of this distribution.  The terms
11  * are also available at    
12  * http://www.cecill.info/licences/Licence_CeCILL_V2-en.txt
13  *
14  -->
15 <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" xmlns:scilab="http://www.scilab.org" xml:lang="en" xml:id="editvar">
16     <refnamediv>
17         <refname>editvar</refname>
18         <refpurpose>Scilab variable editor</refpurpose>
19     </refnamediv>
20     <refsynopsisdiv>
21         <title>Calling Sequence</title>
22         <synopsis>editvar varname</synopsis>
23     </refsynopsisdiv>
24     <refsection>
25         <title>Arguments</title>
26         <variablelist>
27             <varlistentry>
28                 <term>varname</term>
29                 <listitem>
30                     <para>variable name. The variable must exist in the current Scilab environnement.</para>
31                 </listitem>
32             </varlistentry>
33         </variablelist>
34     </refsection>
35     <refsection>
36         <title>Description</title>
37         <para>
38             <literal>editvar</literal> is the Scilab variable editor.
39         </para>
40         <para>
41             <literal>editvar</literal> can be started by calling it on the name of the variable or by double-clicking on the name of the variable from the <link linkend="browsevar">browsevar component</link>.
42         </para>
43         <para>
44             <literal>editvar</literal> has numerous features: 
45             <itemizedlist>
46                 <listitem><para>
47                         Matrix visualisation
48                         <para/>
49                         <para>
50                             <inlinemediaobject>
51                                 <imageobject>
52                                     <imagedata fileref="../images/editvar_default.png"/>
53                                 </imageobject>
54                             </inlinemediaobject>
55                         </para>
56                         <para/>
57                         
58                     </para>
59                 </listitem>
60                 <listitem><para>
61                         Undo/redo capabilities
62                     </para>
63                 </listitem>
64                 <listitem><para>
65                         Cell editing
66                     </para>
67                 </listitem>
68                 <listitem><para>
69                         Expression evaluation. Please note that editvar will not store the expression. Only the value.
70                         <para/>
71                         <para>
72                             <inlinemediaobject>
73                                 <imageobject>
74                                     <imagedata fileref="../images/editvar_modify.png"/>
75                                 </imageobject>
76                             </inlinemediaobject>
77                         </para>
78                         <para/>
79                         <para/>
80                     </para>
81                 </listitem>
82                 <listitem><para>
83                         Advanced selection of elements (available with the CTRL key)
84                         <para/>
85                         <para>
86                             <inlinemediaobject>
87                                 <imageobject>
88                                     <imagedata fileref="../images/editvar_adv_selection.png"/>
89                                 </imageobject>
90                             </inlinemediaobject>
91                         </para>
92                         <para/>
93                     </para>
94                 </listitem>
95                 <listitem><para>
96                         Plotting
97                         <para/>
98                         <para>
99                             <inlinemediaobject>
100                                 <imageobject>
101                                     <imagedata fileref="../images/editvar_plot.png"/>
102                                 </imageobject>
103                             </inlinemediaobject>
104                         </para>
105                         <para/>
106                     </para>
107                 </listitem>
108                 <listitem><para>
109                         Plotting of a subset
110                         <para/>
111                         <para>
112                             <inlinemediaobject>
113                                 <imageobject>
114                                     <imagedata fileref="../images/editvar_subplot.png"/>
115                                 </imageobject>
116                             </inlinemediaobject>
117                         </para>
118                         <para/>
119                     </para>
120                 </listitem>
121                 <listitem><para>
122                         Variable format (short, shortE, long or longE formats)
123                         <para/>
124                         <para>
125                             <inlinemediaobject>
126                                 <imageobject>
127                                     <imagedata fileref="../images/editvar_format.png"/>
128                                 </imageobject>
129                             </inlinemediaobject>
130                         </para>
131                         <para/>
132                     </para>
133                 </listitem>
134                 <listitem><para>
135                         Column / lines management (insert, delete, copy and paste, ... )
136                         <para/>
137                         <para>
138                             <inlinemediaobject>
139                                 <imageobject>
140                                     <imagedata fileref="../images/editvar_column.png"/>
141                                 </imageobject>
142                             </inlinemediaobject>
143                         </para>
144                         <para/>
145                         <para/>
146                     </para>
147                 </listitem>
148                 <listitem><para>
149                         Full copy and paste between <ulink url="http://www.libreoffice.org/">Libreoffice</ulink>/Openoffice or Microsoft Excel and Scilab (both ways)
150                         <para/>
151                         <para>
152                             <inlinemediaobject>
153                                 <imageobject>
154                                     <imagedata fileref="../images/editvar_libreoffice.png"/>
155                                 </imageobject>
156                             </inlinemediaobject>
157                         </para>
158                         <para/>
159                         <para/>
160                     </para>
161                 </listitem>
162                 <listitem><para>
163                         Renaming or copy of a variable
164                         <para/>
165                         <para>
166                             <inlinemediaobject>
167                                 <imageobject>
168                                     <imagedata fileref="../images/editvar_variable_selection.png"/>
169                                 </imageobject>
170                             </inlinemediaobject>
171                         </para>
172                         <para/>
173                     </para>
174                 </listitem>
175             </itemizedlist>
176         </para>
177         <para>
178             <literal>editvar</literal> can edit the following variable types:
179             
180             <itemizedlist>
181                 <listitem><para>
182                         Real or complex constant matrix (type 1)
183                     </para>
184                 </listitem>
185                 <listitem>
186                     <para>
187                         <link linkend="matrices">Boolean matrix</link> (type 4)
188                     </para>
189                 </listitem>
190                 <listitem>
191                     <para>
192                         <link linkend="sparse">Sparse matrix</link> (type 5)
193                     </para>
194                 </listitem>
195                 <listitem>
196                     <para>
197                         <link linkend="sparse">Boolean sparse matrix</link> (type 6)
198                     </para>
199                 </listitem>
200                 <listitem>
201                     <para>
202                         <link linkend="int8">Integer matrix</link>: 8, 16 &amp; 32 bytes (type 8)
203                     </para>
204                 </listitem>
205                 <listitem>
206                     <para>
207                         <link linkend="strings">Matrix of strings</link> (type 10)
208                     </para>
209                 </listitem>
210             </itemizedlist>
211         </para>
212     </refsection>
213     <refsection>
214         <title>Examples</title>
215         <programlisting role="example"><![CDATA[ 
216 a=rand(10,10);
217 editvar a;
218 b=['hello';'good bye'];
219 editvar b;
220 sp=sparse([1,2;4,5;3,10],[1,2,3])
221 editvar("sp");
222  ]]></programlisting>
223     </refsection>
224     <refsection role="see also">
225         <title>See Also</title>
226         <simplelist type="inline">
227             <member>
228                 <link linkend="closeEditvar">closeEditvar</link>
229             </member>
230         </simplelist>
231     </refsection>
232 </refentry>