bugfix 5609 fixed - fieldnames doc

Change-Id: I14554a54eb0ef24c734d56ad093f276b51026e4a

2 files changed, 49 insertions, 29 deletions

diff --git a/scilab/modules/data_structures/help/en_US/fieldnames.xml b/scilab/modules/data_structures/help/en_US/fieldnames.xml
index b87359f..a04da09 100644
--- a/scilab/modules/data_structures/help/en_US/fieldnames.xml
+++ b/scilab/modules/data_structures/help/en_US/fieldnames.xml
@@ -2,6 +2,7 @@
 <!--
  * Scilab ( http://www.scilab.org/ ) - This file is part of Scilab
  * Copyright (C) 2006-2008 - INRIA
+ * Copyright (C) 2010 - Digiteo - Vincent LIARD
  *
  * This file must be used under the terms of the CeCILL.
  * This source file is licensed as described in the file COPYING, which
@@ -16,25 +17,25 @@
   </info>
   <refnamediv>
     <refname>fieldnames</refname>
-    <refpurpose>  returns the tlist, mlist or struct field names</refpurpose>
+    <refpurpose>get a tlist, mlist or struct fields names</refpurpose>
   </refnamediv>
   <refsynopsisdiv>
     <title>Calling Sequence</title>
-    <synopsis>f=fieldnames(x)</synopsis>
+    <synopsis>f = fieldnames(lst)</synopsis>
   </refsynopsisdiv>
   <refsection>
     <title>Parameters</title>
     <variablelist>
       <varlistentry>
-        <term>x</term>
+        <term>lst</term>
         <listitem>
-          <para>a tlist or an mlist or a struct. </para>
+          <para>A tlist, mlist or struct variable.</para>
         </listitem>
       </varlistentry>
       <varlistentry>
         <term>f</term>
         <listitem>
-          <para>column vector of strings</para>
+          <para>Strings column vector of fields names.</para>
         </listitem>
       </varlistentry>
     </variablelist>
@@ -42,18 +43,21 @@
   <refsection>
     <title>Description</title>
     <para>
-    This function  returns the tlist, mlist, cell or struct field names.</para>
+      The <literal>fieldnames</literal> function returns field names
+      of a tlist, mlist or struct. As for Scilab 5.2,
+      <literal>fieldnames</literal> doesn't work on cells.
+    </para>
   </refsection>
   <refsection>
     <title>Examples</title>
-    <programlisting role="example"><![CDATA[ 
-clear t;
-t.a=1;
-t.b=2;
-fieldnames(t)
-fieldnames(1/%s)
-fieldnames(tf2ss(1/%s))
- ]]></programlisting>
+    <programlisting role="example">
+fieldnames(tlist(['listtype', 'f1', 'f2'], [], []))
+fieldnames(mlist(['V', 'key', 'value'], ['a' 'b' ; 'c' 'd'], [1 2 ; 3 4]))
+fieldnames(struct('f1', 25, 'month', 'DEC', 'year', 2006))
+obj.x = 3;
+obj.y = 3;
+fieldnames(obj)
+    </programlisting>
   </refsection>
   <refsection>
     <title>See Also</title>
diff --git a/scilab/modules/data_structures/help/fr_FR/fieldnames.xml b/scilab/modules/data_structures/help/fr_FR/fieldnames.xml
index d0116cb..927ad82 100644
--- a/scilab/modules/data_structures/help/fr_FR/fieldnames.xml
+++ b/scilab/modules/data_structures/help/fr_FR/fieldnames.xml
@@ -1,29 +1,41 @@
 <?xml version="1.0" encoding="UTF-8"?>
+<!--
+ * Scilab ( http://www.scilab.org/ ) - This file is part of Scilab
+ * Copyright (C) 2006-2008 - INRIA
+ * Copyright (C) 2010 - Digiteo - Vincent LIARD
+ *
+ * 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:mml="http://www.w3.org/1998/Math/MathML" xmlns:db="http://docbook.org/ns/docbook" version="5.0-subset Scilab" xml:lang="fr" xml:id="fieldnames">
   <info>
     <pubdate>$LastChangedDate$</pubdate>
   </info>
   <refnamediv>
     <refname>fieldnames</refname>
-    <refpurpose>returne les noms de champs d'une tlist, d'une mlist ou d'une struct</refpurpose>
+    <refpurpose>récupère le nom des champs d'une tlist, d'une mlist ou d'une struct</refpurpose>
   </refnamediv>
   <refsynopsisdiv>
     <title>Séquence d'appel</title>
-    <synopsis>f=fieldnames(x)</synopsis>
+    <synopsis>f = fieldnames(lst)</synopsis>
   </refsynopsisdiv>
   <refsection>
     <title>Paramètres</title>
     <variablelist>
       <varlistentry>
-        <term>x  </term>
+        <term>lst</term>
         <listitem>
-          <para>une tlist,  une mlist ou une struct.</para>
+          <para>Une variable de type tlist, mlist ou struct.</para>
         </listitem>
       </varlistentry>
       <varlistentry>
         <term>f</term>
         <listitem>
-          <para>Un vecteur colonne de chaînes de caractères</para>
+          <para>Un vecteur colonne de chaînes de caractères représentant les noms des champs.</para>
         </listitem>
       </varlistentry>
     </variablelist>
@@ -31,23 +43,27 @@
   <refsection>
     <title>Description</title>
     <para>
-    returne les noms de champs d'une tlist, d'une mlist ou d'une struct.</para>
+      La fonction <literal>fieldnames</literal> retourne le nom des
+      champs d'une tlist, mlist ou struct. Dans Scilab 5.2,
+      <literal>fieldnames</literal> ne fonctionne pas sur le type
+      cell.
+    </para>
   </refsection>
   <refsection>
     <title>Exemples</title>
-    <programlisting role="example"><![CDATA[ 
-clear t;
-t.a=1;
-t.b=2;
-fieldnames(t)
-fieldnames(1/%s)
-fieldnames(tf2ss(1/%s))
- ]]></programlisting>
+    <programlisting role="example">
+fieldnames(tlist(['listtype', 'f1', 'f2'], [], []))
+fieldnames(mlist(['V', 'key', 'value'], ['a' 'b' ; 'c' 'd'], [1 2 ; 3 4]))
+fieldnames(struct('f1', 25, 'month', 'DEC', 'year', 2006))
+obj.x = 3;
+obj.y = 3;
+fieldnames(obj)
+    </programlisting>
   </refsection>
   <refsection>
     <title>Voir Aussi</title>
     <simplelist type="inline">
-     <member>
+      <member>
         <link linkend="extraction">extraction</link>
       </member>  
       <member>