[doc] misc. fix & improvements
[scilab.git] / scilab / modules / gui / help / en_US / interactive_editor.xml
1 <?xml version="1.0" encoding="UTF-8"?>
2 <refentry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink"
3           xmlns:svg="http://www.w3.org/2000/svg" xmlns:mml="http://www.w3.org/1998/Math/MathML"
4           xmlns:db="http://docbook.org/ns/docbook" version="5.0-subset Scilab"
5           xml:lang="en" xml:id="ieditor">
6     <refnamediv>
7         <refname>Interactive Editor</refname>
8         <refpurpose>Interactive plot editor</refpurpose>
9     </refnamediv>
10     <refsection>
11         <title>Description</title>
12
13         <para>
14             The interactive plot editor added new features to scilab, now the user can
15             interact with the plot window and the graphic objects without using a single line of code.
16         </para>
17         <para>
18             The interactive plot editor provides the following features:
19         </para>
20         <para>
21             Editor menu:
22         </para>
23         <para>
24             <inlinemediaobject>
25                 <imageobject>
26                     <imagedata fileref="../images/editor_menu.png"/>
27                 </imageobject>
28             </inlinemediaobject>
29         </para>
30         <itemizedlist>
31             <listitem><para>
32                     Graphic entity selection
33                 </para>
34                 The user can select curves, surfaces and legends on the plot window.
35                 <para>
36                     To select an entity, you need just click on it.
37                 </para>
38                 <inlinemediaobject>
39                     <imageobject>
40                         <imagedata fileref="../images/editor_selected.png"/>
41                     </imageobject>
42                 </inlinemediaobject>
43             </listitem>
44             <listitem><para>
45                     Copy, Cut, Paste
46                 </para>
47                 Selected entities can be copied/cutted and be pasted to others figures (except legends).
48                 <para>
49                     To copy/cut an entity: select it, right click copy/cut.
50                 </para>
51                 <inlinemediaobject>
52                     <imageobject>
53                         <imagedata fileref="../images/editor_copy.png"/>
54                     </imageobject>
55                     <imageobject>
56                         <imagedata fileref="../images/editor_paste.png"/>
57                     </imageobject>
58                 </inlinemediaobject>
59             </listitem>
60
61             <listitem><para>
62                     Copy axes style
63                 </para>
64                 The axes properties can be copied and pasted to ease formatting between figures.
65                 <para>
66                     To copy the axes style: right click in the figure and "copy style".
67                 </para>
68                 <inlinemediaobject>
69                     <imageobject>
70                         <imagedata fileref="../images/editor_copy_style.png"/>
71                     </imageobject>
72                     <imageobject>
73                         <imagedata fileref="../images/editor_paste_style.png"/>
74                     </imageobject>
75                 </inlinemediaobject>
76             </listitem>
77
78             <listitem><para>
79                     Copy to clipboard
80                 </para>
81                 The figure can be copied to the system clipboard, and pasted to others programs (like Word).
82                 <para>
83                     To copy the figure to the clipboard: right click, copy to clipboard
84                 </para>
85                 <inlinemediaobject>
86                     <imageobject>
87                         <imagedata fileref="../images/editor_copy_clipboard.png"/>
88                     </imageobject>
89                 </inlinemediaobject>
90             </listitem>
91
92             <listitem><para>
93                     Delete
94                 </para>
95                 Deletes the selected entity.
96                 <para>
97                     To delete an entity: select it, right click, delete
98                 </para>
99                 <inlinemediaobject>
100                     <imageobject>
101                         <imagedata fileref="../images/editor_delete.png"/>
102                     </imageobject>
103                     <imageobject>
104                         <imagedata fileref="../images/editor_deleted.png"/>
105                     </imageobject>
106                 </inlinemediaobject>
107             </listitem>
108
109             <listitem><para>
110                     Hide, Unhide
111                 </para>
112                 Enables the user to hide the selected entity and unhide all hidden entities.
113                 <para>
114                     To hide an entity: select it, right click, hide.
115                 </para>
116                 <inlinemediaobject>
117                     <imageobject>
118                         <imagedata fileref="../images/editor_hide.png"/>
119                     </imageobject>
120                     <imageobject>
121                         <imagedata fileref="../images/editor_hidden.png"/>
122                     </imageobject>
123                 </inlinemediaobject>
124             </listitem>
125
126             <listitem><para>
127                     Undo / Redo
128                 </para>
129                 Almost any action done with the editor can be undone/ redone.
130                 <para>
131                     To undo/redo an action, right click, "undo"/redo.
132                 </para>
133             </listitem>
134
135             <listitem><para>
136                     Labels
137                 </para>
138                 <para>
139                     With a simply right click the user can insert labels in the axes, and doing a double click over a label text opens a dialog to edit its text.
140                 </para>
141                 <inlinemediaobject>
142                     <imageobject>
143                         <imagedata fileref="../images/editor_edit_label.png"/>
144                     </imageobject>
145                 </inlinemediaobject>
146             </listitem>
147
148             <listitem><para>
149                     Legends
150                 </para>
151                 <para>
152                     With a simply right click the user can insert a legend to the selected curve or remove it, and doing a double click over a legend box opens a dialog to edit its text.
153                 </para>
154                 <inlinemediaobject>
155                     <imageobject>
156                         <imagedata fileref="../images/editor_edit_legend.png"/>
157                     </imageobject>
158                     <!-- <imageobject>
159             <imagedata fileref="../images/editor_remove_legend.png"/>
160           </imageobject>
161           <imageobject>
162             <imagedata fileref="../images/editor_removed_legend.png"/>
163           </imageobject> -->
164                 </inlinemediaobject>
165             </listitem>
166
167             <listitem><para>
168                     Clear
169                 </para>
170                 Clears the figure.
171                 <para>
172                     Clear action isn't added to the undo/redo history.
173                 </para>
174                 <inlinemediaobject>
175                     <imageobject>
176                         <imagedata fileref="../images/editor_clear.png"/>
177                     </imageobject>
178                     <imageobject>
179                         <imagedata fileref="../images/editor_clean.png"/>
180                     </imageobject>
181                 </inlinemediaobject>
182             </listitem>
183
184             <listitem><para>
185                     Open GED
186                 </para>
187                 With a simply right click the user can open the ged with the properties from the selected/right clicked entity.
188             </listitem>
189
190         </itemizedlist>
191
192         <itemizedlist>
193             <listitem>
194                 <para>
195                     Move objects
196                 </para>
197                 <para>
198                     To move objects: enable the data editor mode, select and drag an object.
199                 </para>
200                 <inlinemediaobject>
201                     <imageobject>
202                         <imagedata fileref="../images/editor_enable_edit.png"/>
203                     </imageobject>
204                     <imageobject>
205                         <imagedata fileref="../images/editor_move_curve.png"/>
206                     </imageobject>
207                 </inlinemediaobject>
208                 <inlinemediaobject>
209                     <imageobject>
210                         <imagedata fileref="../images/editor_move_legend.png"/>
211                     </imageobject>
212                     <imageobject>
213                         <imagedata fileref="../images/editor_moved_legend.png"/>
214                     </imageobject>
215                 </inlinemediaobject>
216             </listitem>
217
218             <listitem>
219                 <para>
220                     Graphically curve data editor
221                 </para>
222                 <para>
223                     To edit a curve data: enable the data editor mode, select an object, right click, edit curve data or double click over curve.
224                 </para>
225                 <inlinemediaobject>
226                     <imageobject>
227                         <imagedata fileref="../images/editor_enable_curve_edit.png"/>
228                     </imageobject>
229                 </inlinemediaobject>
230                 <para>
231                     To add a point: with the selected curve in edit mode, right click, "insert" or double click over the curve.
232                 </para>
233                 <para>
234                     To remove a point: with the selected curve in edit mode, right click, "remove".
235                 </para>
236                 <inlinemediaobject>
237                     <imageobject>
238                         <imagedata fileref="../images/editor_add_point.png"/>
239                     </imageobject>
240                 </inlinemediaobject>
241                 <para>
242                     To move a point: with the selected curve in edit mode, click in the point and drag it.
243                 </para>
244                 <inlinemediaobject>
245                     <imageobject>
246                         <imagedata fileref="../images/editor_move_point.png"/>
247                     </imageobject>
248                 </inlinemediaobject>
249             </listitem>
250         </itemizedlist>
251     </refsection>
252     <refsection role="see also">
253         <title>See also</title>
254         <simplelist type="inline">
255             <member>
256                 <link linkend="object_editor">Properties editor</link>
257             </member>
258             <member>
259                 <link linkend="ged">ged</link>
260             </member>
261             <member>
262                 <link linkend="graphics_entities">graphics_entities</link>
263             </member>
264             <member>
265                 <link linkend="set">set</link>
266             </member>
267             <member>
268                 <link linkend="get">get</link>
269             </member>
270         </simplelist>
271     </refsection>
272 </refentry>