summaryrefslogtreecommitdiff
path: root/modules/string/help/en_US/justify.xml
blob: 9ce7e95761d399b0e1e17914da1e66713d98733a (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
<?xml version="1.0" encoding="UTF-8"?>
<!--
* Scilab ( http://www.scilab.org/ ) - This file is part of Scilab
* Copyright (C) INRIA -
*
* This file must be used under the terms of the CeCILL.
* This source file is licensed as described in the file COPYING, which
* you should have received as part of this distribution.  The terms
* are also available at
* http://www.cecill.info/licences/Licence_CeCILL_V2.1-en.txt
*
-->
<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"
        xml:lang="en" xml:id="justify">
    <refnamediv>
        <refname>justify</refname>
        <refpurpose>justify character array</refpurpose>
    </refnamediv>
    <refsynopsisdiv>
        <title>Calling Sequence</title>
        <synopsis>Tj = justify(T, opt)</synopsis>
    </refsynopsisdiv>
    <refsection>
        <title>Arguments</title>
        <variablelist>
            <varlistentry>
                <term>T</term>
                <listitem>
                    <para>a matrix of character strings.</para>
                </listitem>
            </varlistentry>
            <varlistentry>
                <term>Tj</term>
                <listitem>
                    <para>
                        a matrix of character strings. The justified result.
                    </para>
                </listitem>
            </varlistentry>
            <varlistentry>
                <term>opt</term>
                <listitem>
                    <para>
                        a character option with possible values:
                    </para>
                    <variablelist>
                        <varlistentry>
                            <term>'r' or 'right'</term>
                            <listitem>
                                <para>for right justification;</para>
                            </listitem>
                        </varlistentry>
                        <varlistentry>
                            <term>'l' or 'left'</term>
                            <listitem>
                                <para>for left justification;</para>
                            </listitem>
                        </varlistentry>
                        <varlistentry>
                            <term>'c' or 'center'</term>
                            <listitem>
                                <para>for centering justification.</para>
                            </listitem>
                        </varlistentry>
                    </variablelist>
                </listitem>
            </varlistentry>
        </variablelist>
    </refsection>
    <refsection>
        <title>Description</title>
        <para>
            The <function>justify</function> function justifies the column of a
            matrix of string according to the given option <varname>opt</varname>.
        </para>
    </refsection>
    <refsection>
        <title>Examples</title>
        <programlisting role="example"><![CDATA[
t=['1234','x','adfdfgdfghfgj'
   '1','354556','dgf'
   'sdfgd','','sdfsf'];

justify(t,'l')
justify(t,'c')
justify(t,'r')
    ]]></programlisting>
    </refsection>
    <refsection role="see also">
        <title>See Also</title>
        <simplelist type="inline">
            <member>
                <link linkend="length">length</link>
            </member>
            <member>
                <link linkend="part">part</link>
            </member>
        </simplelist>
    </refsection>
</refentry>