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