*Bug #10818 fixed - home, %e, %s, %z, %t and %f help pages have been added. 28/11428/2
Adeline CARNIS [Tue, 30 Apr 2013 10:36:16 +0000 (12:36 +0200)]
Change-Id: I8621c39a0be79228a87a7ed85f3d49646a33439b

scilab/CHANGES_5.5.X
scilab/modules/core/help/en_US/variables/predefined/home.xml [new file with mode: 0644]
scilab/modules/core/help/en_US/variables/predefined/percente.xml [new file with mode: 0644]
scilab/modules/core/help/en_US/variables/predefined/percentf.xml [new file with mode: 0644]
scilab/modules/core/help/en_US/variables/predefined/percents.xml [new file with mode: 0644]
scilab/modules/core/help/en_US/variables/predefined/percentt.xml [new file with mode: 0644]
scilab/modules/core/help/en_US/variables/predefined/percentz.xml [new file with mode: 0644]

index 2435e9d..a091a8b 100644 (file)
@@ -172,6 +172,8 @@ Bug fixes
 
 * Bug #10226 fixed - When a // <empty session> line is delete, all sessions
                      histories are folded.
+                     
+* Bug #10818 fixed - The following help pages have been added: hom, %e, %t, %f, %z and %s.
 
 * Bug #11308 fixed - Calling sequences in help page of dsearch were wrong.
 
