* Bug #12962 fixed: xinfo() documentation is not clear 37/12837/4
Simon Marchetto [Mon, 7 Oct 2013 10:22:56 +0000 (12:22 +0200)]
- message subwindow => status bar
- add example

Change-Id: I3faa2324a9dff9c9d5abd19e2585ab3440ed12bd

scilab/CHANGES_5.5.X
scilab/modules/graphics/help/en_US/text/xinfo.xml
scilab/modules/graphics/help/fr_FR/text/xinfo.xml
scilab/modules/graphics/help/ja_JP/text/xinfo.xml
scilab/modules/graphics/help/pt_BR/text/xinfo.xml

index f0a39db..cd4d129 100644 (file)
@@ -26,9 +26,11 @@ Scilab Bug Fixes
 
 * Bug #12957 fixed - splitURL and getURL were not declared as new 5.5 functions.
 
+* Bug #12962 fixed - xinfo documentation was not clear.
+
 * Bug #12963 fixed - drawaxis did not place the axis correctly.
 
-* Bug #12971 fixed - getURL() downloaded file name was wrong.
+* Bug #12971 fixed - getURL downloaded file name was wrong.
 
 * Bug #12978 fixed - exportUI returned an error when input argument was a figure handle.
 
index b147467..8b4e8ee 100644 (file)
 <refentry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xmlns:svg="http://www.w3.org/2000/svg" xmlns:mml="http://www.w3.org/1998/Math/MathML" xmlns:db="http://docbook.org/ns/docbook" xmlns:scilab="http://www.scilab.org"  xml:lang="en" xml:id="xinfo">
     <refnamediv>
         <refname>xinfo</refname>
-        <refpurpose>draw an info string in the message subwindow</refpurpose>
+        <refpurpose>Sets the text displayed in the current window status bar.</refpurpose>
     </refnamediv>
     <refsynopsisdiv>
         <title>Calling Sequence</title>
-        <synopsis>xinfo(info)</synopsis>
+        <synopsis>xinfo(text)</synopsis>
     </refsynopsisdiv>
     <refsection>
         <title>Arguments</title>
         <variablelist>
             <varlistentry>
-                <term>info</term>
+                <term>text</term>
                 <listitem>
-                    <para>string</para>
+                    <para>string displayed in the status bar</para>
                 </listitem>
             </varlistentry>
         </variablelist>
     <refsection>
         <title>Description</title>
         <para>
-            <literal>xinfo</literal> draws the string <literal>info</literal> in the message subwindow
-            of the current graphics window.
+            <literal>xinfo</literal> sets the text displayed in the status bar (panel at the bottom of windows) of the current window. It is a the equivalent of setting the <link linkend="figure_properties">info_message</link> property for the current graphic window (given by <link linkend="gcf">gcf</link>)
         </para>
     </refsection>
     <refsection>
         <title>Examples</title>
         <programlisting role="example"><![CDATA[ 
-xinfo("Info in the status bar "+string(%pi))
+f = scf(100001);
+xinfo("Figure ID: " + string(f.figure_id));
  ]]></programlisting>
     </refsection>
 </refentry>
index a731de3..9c39d83 100644 (file)
@@ -2,19 +2,19 @@
 <refentry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xmlns:svg="http://www.w3.org/2000/svg" xmlns:mml="http://www.w3.org/1998/Math/MathML" xmlns:db="http://docbook.org/ns/docbook" xmlns:scilab="http://www.scilab.org" xml:lang="fr" xml:id="xinfo">
     <refnamediv>
         <refname>xinfo</refname>
-        <refpurpose>affiche une chaîne de caractères dans la sous-fenêtre de messages  </refpurpose>
+        <refpurpose>Change le texte affiché dans la barre d'état de la fenêtre courante</refpurpose>
     </refnamediv>
     <refsynopsisdiv>
         <title>Séquence d'appel</title>
