Revert f56158b2 "[doc] string pages improved" for specific files where
[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  * Copyright (C) 2012 - 2016 - Scilab Enterprises
7  *
8  * This file is hereby licensed under the terms of the GNU GPL v2.0,
9  * pursuant to article 5.3.4 of the CeCILL v.2.1.
10  * This file was originally licensed under the terms of the CeCILL v2.1,
11  * and continues to be available under such terms.
12  * For more information, see the COPYING file which you should have received
13  * along with this program.
14     *
15     -->
16 <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">
17     <refnamediv>
18         <refname>asciimat</refname>
19         <refpurpose>string matrix ASCII conversions</refpurpose>
20     </refnamediv>
21     <refsynopsisdiv>
22         <title>Syntax</title>
23         <synopsis>
24             a = asciimat(txt)
25             txt = asciimat(a)
26         </synopsis>
27     </refsynopsisdiv>
28     <refsection>
29         <title>Arguments</title>
30         <variablelist>
31             <varlistentry>
32                 <term>txt</term>
33                 <listitem>
34                     <para>
35                         a character string or matrix of strings.
36                     </para>
37                 </listitem>
38             </varlistentry>
39             <varlistentry>
40                 <term>a</term>
41                 <listitem>
42                     <para>
43                         a vector or matrix of integer ASCII codes.
44                     </para>
45                 </listitem>
46             </varlistentry>
47         </variablelist>
48     </refsection>
49     <refsection>
50         <title>Description</title>
51         <para>
52             This function converts Scilab string to ASCII code or a
53             matrix of ASCII code to Scilab string. Output is a matrix
54             having the same number of rows than input, what is not the
55             case with <function>ascii</function>.
56         </para>
57     </refsection>
58     <refsection role="see also">
59         <title>See also</title>
60         <simplelist type="inline">
61             <member>
62                 <link linkend="ascii">ascii</link>
63             </member>
64         </simplelist>
65     </refsection>
66 </refentry>