Prefs: add a function preferences()
[scilab.git] / scilab / modules / preferences / help / en_US / prefs_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) 2012 - Scilab Enterprises - Calixte DENIZET
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="prefs_SciNotes" xml:lang="en">
14   <refnamediv>
15     <refname>SciNotes preferences</refname>
16     <refpurpose>SciNotes general preferences</refpurpose>
17   </refnamediv>
18   <refsection id="prefs_SciNotes_Editor">
19     <title>Editor</title>
20     <para>
21       <inlinemediaobject>
22         <imageobject>
23           <imagedata fileref="../images/scinotes/editor.png" width="100" depth="100" scalefit="0" align="center" valign="middle"/>
24         </imageobject>
25       </inlinemediaobject>
26     </para>
27     <para>
28       SciNotes is the default Scilab code editor. It is now possible to use an external editor using a system dependant command or a Scilab macro name.
29     </para>
30     <para>
31       <itemizedlist>
32         <listitem>
33           <para>
34             <emphasis role="bold">Use SciNotes</emphasis>: check this box if you want to use SciNotes in using commands such like editor or edit.
35           </para>
36         </listitem>
37         <listitem>
38           <para>
39             <emphasis role="bold">External editor</emphasis>: check this radio button to use an external system editor, e.g. it is possible to enter "/usr/bin/gedit".
40           </para>
41         </listitem>
42         <listitem>
43           <para>
44             <emphasis role="bold">Scilab command</emphasis>: check this radio button to use an editor which is callable via a Scilab macro. This macro should take the same kind of argument as the editor command.
45           </para>
46         </listitem>
47       </itemizedlist>
48     </para>
49   </refsection>
50   <refsection id="prefs_SciNotes_General_Settings">
51     <title>SciNotes General settings</title>
52     <para>
53       <inlinemediaobject>
54         <imageobject>
55           <imagedata fileref="../images/scinotes/scinotes_general_settings.png" width="100" depth="100" scalefit="0" align="center" valign="middle"/>
56         </imageobject>
57       </inlinemediaobject>
58     </para>
59     <para>
60       <itemizedlist>
61         <listitem>
62           <para>
63             <emphasis role="bold">Restore previous session on start-up</emphasis>: check this box to be able to restore the previous Scilab session as it was before quiting Scilab.
64           </para>
65         </listitem>
66         <listitem>
67           <para>
68             <emphasis role="bold">Add carriage return at the end of the file</emphasis>: check this box to automatically add a CR, if none, at the end of the file.
69           </para>
70         </listitem>
71         <listitem>
72           <para>
73             <emphasis role="bold">Number of recently opened files to display</emphasis>: modify this value to fix how many files must appears in the last opened section.
74           </para>
75         </listitem>
76         <listitem>
77           <para>
78             <emphasis role="bold">Default file enconding</emphasis>: fix the default encoding to use to save a file. No more encodings are proposed since Scilab handles only these ones at execution.
79           </para>
80         </listitem>
81         <listitem>
82           <para>
83             <emphasis role="bold">Default End-Of-Line</emphasis>: fix the default end-of-line chars to use when saving the file.
84           </para>
85         </listitem>
86       </itemizedlist>
87     </para>
88   </refsection>
89   <refsection role="see also">
90     <title>See Also</title>
91     <simplelist type="inline">
92       <member>
93         <link linkend="scinotes">scinotes</link>
94       </member>
95       <member>
96         <link linkend="editor">editor</link>
97       </member>
98       <member>
99         <link linkend="edit">edit</link>
100       </member>
101     </simplelist>
102   </refsection>
103 </refentry>