Revert f56158b2 "[doc] string pages improved" for specific files where
[scilab.git] / scilab / modules / string / help / en_US / isletter.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"
17 xmlns:xlink="http://www.w3.org/1999/xlink"
18 xmlns:svg="http://www.w3.org/2000/svg"
19 xmlns:mml="http://www.w3.org/1998/Math/MathML"
20 xmlns:db="http://docbook.org/ns/docbook"
21 xml:lang="en" xml:id="isletter">
22     <refnamediv>
23         <refname>isletter</refname>
24         <refpurpose>
25             check that characters of a string are alphabetic letters
26         </refpurpose>
27     </refnamediv>
28     <refsynopsisdiv>
29         <title>Syntax</title>
30         <synopsis>res = isletter(str)</synopsis>
31     </refsynopsisdiv>
32     <refsection>
33         <title>Arguments</title>
34         <variablelist>
35             <varlistentry>
36                 <term>str</term>
37                 <listitem>
38                     <para>a character string.</para>
39                 </listitem>
40             </varlistentry>
41             <varlistentry>
42                 <term>res</term>
43                 <listitem>
44                     <para>a boolean matrix.</para>
45                 </listitem>
46             </varlistentry>
47         </variablelist>
48     </refsection>
49     <refsection>
50         <title>Description</title>
51         <para>
52             <code>res = isletter(str)</code> returns an array the same size as
53             <varname>str</varname> containing logical <constant>%t</constant>
54             (true) where the elements of <varname>str</varname> are letters of
55             the alphabet and logical <constant>%f</constant> (false) where they
56             are not.
57         </para>
58     </refsection>
59     <refsection>
60         <title>Examples</title>
61         <programlisting role="example"><![CDATA[
62 s = 'A1,B2,C3';
63 isletter(s)
64         ]]></programlisting>
65     </refsection>
66     <refsection role="see also">
67         <title>See also</title>
68         <simplelist type="inline">
69             <member>
70                 <link linkend="isalphanum">isalphanum</link>
71             </member>
72             <member>
73                 <link linkend="isdigit">isdigit</link>
74             </member>
75         </simplelist>
76     </refsection>
77 </refentry>