← Back to branch summary

~ubuntu-branches/ubuntu/raring/scilab/raring-proposed

« back to all changes in this revision

Viewing changes to modules/time/help/en_US/weekday.xml

  • Committer: Package Import Robot
  • Author(s): Sylvestre Ledru
  • Date: 2012-08-30 14:42:38 UTC
  • mfrom: (1.4.7)
  • Revision ID: package-import@ubuntu.com-20120830144238-c1y2og7dbm7m9nig
Tags: 5.4.0-beta-3-1~exp1
* New upstream release
* Update the scirenderer dep
* Get ride of libjhdf5-java dependency

Show diffs side-by-side

added added

removed removed

Lines of Context:
modules/time/help/en_US/weekday.xml
11
11
 *
12
12
 -->
13
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" version="5.0-subset Scilab" xml:lang="en" xml:id="weekday">
14
 
  <refnamediv>
15
 
    <refname>weekday</refname>
16
 
    <refpurpose>Return day of week</refpurpose>
17
 
  </refnamediv>
18
 
  <refsynopsisdiv>
19
 
    <title>Calling Sequence</title>
20
 
    <synopsis>[N,S] = weekday(D)
21
 
      [N,S] = weekday(D, form)
22
 
    </synopsis>
23
 
  </refsynopsisdiv>
24
 
  <refsection>
25
 
    <title>Description</title>
26
 
    <para>[N,S] = weekday(D) returns the day of the week in numeric(N) and string(S) form for a given serial date number or date string D. Input argument D can represent more than one date in an array of serial date number.</para>
27
 
    <para>[N,S] = weekday(D, form) returns the week in numeric(N) and string(S) form, where the content of S depends on the form argument. If form is 'long', then S countains the full name of the weekday (e.g, Thuesday). If form is 'short', then S contains an abbreviated name (e.g., Tue) from this table.</para>
28
 
  </refsection>
29
 
  <refsection>
30
 
    <title>Examples</title>
31
 
    <programlisting role="example"><![CDATA[ 
 
14
    <refnamediv>
 
15
        <refname>weekday</refname>
 
16
        <refpurpose>Return day of week</refpurpose>
 
17
    </refnamediv>
 
18
    <refsynopsisdiv>
 
19
        <title>Calling Sequence</title>
 
20
        <synopsis>[N,S] = weekday(D)
 
21
            [N,S] = weekday(D, form)
 
22
        </synopsis>
 
23
    </refsynopsisdiv>
 
24
    <refsection>
 
25
        <title>Description</title>
 
26
        <para>[N,S] = weekday(D) returns the day of the week in numeric(N) and string(S) form for a given serial date number or date string D. Input argument D can represent more than one date in an array of serial date number.</para>
 
27
        <para>[N,S] = weekday(D, form) returns the week in numeric(N) and string(S) form, where the content of S depends on the form argument. If form is 'long', then S countains the full name of the weekday (e.g, Thuesday). If form is 'short', then S contains an abbreviated name (e.g., Tue) from this table.</para>
 
28
    </refsection>
 
29
    <refsection>
 
30
        <title>Examples</title>
 
31
        <programlisting role="example"><![CDATA[ 
32
32
today = datenum();
33
33
[N,S] = weekday(today)
34
34
[N,S] = weekday(today,'short')
35
35
[N,S] = weekday(today,'long')
36
36
 ]]></programlisting>
37
 
  </refsection>
38
 
  <refsection role="see also">
39
 
    <title>See Also</title>
40
 
    <simplelist type="inline">
41
 
      <member>
42
 
        <link linkend="datenum">datenum</link>
43
 
      </member>
44
 
      <member>
45
 
        <link linkend="datevec">datevec</link>
46
 
      </member>
47
 
      <member>
48
 
        <link linkend="weekday">weekday</link>
49
 
      </member>
50
 
    </simplelist>
51
 
  </refsection>
 
37
    </refsection>
 
38
    <refsection role="see also">
 
39
        <title>See Also</title>
 
40
        <simplelist type="inline">
 
41
            <member>
 
42
                <link linkend="datenum">datenum</link>
 
43
            </member>
 
44
            <member>
 
45
                <link linkend="datevec">datevec</link>
 
46
            </member>
 
47
            <member>
 
48
                <link linkend="weekday">weekday</link>
 
49
            </member>
 
50
        </simplelist>
 
51
    </refsection>
52
52
</refentry>