diff --git a/scilab/modules/core/help/en_US/variables/predefined/home.xml b/scilab/modules/core/help/en_US/variables/predefined/home.xml
new file mode 100644 (file)
index 0000000..c098441
--- /dev/null
@@ -0,0 +1,49 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<!--
+ * Scilab ( http://www.scilab.org/ ) - This file is part of Scilab
+ * Copyright (C) 2013 - Scilab Enterprises - Adeline CARNIS
+ * 
+ * This file must be used under the terms of the CeCILL.
+ * This source file is licensed as described in the file COPYING, which
+ * you should have received as part of this distribution.  The terms
+ * are also available at    
+ * http://www.cecill.info/licences/Licence_CeCILL_V2-en.txt
+ *
+ -->
+<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="home" xml:lang="en">
+    <refnamediv>
+        <refname>home</refname>
+        <refpurpose>Gives the user directory.</refpurpose>
+    </refnamediv>
+    <refsynopsisdiv>
+        <title>Calling Sequence</title>
+        <synopsis>home</synopsis>
+    </refsynopsisdiv>
+    <refsection>
+        <title>Description</title>
+        <para>
+            <literal>home</literal> gives the user directory.            
+        </para>
+    </refsection>
+    <refsection>
+        <title>Example</title>
+        <programlisting role="example">
+            <![CDATA[ 
+        home
+        ls(home)
+        cd(home)
+        ]]>
+        </programlisting>
+    </refsection>
+    <refsection role="see also">
+        <title>See Also</title>
+        <simplelist type="inline">
+            <member>
+                <link linkend="SCIHOME">SCIHOME</link>
+            </member>
+            <member>
+                <link linkend="SCI">SCI</link>
+            </member>
+        </simplelist>
+    </refsection>
+</refentry>
diff --git a/scilab/modules/core/help/en_US/variables/predefined/percente.xml b/scilab/modules/core/help/en_US/variables/predefined/percente.xml
new file mode 100644 (file)
index 0000000..1d5c7ce
--- /dev/null
@@ -0,0 +1,55 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<!--
+ * Scilab ( http://www.scilab.org/ ) - This file is part of Scilab
+ * Copyright (C) 2013 - Scilab Enterprises - Adeline CARNIS
+ * 
+ * This file must be used under the terms of the CeCILL.
+ * This source file is licensed as described in the file COPYING, which
+ * you should have received as part of this distribution.  The terms
+ * are also available at    
+ * http://www.cecill.info/licences/Licence_CeCILL_V2-en.txt
+ *
+ -->
+<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="percente" xml:lang="en">
+    <refnamediv>
+        <refname>%e</refname>
+        <refpurpose>Euler number.</refpurpose>
+    </refnamediv>
+    <refsynopsisdiv>
+        <title>Calling Sequence</title>
+        <synopsis>%e</synopsis>
+    </refsynopsisdiv>
+    <refsection>
+        <title>Description</title>
+        <para>
+            <literal>%e</literal> is the Euler number, solution of the equation <latex>\[ln(x) = 1\]</latex>.
+        </para>
+        <para>
+            This number can be found with 
+            <latex>
+                \sum_{n=0}^{\infty} \frac1{n!} = e
+            </latex>
+            .
+        </para>
+    </refsection>
+    <refsection>
+        <title>Example</title>
+        <programlisting role="example">
+            <![CDATA[ 
+        %e
+        log(%e)
+        ]]>
+        </programlisting>
+    </refsection>
+    <refsection role="see also">
+        <title>See Also</title>
+        <simplelist type="inline">
+            <member>
+                <link linkend="log">log</link>
+            </member>
+            <member>
+                <link linkend="exp">exp</link>
+            </member>
+        </simplelist>
+    </refsection>
+</refentry>
diff --git a/scilab/modules/core/help/en_US/variables/predefined/percentf.xml b/scilab/modules/core/help/en_US/variables/predefined/percentf.xml
new file mode 100644 (file)
index 0000000..a351b27
--- /dev/null
@@ -0,0 +1,54 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<!--
+ * Scilab ( http://www.scilab.org/ ) - This file is part of Scilab
+ * Copyright (C) 2013 - Scilab Enterprises - Adeline CARNIS
+ * 
+ * This file must be used under the terms of the CeCILL.
+ * This source file is licensed as described in the file COPYING, which
+ * you should have received as part of this distribution.  The terms
+ * are also available at    
+ * http://www.cecill.info/licences/Licence_CeCILL_V2-en.txt
+ *
+ -->
+<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="percentf" xml:lang="en">
+    <refnamediv>
+        <refname>%f or %F</refname>
+        <refpurpose>Boolean variable for false.</refpurpose>
+    </refnamediv>
+    <refsynopsisdiv>
+        <title>Calling Sequence</title>
+        <synopsis>%f or %F</synopsis>
+    </refsynopsisdiv>
+    <refsection>
+        <title>Description</title>
+        <para>
+            <literal>%f</literal> or <literal>%F</literal> are boolean variables which return 
+            <literal>false</literal>.
+        </para>
+        <para>
+            When the condition is not checked, this last returns <literal>false</literal>.
+        </para>
+    </refsection>
+    <refsection>
+        <title>Example</title>
+        <programlisting role="example">
+            <![CDATA[ 
+        a = 4 > 5
+        b = 0 == 1
+        c = %t & %f
+        d = 3 ~= 3
+        ]]>
+        </programlisting>
+    </refsection>
+    <refsection role="see also">
+        <title>See Also</title>
+        <simplelist type="inline">
+            <member>
+                <link linkend="percentt">%t or %T</link>
+            </member>
+            <member>
+                <link linkend="comparison">comparison</link>
+            </member>
+        </simplelist>
+    </refsection>
+</refentry>
diff --git a/scilab/modules/core/help/en_US/variables/predefined/percents.xml b/scilab/modules/core/help/en_US/variables/predefined/percents.xml
new file mode 100644 (file)
index 0000000..984cae4
--- /dev/null
@@ -0,0 +1,58 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<!--
+ * Scilab ( http://www.scilab.org/ ) - This file is part of Scilab
+ * Copyright (C) 2013 - Scilab Enterprises - Adeline CARNIS
+ * 
+ * This file must be used under the terms of the CeCILL.
+ * This source file is licensed as described in the file COPYING, which
+ * you should have received as part of this distribution.  The terms
+ * are also available at    
+ * http://www.cecill.info/licences/Licence_CeCILL_V2-en.txt
+ *
+ -->
+<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="percents" xml:lang="en">
+    <refnamediv>
+        <refname>%s</refname>
+        <refpurpose>A variable used to define polynomials.</refpurpose>
+    </refnamediv>
+    <refsynopsisdiv>
+        <title>Calling Sequence</title>
+        <synopsis>%s</synopsis>
+    </refsynopsisdiv>
+    <refsection>
+        <title>Description</title>
+        <para>
+            <literal>%s</literal> is the polynomial in the real cases by default, <literal>s = poly(0, "s")</literal>. 
+            This variable is used to create polynomials.            
+        </para>
+    </refsection>
+    <refsection>
+        <title>Example</title>
+        <programlisting role="example">
+            <![CDATA[ 
+        p = %s^2 + 2 * %s +1
+        roots(p)
+        coeff(p)
+        
+        s = poly(0, "s");
+        p1 = s^2 + 2*s +1
+        roots(p1)
+        coeff(p1)
+        ]]>
+        </programlisting>
+    </refsection>
+    <refsection role="see also">
+        <title>See Also</title>
+        <simplelist type="inline">
+            <member>
+                <link linkend="poly">poly</link>
+            </member>
+            <member>
+                <link linkend="coeff">coeff</link>
+            </member>
+            <member>
+                <link linkend="roots">roots</link>
+            </member>
+        </simplelist>
+    </refsection>
+</refentry>
diff --git a/scilab/modules/core/help/en_US/variables/predefined/percentt.xml b/scilab/modules/core/help/en_US/variables/predefined/percentt.xml
new file mode 100644 (file)
index 0000000..3c35a1d
--- /dev/null
@@ -0,0 +1,54 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<!--
+ * Scilab ( http://www.scilab.org/ ) - This file is part of Scilab
+ * Copyright (C) 2013 - Scilab Enterprises - Adeline CARNIS
+ * 
+ * This file must be used under the terms of the CeCILL.
+ * This source file is licensed as described in the file COPYING, which
+ * you should have received as part of this distribution.  The terms
+ * are also available at    
+ * http://www.cecill.info/licences/Licence_CeCILL_V2-en.txt
+ *
+ -->
+<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="percentt" xml:lang="en">
+    <refnamediv>
+        <refname>%t or %T</refname>
+        <refpurpose>Boolean variable for true.</refpurpose>
+    </refnamediv>
+    <refsynopsisdiv>
+        <title>Calling Sequence</title>
+        <synopsis>%t or %T</synopsis>
+    </refsynopsisdiv>
+    <refsection>
+        <title>Description</title>
+        <para>
+            <literal>%t</literal> or <literal>%T</literal> are boolean variables which return 
+            <literal>true</literal>.
+        </para>
+        <para>
+            When the condition is checked, this last returns <literal>true</literal>.
+        </para>
+    </refsection>
+    <refsection>
+        <title>Example</title>
+        <programlisting role="example">
+            <![CDATA[ 
+        a = 4 < 5
+        b = 0 <> 1
+        c = %t | %f
+        d = (1:5) == 3
+        ]]>
+        </programlisting>
+    </refsection>
+    <refsection role="see also">
+        <title>See Also</title>
+        <simplelist type="inline">
+            <member>
+                <link linkend="percentf">%f or %F</link>
+            </member>
+            <member>
+                <link linkend="comparison">comparison</link>
+            </member>
+        </simplelist>
+    </refsection>
+</refentry>
diff --git a/scilab/modules/core/help/en_US/variables/predefined/percentz.xml b/scilab/modules/core/help/en_US/variables/predefined/percentz.xml
new file mode 100644 (file)
index 0000000..5a46516
--- /dev/null
@@ -0,0 +1,58 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<!--
+ * Scilab ( http://www.scilab.org/ ) - This file is part of Scilab
+ * Copyright (C) 2013 - Scilab Enterprises - Adeline CARNIS
+ * 
+ * This file must be used under the terms of the CeCILL.
+ * This source file is licensed as described in the file COPYING, which
+ * you should have received as part of this distribution.  The terms
+ * are also available at    
+ * http://www.cecill.info/licences/Licence_CeCILL_V2-en.txt
+ *
+ -->
+<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="percentz" xml:lang="en">
+    <refnamediv>
+        <refname>%z</refname>
+        <refpurpose>A variable used to define polynomials.</refpurpose>
+    </refnamediv>
+    <refsynopsisdiv>
+        <title>Calling Sequence</title>
+        <synopsis>%z</synopsis>
+    </refsynopsisdiv>
+    <refsection>
+        <title>Description</title>
+        <para>
+            <literal>%z</literal> is the polynomial in the complex cases by default, <literal>z = poly(0, "z")</literal>. 
+            This variable is used to create polynomials.            
+        </para>
+    </refsection>
+    <refsection>
+        <title>Example</title>
+        <programlisting role="example">
+            <![CDATA[ 
+        p = %z^2 + 2 * %i *%z -1
+        roots(p)
+        coeff(p)
+        
+        z = poly(0, "z");
+        p1 = z^2 + 2*%i*z -1
+        roots(p1)
+        coeff(p1)
+        ]]>
+        </programlisting>
+    </refsection>
+    <refsection role="see also">
+        <title>See Also</title>
+        <simplelist type="inline">
+            <member>
+                <link linkend="poly">poly</link>
+            </member>
+            <member>
+                <link linkend="coeff">coeff</link>
+            </member>
+            <member>
+                <link linkend="roots">roots</link>
+            </member>
+        </simplelist>
+    </refsection>
+</refentry>