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