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