6a2facad1a1452f1856f51b23e3dcff77f671b3b
[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>a=asciimat(txt)
21             txt=asciimat(a)
22         </synopsis>
23     </refsynopsisdiv>
24     <refsection>
25         <title>Arguments</title>
26         <variablelist>
27             <varlistentry>
28                 <term>txt</term>
29                 <listitem>
30                     <para>character string or matrix of strings.</para>
31                 </listitem>
32             </varlistentry>
33             <varlistentry>
34                 <term>a</term>
35                 <listitem>
36                     <para>vector or matrix of integer ASCII codes</para>
37                 </listitem>
38             </varlistentry>
39         </variablelist>
40     </refsection>
41     <refsection>
42         <title>Description</title>
43         <para>
44             This function convert Scilab string to ASCII code or a matrix of ASCII code to Scilab string.
45             Output is a matrix having same number of lines than input, what is not the case with <literal>ascii</literal>.
46         </para>
47     </refsection>
48     <refsection role="see also">
49         <title>See Also</title>
50         <simplelist type="inline">
51             <member>
52                 <link linkend="ascii">ascii</link>
53             </member>
54         </simplelist>
55     </refsection>
56 </refentry>