Preferences: continue to connect SciNotes
[scilab.git] / scilab / modules / scinotes / help / en_US / scinotes.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) 2009 - DIGITEO - Sylvestre KOUMAR
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:ns5="http://www.w3.org/1999/xhtml" xmlns:mml="http://www.w3.org/1998/Math/MathML" xmlns:db="http://docbook.org/ns/docbook" version="5.0-subset Scilab" xml:id="scinotes" xml:lang="en">
14   <info>
15     <pubdate>$LastChangedDate$</pubdate>
16   </info>
17   <refnamediv>
18     <refname>scinotes</refname>
19     <refpurpose>Scinotes: Embedded Scilab text editor</refpurpose>
20   </refnamediv>
21   <refsynopsisdiv>
22     <title>Calling Sequence</title>
23     <synopsis>
24       scinotes()
25       scinotes(file)
26       scinotes([file1, file2])
27       scinotes(file, line_number)
28       scinotes(file, line_number, macro_name)
29       scinotes([file1, file2], [line_number1, line_number2])
30       scinotes(file, 'readonly')
31       scinotes([file1, file2], 'readonly')
32       
33     </synopsis>
34   </refsynopsisdiv>
35   <refsection>
36     <title>Arguments</title>
37     <variablelist>
38       <varlistentry>
39         <term>file</term>
40         <listitem>
41           <para>a string, the file to be opened.</para>
42         </listitem>
43       </varlistentry>
44       <varlistentry>
45         <term>[file1, file2]</term>
46         <listitem>
47           <para>a matrix of string, files to be opened.</para>
48         </listitem>
49       </varlistentry>
50     </variablelist>
51     <variablelist>
52       <varlistentry>
53         <term>line_number</term>
54         <listitem>
55           <para>An integer, the number of the line to be highlighted at the
56             opening of the file.
57           </para>
58         </listitem>
59       </varlistentry>
60     </variablelist>
61     <variablelist>
62       <varlistentry>
63         <term>macro_name</term>
64         <listitem>
65           <para>a string, the line number would be relative to the definition of the function macro_name</para>
66         </listitem>
67       </varlistentry>
68     </variablelist>
69     <variablelist>
70       <varlistentry>
71         <term>[line_number1, line_number2]</term>
72         <listitem>
73           <para>a matrix of integer, each opened file will have its corresponding
74             line highlighted.
75           </para>
76         </listitem>
77       </varlistentry>
78     </variablelist>
79   </refsection>
80   <refsection>
81     <title>Description</title>
82     <para>
83       <literal>Scinotes</literal> is an embedded Scilab text editor.
84     </para>
85     <para>It can be started with a fresh text buffer pressing the "Editor"
86       button on top of the main Scilab window, or from Scilab command line with
87       the instruction <literal>editor()</literal>, or it can open specific files
88       if invoked with any of the calling sequences above (whithout any
89       parameters, it opens editor with a blank file).
90     </para>
91     <para>The same invocation adds further files to an already opened
92       Editor.
93     </para>
94     <para>With the option 'readonly', files are opened in read-only mode so
95       they cannot be modified.
96     </para>
97     <para>Keyboard shortcuts are defined for most possible editing actions and
98       reported by the menu entries.
99     </para>
100     <para/>
101     <para>SciNotes can be started in the following ways :</para>
102     <itemizedlist>
103       <listitem>
104         <para>By the menu Applications. Choose Applications =&gt;
105           Editor
106         </para>
107       </listitem>
108       <listitem>
109         <para>From the command line:</para>
110         <itemizedlist>
111           <listitem>
112             <para>scinotes()</para>
113           </listitem>
114           <listitem>
115             <para>scinotes(file)</para>
116           </listitem>
117           <listitem>
118             <para>scinotes([file1, file2])</para>
119           </listitem>
120           <listitem>
121             <para>scinotes(file, line_number)</para>
122           </listitem>
123           <listitem>
124             <para>scinotes([file1, file2], [line_number1, line_number2])</para>
125           </listitem>
126         </itemizedlist>
127       </listitem>
128     </itemizedlist>
129   </refsection>
130   <refsection>
131     <title>Menus and Shortcuts</title>
132     <itemizedlist>
133       <listitem>
134         <para>Menu File</para>
135         <informaltable border="1">
136           <tr>
137             <td>
138               <para>Commande</para>
139             </td>
140             <td>
141               <para>Shortcut</para>
142             </td>
143             <td>
144               <para>Description</para>
145             </td>
146           </tr>
147           <tr>
148             <td>New...</td>
149             <td>&lt;CTRL-N&gt;</td>
150             <td>
151               <para>Open a new file</para>
152             </td>
153           </tr>
154           <tr>
155             <td>Open...</td>
156             <td>&lt;CTRL-O&gt;</td>
157             <td>
158               <para>Open an existing file</para>
159             </td>
160           </tr>
161           <tr>
162             <td>Recent Files</td>
163             <td/>
164             <td>
165               <para>Display files recently opened</para>
166             </td>
167           </tr>
168           <tr>
169             <td>Save</td>
170             <td>&lt;CTRL-S&gt;</td>
171             <td>
172               <para>Save a file</para>
173             </td>
174           </tr>
175           <tr>
176             <td>Save as...</td>
177             <td>&lt;CTRL-MAJ-S&gt;</td>
178             <td>
179               <para>Save a file as</para>
180             </td>
181           </tr>
182           <tr>
183             <td>Page Setup</td>
184             <td/>
185             <td>
186               <para>Setup page for printing</para>
187             </td>
188           </tr>
189           <tr>
190             <td>Print Preview</td>
191             <td>&lt;CTRL-MAJ-P&gt;</td>
192             <td>
193               <para>Open a print preview window</para>
194             </td>
195           </tr>
196           <tr>
197             <td>Print...</td>
198             <td>&lt;CTRL-P&gt;</td>
199             <td>
200               <para>Print a file</para>
201             </td>
202           </tr>
203           <tr>
204             <td>Close</td>
205             <td>&lt;CTRL-W&gt;</td>
206             <td>
207               <para>Close a file</para>
208             </td>
209           </tr>
210           <tr>
211             <td>Quit</td>
212             <td>&lt;CTRL-Q&gt;</td>
213             <td>
214               <para>Close Editor</para>
215             </td>
216           </tr>
217         </informaltable>
218       </listitem>
219       <listitem>
220         <para>Menu Edit</para>
221         <informaltable border="1">
222           <tr>
223             <td>
224               <para>Commande</para>
225             </td>
226             <td>
227               <para>Shortcut</para>
228             </td>
229             <td>
230               <para>Description</para>
231             </td>
232           </tr>
233           <tr>
234             <td>Undo</td>
235             <td>&lt;CTRL-Z&gt;</td>
236             <td>
237               <para>Undo action</para>
238             </td>
239           </tr>
240           <tr>
241             <td>Redo</td>
242             <td>&lt;CTRL-Y&gt;</td>
243             <td>
244               <para>Redo action</para>
245             </td>
246           </tr>
247           <tr>
248             <td>Cut</td>
249             <td>&lt;CTRL-X&gt;</td>
250             <td>
251               <para>Cut the selection</para>
252             </td>
253           </tr>
254           <tr>
255             <td>Copy</td>
256             <td>&lt;CTRL-C&gt;</td>
257             <td>
258               <para>Copy the selection</para>
259             </td>
260           </tr>
261           <tr>
262             <td>Paste</td>
263             <td>&lt;CTRL-V&gt;</td>
264             <td>
265               <para>Paste the selection</para>
266             </td>
267           </tr>
268           <tr>
269             <td>Select All</td>
270             <td>&lt;CTRL-A&gt;</td>
271             <td>
272               <para>Select the entire document</para>
273             </td>
274           </tr>
275           <tr>
276             <td>Delete</td>
277             <td/>
278             <td>
279               <para>Delete the selection</para>
280             </td>
281           </tr>
282           <tr>
283             <td>Comment Selection</td>
284             <td>&lt;CTRL-D&gt;</td>
285             <td>
286               <para>Comment selected lines</para>
287             </td>
288           </tr>
289           <tr>
290             <td>Uncomment Selection</td>
291             <td>&lt;CTRL-MAJ-D&gt;</td>
292             <td>
293               <para>Uncomment selected lines</para>
294             </td>
295           </tr>
296           <tr>
297             <td>Tabify Selection</td>
298             <td>&lt;TAB&gt;</td>
299             <td>
300               <para>Tabify selected lines</para>
301             </td>
302           </tr>
303           <tr>
304             <td>Untabify Selection</td>
305             <td>&lt;MAJ-TAB&gt;</td>
306             <td>
307               <para>Untabify selected lines</para>
308             </td>
309           </tr>
310           <tr>
311             <td>Indent</td>
312             <td>&lt;CTRL-I&gt;</td>
313             <td>
314               <para>Indent selected lines</para>
315             </td>
316           </tr>
317         </informaltable>
318       </listitem>
319       <listitem>
320         <para>Menu Search</para>
321         <informaltable border="1">
322           <tr>
323             <td>
324               <para>Commande</para>
325             </td>
326             <td>
327               <para>Shortcut</para>
328             </td>
329             <td>
330               <para>Description</para>
331             </td>
332           </tr>
333           <tr>
334             <td>Find/Replace</td>
335             <td>&lt;CTRL-F&gt;</td>
336             <td>
337               <para>Find and/or Replace an element</para>
338             </td>
339           </tr>
340           <tr>
341             <td>Goto line</td>
342             <td>&lt;CTRL-G&gt;</td>
343             <td>
344               <para>Goto line</para>
345             </td>
346           </tr>
347         </informaltable>
348       </listitem>
349       <listitem>
350         <para>Menu View</para>
351         <informaltable border="1">
352           <tr>
353             <td>
354               <para>Commande</para>
355             </td>
356             <td>
357               <para>Shortcut</para>
358             </td>
359             <td>
360               <para>Description</para>
361             </td>
362           </tr>
363           <tr>
364             <td>Show/Hide Toolbar</td>
365             <td/>
366             <td>
367               <para>Option to show or hide the toolbar</para>
368             </td>
369           </tr>
370           <tr>
371             <td>Highlight current line</td>
372             <td>&lt;CTRL-J&gt;</td>
373             <td>
374               <para>Highlight the current line</para>
375             </td>
376           </tr>
377           <tr>
378             <td>Line Numbers</td>
379             <td>&lt;CTRL-B&gt;</td>
380             <td>
381               <para>Display document's line numbers</para>
382             </td>
383           </tr>
384           <tr>
385             <td>Set Colors...</td>
386             <td/>
387             <td>
388               <para>Color settings for documents</para>
389             </td>
390           </tr>
391           <tr>
392             <td>Set Fonts...</td>
393             <td/>
394             <td>
395               <para>Font settings for documents</para>
396             </td>
397           </tr>
398           <tr>
399             <td>Reset default font</td>
400             <td/>
401             <td>
402               <para>Reset default font settings for documents</para>
403             </td>
404           </tr>
405         </informaltable>
406       </listitem>
407       <listitem>
408         <para>Menu Document</para>
409         <informaltable border="1">
410           <tr>
411             <td>
412               <para>Commande</para>
413             </td>
414             <td>
415               <para>Shortcut</para>
416             </td>
417             <td>
418               <para>Description</para>
419             </td>
420           </tr>
421           <tr>
422             <td>Syntax Type</td>
423             <td/>
424             <td>
425               <para>Syntax type settings (default type is Scilab)</para>
426             </td>
427           </tr>
428           <tr>
429             <td>Encoding</td>
430             <td/>
431             <td>
432               <para>Encoding settings (default type is UTF-8
433                 Encoding)
434               </para>
435             </td>
436           </tr>
437           <tr>
438             <td>Colorize</td>
439             <td/>
440             <td>
441               <para>Colorize the document</para>
442             </td>
443           </tr>
444           <tr>
445             <td>Auto Indent</td>
446             <td/>
447             <td>
448               <para>Activate the automatic indentation</para>
449             </td>
450           </tr>
451         </informaltable>
452       </listitem>
453       <listitem>
454         <para>Menu Execute</para>
455         <informaltable border="1">
456           <tr>
457             <td>
458               <para>Commande</para>
459             </td>
460             <td>
461               <para>Shortcut</para>
462             </td>
463             <td>
464               <para>Description</para>
465             </td>
466           </tr>
467           <tr>
468             <td>Load Into Scilab</td>
469             <td>&lt;CTRL-L&gt;</td>
470             <td>
471               <para>Load the entire document into the Scilab console</para>
472             </td>
473           </tr>
474           <tr>
475             <td>Evaluate Selection</td>
476             <td/>
477             <td>
478               <para>Load the selection into the Scilab console</para>
479             </td>
480           </tr>
481           <tr>
482             <td>Execute Into Scilab</td>
483             <td>&lt;CTRL-E&gt;</td>
484             <td>
485               <para>If the file exist, execute the content of the file</para>
486             </td>
487           </tr>
488         </informaltable>
489       </listitem>
490     </itemizedlist>
491   </refsection>
492   <refsection>
493     <title>Remarks</title>
494     <variablelist>
495       <varlistentry>
496         <term>Document :</term>
497         <listitem>
498           <para>The default text colorization is the Scilab's syntax
499             colorization.
500           </para>
501           <para>
502             The <literal>auto-indent</literal> mode indent a line
503             according to Scilab's syntax (after a return action).
504           </para>
505           <para/>
506         </listitem>
507       </varlistentry>
508     </variablelist>
509   </refsection>
510   <refsection>
511     <title>Examples</title>
512     <programlisting role="example"><![CDATA[ 
513 // editor without parameters
514 scinotes();
515     
516 // editor with a file name
517 scinotes('SCI/modules/time/macros/datenum.sci');
518     
519 // editor with a matrix of files name
520 scinotes(['SCI/modules/time/macros/datenum.sci','SCI/modules/time/macros/datevec.sci']);
521     
522 // editor with a file name and the line number to highlight
523 scinotes('SCI/modules/time/macros/datenum.sci', 5);
524
525 // editor with a file name and the line number to highlight
526 scinotes('SCI/modules/time/macros/datenum.sci', 8, 'datenum');
527
528 // editor with a matrix of files name and the corresponding matrix of lines to highlight
529 // the files name matrix and the lines to highlight matrix should have the same size
530 scinotes(['SCI/modules/time/macros/datenum.sci','SCI/modules/time/macros/datevec.sci'], [5,10]);
531  ]]></programlisting>
532   </refsection>
533 </refentry>