[doc] misc. fix & improvements
[scilab.git] / scilab / modules / time / help / en_US / calendar.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  * Copyright (C) 2012 - 2016 - Scilab Enterprises
6  * Copyright (C) 2019 - Samuel GOUGEON
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"
17           xmlns:svg="http://www.w3.org/2000/svg" xmlns:mml="http://www.w3.org/1998/Math/MathML"
18           xmlns:db="http://docbook.org/ns/docbook" xmlns:scilab="http://www.scilab.org"
19           xml:lang="en" xml:id="calendar">
20     <refnamediv>
21         <refname>calendar</refname>
22         <refpurpose>Calendar of a given month of a given year</refpurpose>
23     </refnamediv>
24     <refsynopsisdiv>
25         <title>Syntax</title>
26         <synopsis>
27             c = calendar()
28             c = calendar(y,m)
29         </synopsis>
30     </refsynopsisdiv>
31     <refsection>
32         <title>Description</title>
33         <para>c = calendar() returns a list containing a calendar for the current month.
34               The calendar runs from Monday to Sunday.
35         </para>
36         <para>c = calendar(y,m), where y and m are integers, returns a calendar for the specified
37               month of the specified year.
38         </para>
39     </refsection>
40     <refsection>
41         <title>Examples</title>
42         <programlisting role="example"><![CDATA[
43 calendar()
44  ]]></programlisting>
45       <screen><![CDATA[
46 --> calendar
47  ans  =
48        ans(1)
49  Mar 2019
50
51        ans(2)
52     M      Tu     W      Th     F     Sat     Sun
53
54        ans(3)
55    0.    0.    0.    0.    1.    2.    3.
56    4.    5.    6.    7.    8.    9.    10.
57    11.   12.   13.   14.   15.   16.   17.
58    18.   19.   20.   21.   22.   23.   24.
59    25.   26.   27.   28.   29.   30.   31.
60    0.    0.    0.    0.    0.    0.    0.
61 ]]></screen>
62         <para/>
63         <programlisting role="example"><![CDATA[
64 c = calendar(1973, 8);
65 mprintf("\n %s\n%s\n",c(1),c(2));mprintf(strcat(emptystr(1,7)+"  %2d   ")+"\n",c(3));
66  ]]></programlisting>
67       <screen><![CDATA[
68 --> c = calendar(1973, 8);
69 --> mprintf("\n %s\n%s\n",c(1),c(2));mprintf(strcat(emptystr(1,7)+"  %2d   ")+"\n",c(3));
70
71  Aug 1973
72    M      Tu     W      Th     F     Sat     Sun
73    0      0      1      2      3      4      5
74    6      7      8      9     10     11     12
75   13     14     15     16     17     18     19
76   20     21     22     23     24     25     26
77   27     28     29     30     31      0      0
78    0      0      0      0      0      0      0
79 ]]></screen>
80     </refsection>
81     <refsection role="see also">
82         <title>See also</title>
83         <simplelist type="inline">
84             <member>
85                 <link linkend="datevec">datevec</link>
86             </member>
87             <member>
88                 <link linkend="datenum">datenum</link>
89             </member>
90         </simplelist>
91     </refsection>
92 </refentry>