Revision of help page for the asciimat function (en_US, fr_FR).
[scilab.git] / scilab / modules / string / help / en_US / asciimat.xml
1 <?xml version="1.0" encoding="UTF-8"?>
2 <!--
3     * Scilab ( http://www.scilab.org/ ) - This file is part of Scilab
4     * Copyright (C) 2004-2007 - INRIA - Vincent COUVERT
5     *
6     * This file must be used under the terms of the CeCILL.
7     * This source file is licensed as described in the file COPYING, which
8     * you should have received as part of this distribution.  The terms
9     * are also available at
10     * http://www.cecill.info/licences/Licence_CeCILL_V2-en.txt
11     *
12     -->
13 <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="asciimat">
14     <refnamediv>
15         <refname>asciimat</refname>
16         <refpurpose>string matrix ASCII conversions</refpurpose>
17     </refnamediv>
18     <refsynopsisdiv>
19         <title>Calling Sequence</title>
20         <synopsis>
21             a = asciimat(txt)
22             txt = asciimat(a)
23         </synopsis>
24     </refsynopsisdiv>
25     <refsection>
26         <title>Arguments</title>
27         <variablelist>
28             <varlistentry>
29                 <term>txt</term>
30                 <listitem>
31                     <para>
32                         a character string or matrix of strings.
33                     </para>
34                 </listitem>
35             </varlistentry>
36             <varlistentry>
37                 <term>a</term>
38                 <listitem>
39                     <para>
40                         a vector or matrix of integer ASCII codes.
41                     </para>
42                 </listitem>
43             </varlistentry>
44         </variablelist>
45     </refsection>
46     <refsection>
47         <title>Description</title>
48         <para>
49             This function converts Scilab string to ASCII code or a
50             matrix of ASCII code to Scilab string. Output is a matrix
51             having the same number of rows than input, what is not the
52             case with <function>ascii</function>.
53         </para>
54     </refsection>
55     <refsection role="see also">
56         <title>See Also</title>
57         <simplelist type="inline">
58             <member>
59                 <link linkend="ascii">ascii</link>
60             </member>
61         </simplelist>
62     </refsection>
63 </refentry>