[doc] misc. fix & improvements
[scilab.git] / scilab / modules / scinotes / help / en_US / scinotes.xml
index 6c12eba..b284de7 100644 (file)
  * along with this program.
  *
  -->
-<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">
+<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">
     <refnamediv>
         <refname>scinotes</refname>
         <refpurpose>Scinotes: Embedded Scilab text editor</refpurpose>
@@ -96,7 +99,9 @@
             they cannot be modified.
         </para>
 
-        <para>With the options 'indent', 'quote' or 'trailing', the editor will not be opened and the file(s) will be treated consequently to the actions. The actions are the following:
+        <para>
+          With the options 'indent', 'quote' or 'trailing', the editor will not be opened
+          and the file(s) will be treated consequently to the actions. The actions are the following:
             <itemizedlist>
                 <listitem>
                     <para>
             </listitem>
         </itemizedlist>
     </refsection>
-    <refsection>
+    <refsection id="scinotes_menus_shortcuts">
         <title>Menus and Shortcuts</title>
         <itemizedlist>
             <listitem>
@@ -559,22 +564,53 @@ scinotes(['SCI/modules/time/macros/datenum.sci','SCI/modules/time/macros/datevec
 
 
 f=TMPDIR + "/file_to_correct.sci";
-mputl(["a=''abcdef''                                                                   ";
+mputl(["a=''abcdef''                                    ";
        "if a==1";
        "   b=1+""abcdef''         ";
-       "                       c=2";
-       " d=3                   ";
-       "                                               if                                              ";
+       "            c=2";
+       " d=3            ";
+       "                            if                              ";
        "a=''abcdef""""""";
        "           end";
-       "                               end              "], f);
+       "                end              "], f);
 
 scinotes(f, ["indent" "trailing" "quote"]);
 
 // Show the results
-mgetl(f)
-
+write(%io(2), mgetl(f))
  ]]></programlisting>
+      <screen><![CDATA[
+--> write(%io(2),mgetl(f))
+a="abcdef"
+if a==1
+    b=1+"abcdef"
+    c=2
+    d=3
+    if
+        a="abcdef"""
+    end
+end
+]]></screen>
+    </refsection>
+    <refsection role="see also">
+        <title>See Also</title>
+        <simplelist type="inline">
+            <member>
+                <link linkend="edit">edit</link>
+            </member>
+            <member>
+                <link linkend="editvar">editvar</link>
+            </member>
+            <member>
+                <link linkend="object_editor">ged</link>
+            </member>
+            <member>
+                <link linkend="ieditor">ieditor</link>
+            </member>
+            <member>
+                <link linkend="console">console</link>
+            </member>
+        </simplelist>
     </refsection>
     <refsection>
         <title>History</title>
@@ -585,5 +621,4 @@ mgetl(f)
             </revision>
         </revhistory>
     </refsection>
-
 </refentry>