jdmonthname.xml

<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<refentry xml:id="function.jdmonthname" xmlns="http://docbook.org/ns/docbook">
 <refnamediv>
  <refname>jdmonthname</refname>
  <refpurpose>Returns a month name</refpurpose>
 </refnamediv>

 <refsect1 role="description">
  &reftitle.description;
  <methodsynopsis>
   <type>string</type><methodname>jdmonthname</methodname>
   <methodparam><type>int</type><parameter>julian_day</parameter></methodparam>
   <methodparam><type>int</type><parameter>mode</parameter></methodparam>
  </methodsynopsis>
  <para>
   Returns a string containing a month name.
   <parameter>mode</parameter> tells this function which calendar to
   convert the Julian Day Count to, and what type of month names are
   to be returned.
   <table>
    <title>Calendar modes</title>
    <tgroup cols="3">
     <thead>
      <row>
       <entry>Mode</entry>
       <entry>Meaning</entry>
       <entry>Values</entry>
      </row>
     </thead>
     <tbody>
      <row>
       <entry><constant>CAL_MONTH_GREGORIAN_SHORT</constant></entry>
       <entry>Gregorian - abbreviated</entry>
       <entry>Jan, Feb, Mar, Apr, May, Jun, Jul, Aug, Sep, Oct, Nov, Dec</entry>
      </row>
      <row>
       <entry><constant>CAL_MONTH_GREGORIAN_LONG</constant></entry>
       <entry>Gregorian</entry>
       <entry>January, February, March, April, May, June, July, August, September, October, November, December</entry>
      </row>
      <row>
       <entry><constant>CAL_MONTH_JULIAN_SHORT</constant></entry>
       <entry>Julian - abbreviated</entry>
       <entry>Jan, Feb, Mar, Apr, May, Jun, Jul, Aug, Sep, Oct, Nov, Dec</entry>
      </row>
      <row>
       <entry><constant>CAL_MONTH_JULIAN_LONG</constant></entry>
       <entry>Julian</entry>
       <entry>January, February, March, April, May, June, July, August, September, October, November, December</entry>
      </row>
      <row>
       <entry><constant>CAL_MONTH_JEWISH</constant></entry>
       <entry>Jewish</entry>
       <entry>Tishri, Heshvan, Kislev, Tevet, Shevat, AdarI, AdarII, Nisan, Iyyar, Sivan, Tammuz, Av, Elul</entry>
      </row>
      <row>
       <entry><constant>CAL_MONTH_FRENCH</constant></entry>
       <entry>French Republican</entry>
       <entry>Vendemiaire, Brumaire, Frimaire, Nivose, Pluviose, Ventose, Germinal, Floreal, Prairial, Messidor, Thermidor, Fructidor, Extra</entry>
      </row>
     </tbody>
    </tgroup>
   </table>
  </para>
 </refsect1>

 <refsect1 role="parameters">
  &reftitle.parameters;
  <para>
   <variablelist>
    <varlistentry>
     <term><parameter>jday</parameter></term>
     <listitem>
      <para>
       The Julian Day to operate on
      </para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><parameter>mode</parameter></term>
     <listitem>
      <para>
       The calendar mode (see table above).
      </para>
     </listitem>
    </varlistentry>
   </variablelist>
  </para>
 </refsect1>

 <refsect1 role="returnvalues">
  &reftitle.returnvalues;
  <para>
   The month name for the given Julian Day and <parameter>mode</parameter>.
  </para>
 </refsect1>

</refentry>
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml
sgml-omittag:t
sgml-shorttag:t
sgml-minimize-attributes:nil
sgml-always-quote-attributes:t
sgml-indent-step:1
sgml-indent-data:t
indent-tabs-mode:nil
sgml-parent-document:nil
sgml-default-dtd-file:"~/.phpdoc/manual.ced"
sgml-exposed-tags:nil
sgml-local-catalogs:nil
sgml-local-ecat-files:nil
End:
vim600: syn=xml fen fdm=syntax fdl=2 si
vim: et tw=78 syn=sgml
vi: ts=1 sw=1
-->