Revert f56158b2 "[doc] string pages improved" for specific files where
[scilab.git] / scilab / modules / string / help / en_US / ascii.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) INRIA -
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:ns3="http://www.w3.org/1999/xhtml" xmlns:mml="http://www.w3.org/1998/Math/MathML" xmlns:db="http://docbook.org/ns/docbook" xmlns:scilab="http://www.scilab.org" xml:id="ascii" xml:lang="en">
17     <refnamediv>
18         <refname>ascii</refname>
19         <refpurpose>string ASCII conversions</refpurpose>
20     </refnamediv>
21     <refsynopsisdiv>
22         <title>Syntax</title>
23         <synopsis>a = ascii(txt)
24             txt = ascii(a)
25         </synopsis>
26     </refsynopsisdiv>
27     <refsection>
28         <title>Arguments</title>
29         <variablelist>
30             <varlistentry>
31                 <term>txt</term>
32                 <listitem>
33                     <para>a character string or a matrix of character strings.</para>
34                 </listitem>
35             </varlistentry>
36             <varlistentry>
37                 <term>a</term>
38                 <listitem>
39                     <para>a vector of integer ASCII codes</para>
40                 </listitem>
41             </varlistentry>
42         </variablelist>
43     </refsection>
44     <refsection>
45         <title>Description</title>
46         <para>
47             This function converts Scilab string to a vector of ASCII code (the first 127
48             codes are ASCII) or vector of ASCII code to Scilab strings.
49         </para>
50         <para>
51             If <varname>txt</varname> is a matrix of string, <code>ascii(txt)</code> is
52             equivalent to <code>ascii(strcat(txt))</code>.
53         </para>
54     </refsection>
55     <refsection>
56         <title>Examples</title>
57         <programlisting role="example"><![CDATA[
58 ascii(["hello";"world"])
59 ascii("scilab")
60 ascii([115 99 105 108 97 98])
61  ]]></programlisting>
62     </refsection>
63     <refsection role="see also">
64         <title>See also</title>
65         <simplelist type="inline">
66             <member>
67                 <link linkend="asciimat">asciimat</link>
68             </member>
69         </simplelist>
70     </refsection>
71 </refentry>