-        <synopsis>xinfo(info)</synopsis>
+        <synopsis>xinfo(texte)</synopsis>
     </refsynopsisdiv>
     <refsection>
         <title>Paramètres</title>
         <variablelist>
             <varlistentry>
-                <term>info  </term>
+                <term>texte</term>
                 <listitem>
-                    <para>chaîne de caractères
+                    <para>chaîne de caractères affichée dans la barre d'état
                     </para>
                 </listitem>
             </varlistentry>
     <refsection>
         <title>Description</title>
         <para>
-            <literal>xinfo</literal> dessine la chaîne de caractères <literal>info</literal> dans la sous-fenêtre de messages de la fenêtre graphique courante.
+            <literal>xinfo</literal> change le texte qui est affiché dans la barre d'état (le panneau dans le bas des fenêtres) de la fenêtre courante. Cette fonction est l'équivalent de modifier la propriété <link linkend="figure_properties">info_message</link> de la fenêtre graphique courante (donné par <link linkend="gcf">gcf</link>).
         </para>
     </refsection>
+    <refsection>
+      <title>Exemples</title>
+        <programlisting role="example"><![CDATA[
+f = scf(100001);
+xinfo("ID figure : " + string(f.figure_id));
+     ]]></programlisting>
+    </refsection>
 </refentry>
index b2c1339..b31acd0 100644 (file)
     </refnamediv>
     <refsynopsisdiv>
         <title>呼び出し手順</title>
-        <synopsis>xinfo(info)</synopsis>
+        <synopsis>xinfo(text)</synopsis>
     </refsynopsisdiv>
     <refsection>
         <title>パラメータ</title>
         <variablelist>
             <varlistentry>
-                <term>info</term>
+                <term>text</term>
                 <listitem>
                     <para>文字列</para>
                 </listitem>
     <refsection>
         <title>説明</title>
         <para>
-            <literal>xinfo</literal> は文字列d <literal>info</literal> をカレントの
+            <literal>xinfo</literal> は文字列d <literal>text</literal> をカレントの
             グラフィックウインドウのメッセージサブウインドウに描画します.
         </para>
     </refsection>
+    <refsection>
+      <title>例</title>
+        <programlisting role="example"><![CDATA[
+f = scf(100001);
+xinfo("ID figure : " + string(f.figure_id));
+     ]]></programlisting>
+    </refsection>
 </refentry>
index 7350862..ae8be51 100644 (file)
 <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="xinfo" xml:lang="en">
     <refnamediv>
         <refname>xinfo</refname>
-        <refpurpose>escreve um string de informação na subjanela de
-            mensagens
+        <refpurpose>Define o texto exibido na barra de status da atual janela.
         </refpurpose>
     </refnamediv>
     <refsynopsisdiv>
         <title>Seqüência de Chamamento</title>
-        <synopsis>xinfo(info)</synopsis>
+        <synopsis>xinfo(texto)</synopsis>
     </refsynopsisdiv>
     <refsection>
         <title>Parâmetros</title>
         <variablelist>
             <varlistentry>
-                <term>info</term>
+                <term>texto</term>
                 <listitem>
-                    <para>string</para>
+                    <para>cadeia de caracteres exibida na barra de status</para>
                 </listitem>
             </varlistentry>
         </variablelist>
     <refsection>
         <title>Descrição</title>
         <para>
-            <literal>xinfo</literal> escreve o string <literal>info</literal> na
-            subjanela de mensagens da janela de gráficos corrente.
+            <literal>xinfo</literal> define o texto exhibido na barra de status (painel na parte inferior das janelas) da atual janela.
         </para>
     </refsection>
+    <refsection>
+      <title>Exemples</title>
+        <programlisting role="example"><![CDATA[
+f = scf(100001);
+xinfo("ID figure : " + string(f.figure_id));
+     ]]></programlisting>
+    </refsection>
 </refentry>