bug 4852
[scilab.git] / scilab / modules / gui / help / en_US / xgetfile.xml
index 6008474..39eb7fc 100644 (file)
@@ -1,51 +1,56 @@
-<?xml version="1.0" encoding="ISO-8859-1" standalone="no"?>
-<!DOCTYPE MAN SYSTEM "../../../../modules/helptools/help.dtd">
-<MAN>
-  <LANGUAGE>eng</LANGUAGE>
-  <TITLE>xgetfile</TITLE>
-  <TYPE>Scilab Function</TYPE>
-  <DATE>$LastChangedDate$</DATE>
-  <SHORT_DESCRIPTION name="xgetfile"> dialog to get a file path</SHORT_DESCRIPTION>
-  <CALLING_SEQUENCE>
-    <CALLING_SEQUENCE_ITEM>path=xgetfile([title='string'])  </CALLING_SEQUENCE_ITEM>
-    <CALLING_SEQUENCE_ITEM>path=xgetfile(file_mask,[title='string'])  </CALLING_SEQUENCE_ITEM>
-    <CALLING_SEQUENCE_ITEM>path=xgetfile(file_mask,dir,[title='string'])  </CALLING_SEQUENCE_ITEM>
-    <CALLING_SEQUENCE_ITEM>path=xgetfile(file_mask,dir,'string')  </CALLING_SEQUENCE_ITEM>
-  </CALLING_SEQUENCE>
-  <PARAM>
-    <PARAM_INDENT>
-      <PARAM_ITEM>
-        <PARAM_NAME>file_mask</PARAM_NAME>
-        <PARAM_DESCRIPTION>
-          <SP>: a character string which gives the file mask to use for file selection. <VERB>file_mask</VERB> is written with Unix convention. the default value is '*'.</SP>
-        </PARAM_DESCRIPTION>
-      </PARAM_ITEM>
-      <PARAM_ITEM>
-        <PARAM_NAME>dir</PARAM_NAME>
-        <PARAM_DESCRIPTION>
-          <SP>: a character string which gives the initial directory used for file search. by default xgetfile uses the previously selected directory.</SP>
-        </PARAM_DESCRIPTION>
-      </PARAM_ITEM>
-      <PARAM_ITEM>
-        <PARAM_NAME>path</PARAM_NAME>
-        <PARAM_DESCRIPTION>
-          <SP>: is the user selected file path if user answers &quot;Ok&quot; or the &quot; &quot; string if user answers &quot;Cancel&quot;</SP>
-        </PARAM_DESCRIPTION>
-      </PARAM_ITEM>
-      <PARAM_ITEM>
-        <PARAM_NAME>title='string'  </PARAM_NAME>
-        <PARAM_DESCRIPTION>
-          <SP>:Optional arguments which gives the title for the xgetfile window.</SP>
-        </PARAM_DESCRIPTION>
-      </PARAM_ITEM>
-    </PARAM_INDENT>
-  </PARAM>
-  <DESCRIPTION>
-    <P>
-    Creates a dialog window for file selection</P>
-  </DESCRIPTION>
-  <EXAMPLE>
-<![CDATA[
+<?xml version="1.0" encoding="UTF-8"?>
+<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="en" xml:id="xgetfile">
+  <info>
+    <pubdate>$LastChangedDate$</pubdate>
+  </info>
+  <refnamediv>
+    <refname>xgetfile</refname>
+    <refpurpose> dialog to get a file path</refpurpose>
+  </refnamediv>
+  <refsynopsisdiv>
+    <title>Calling Sequence</title>
+    <synopsis>path=xgetfile([title='string'])
+path=xgetfile(file_mask,[title='string'])
+path=xgetfile(file_mask,dir,[title='string'])
+path=xgetfile(file_mask,dir,'string')</synopsis>
+  </refsynopsisdiv>
+  <refsection>
+    <title>Parameters</title>
+    <variablelist>
+      <varlistentry>
+        <term>file_mask</term>
+        <listitem>
+          <para>a character string which gives the file mask to use for file selection. <literal>file_mask</literal> is written with Unix convention. the default value is '*'.</para>
+        </listitem>
+      </varlistentry>
+      <varlistentry>
+        <term>dir</term>
+        <listitem>
+          <para>a character string which gives the initial directory used for file search. by default xgetfile uses the previously selected directory.</para>
+        </listitem>
+      </varlistentry>
+      <varlistentry>
+        <term>path</term>
+        <listitem>
+          <para>is the user selected file path if user answers "Ok" or the " " string if user answers "Cancel"</para>
+        </listitem>
+      </varlistentry>
+      <varlistentry>
+        <term>title='string'  </term>
+        <listitem>
+          <para>:Optional arguments which gives the title for the xgetfile window.</para>
+        </listitem>
+      </varlistentry>
+    </variablelist>
+  </refsection>
+  <refsection>
+    <title>Description</title>
+    <para>
+    Creates a dialog window for file selection</para>
+  </refsection>
+  <refsection>
+    <title>Examples</title>
+    <programlisting role="example"><![CDATA[ 
 xgetfile()
 xgetfile(title="Choose a file name")
 xgetfile("*.sci")
@@ -53,29 +58,32 @@ xgetfile("*.sci", title="Choose a file name")
 xgetfile("*.sci", "SCI/modules/gui/macros/")
 xgetfile("*.sci", "SCI/modules/gui/macros/", title="Choose a file name")
 xgetfile("*.sci", "SCI/modules/gui/macros/", "Choose a file name")
- ]]>
-  </EXAMPLE>
-  <SEE_ALSO>
-    <SEE_ALSO_ITEM>
-      <LINK>uigetdir</LINK>
-    </SEE_ALSO_ITEM>
-    <SEE_ALSO_ITEM>
-      <LINK>x_dialog</LINK>
-    </SEE_ALSO_ITEM>
-    <SEE_ALSO_ITEM>
-      <LINK>file</LINK>
-    </SEE_ALSO_ITEM>
-    <SEE_ALSO_ITEM>
-      <LINK>read</LINK>
-    </SEE_ALSO_ITEM>
-    <SEE_ALSO_ITEM>
-      <LINK>write</LINK>
-    </SEE_ALSO_ITEM>
-    <SEE_ALSO_ITEM>
-      <LINK>exec</LINK>
-    </SEE_ALSO_ITEM>
-    <SEE_ALSO_ITEM>
-      <LINK>getf</LINK>
-    </SEE_ALSO_ITEM>
-  </SEE_ALSO>
-</MAN>
+ ]]></programlisting>
+  </refsection>
+  <refsection>
+    <title>See Also</title>
+    <simplelist type="inline">
+      <member>
+        <link linkend="uigetdir">uigetdir</link>
+      </member>
+      <member>
+        <link linkend="x_dialog">x_dialog</link>
+      </member>
+      <member>
+        <link linkend="file">file</link>
+      </member>
+      <member>
+        <link linkend="read">read</link>
+      </member>
+      <member>
+        <link linkend="write">write</link>
+      </member>
+      <member>
+        <link linkend="exec">exec</link>
+      </member>
+      <member>
+        <link linkend="getf">getf</link>
+      </member>
+    </simplelist>
+  </refsection>
+</refentry>