archived-doc-en/reference/calendar/constants.xml

<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<appendix xml:id="calendar.constants" xmlns="http://docbook.org/ns/docbook">
 &reftitle.constants;
 &extension.constants;
 <variablelist>
  <varlistentry xml:id="constant.cal-easter-default">
   <term>
    <constant>CAL_EASTER_DEFAULT</constant>
    (<type>int</type>)
   </term>
   <listitem>
    <simpara>
     For <function>easter_days</function>: calculate Easter for years before
     1753 according to the Julian calendar, and for later years according to the
     Gregorian calendar.
    </simpara>
   </listitem>
  </varlistentry>
  <varlistentry xml:id="constant.cal-easter-roman">
   <term>
    <constant>CAL_EASTER_ROMAN</constant>
    (<type>int</type>)
   </term>
   <listitem>
    <simpara>
     For <function>easter_days</function>: calculate Easter for years before
     1583 according to the Julian calendar, and for later years according to the
     Gregorian calendar.
    </simpara>
   </listitem>
  </varlistentry>
  <varlistentry xml:id="constant.cal-easter-always-gregorian">
   <term>
    <constant>CAL_EASTER_ALWAYS_GREGORIAN</constant>
    (<type>int</type>)
   </term>
   <listitem>
    <simpara>
     For <function>easter_days</function>: calculate Easter according to the
     proleptic Gregorian calendar.
    </simpara>
   </listitem>
  </varlistentry>
  <varlistentry xml:id="constant.cal-easter-always-julian">
   <term>
    <constant>CAL_EASTER_ALWAYS_JULIAN</constant>
    (<type>int</type>)
   </term>
   <listitem>
    <simpara>
     For <function>easter_days</function>: calculate Easter according to the
     Julian calendar.
    </simpara>
   </listitem>
  </varlistentry>
  <varlistentry xml:id="constant.cal-gregorian">
   <term>
    <constant>CAL_GREGORIAN</constant>
    (<type>int</type>)
   </term>
   <listitem>
    <simpara>
     For <function>cal_days_in_month</function>,
     <function>cal_from_jd</function>, <function>cal_info</function> and
     <function>cal_to_jd</function>: use the proleptic Gregorian calendar.
    </simpara>
   </listitem>
  </varlistentry>
  <varlistentry xml:id="constant.cal-julian">
   <term>
    <constant>CAL_JULIAN</constant>
    (<type>int</type>)
   </term>
   <listitem>
    <simpara>
     For <function>cal_days_in_month</function>,
     <function>cal_from_jd</function>, <function>cal_info</function> and
     <function>cal_to_jd</function>: use the Julian calendar.
    </simpara>
   </listitem>
  </varlistentry>
  <varlistentry xml:id="constant.cal-jewish">
   <term>
    <constant>CAL_JEWISH</constant>
    (<type>int</type>)
   </term>
   <listitem>
    <simpara>
     For <function>cal_days_in_month</function>,
     <function>cal_from_jd</function>, <function>cal_info</function> and
     <function>cal_to_jd</function>: use the Jewish calendar.
    </simpara>
   </listitem>
  </varlistentry>
  <varlistentry xml:id="constant.cal-french">
   <term>
    <constant>CAL_FRENCH</constant>
    (<type>int</type>)
   </term>
   <listitem>
    <simpara>
     For <function>cal_days_in_month</function>,
     <function>cal_from_jd</function>, <function>cal_info</function> and
     <function>cal_to_jd</function>: use the French Repuclican calendar.
    </simpara>
   </listitem>
  </varlistentry>
  <varlistentry xml:id="constant.cal-num-cals">
   <term>
    <constant>CAL_NUM_CALS</constant>
    (<type>int</type>)
   </term>
   <listitem>
    <simpara>
     The number of available calendars.
    </simpara>
   </listitem>
  </varlistentry>
  <varlistentry xml:id="constant.cal-jewish-add-alafim-geresh">
   <term>
    <constant>CAL_JEWISH_ADD_ALAFIM_GERESH</constant>
    (<type>int</type>)
   </term>
   <listitem>
    <simpara>
     For <function>jdtojewish</function>: adds a geresh symbol (which resembles
     a single-quote mark) as thousands separator to the year number.
    </simpara>
   </listitem>
  </varlistentry>
  <varlistentry xml:id="constant.cal-jewish-add-alafim">
   <term>
    <constant>CAL_JEWISH_ADD_ALAFIM</constant>
    (<type>int</type>)
   </term>
   <listitem>
    <simpara>
     For <function>jdtojewish</function>: adds the word alafim as thousands
     separator to the year number.
    </simpara>
   </listitem>
  </varlistentry>
  <varlistentry xml:id="constant.cal-jewish-add-gereshayim">
   <term>
    <constant>CAL_JEWISH_ADD_GERESHAYIM</constant>
    (<type>int</type>)
   </term>
   <listitem>
    <simpara>
     For <function>jdtojewish</function>: add a gershayim symbol (which
     resembles a double-quote mark) before the final letter of the day and year numbers.
    </simpara>
   </listitem>
  </varlistentry>
  <varlistentry xml:id="constant.cal-dow-dayno">
   <term>
    <constant>CAL_DOW_DAYNO</constant>
    (<type>int</type>)
   </term>
   <listitem>
    <simpara>
     For <function>jddayofweek</function>: the day of the week as
     <type>int</type>, where <literal>0</literal> means Sunday and
     <literal>6</literal> means Saturday.
    </simpara>
   </listitem>
  </varlistentry>
  <varlistentry xml:id="constant.cal-dow-short">
   <term>
    <constant>CAL_DOW_SHORT</constant>
    (<type>int</type>)
   </term>
   <listitem>
    <simpara>
     For <function>jddayofweek</function>: the abbreviated English name of the
     day of the week.
    </simpara>
   </listitem>
  </varlistentry>
  <varlistentry xml:id="constant.cal-dow-long">
   <term>
    <constant>CAL_DOW_LONG</constant>
    (<type>int</type>)
   </term>
   <listitem>
    <simpara>
     For <function>jddayofweek</function>: the English name of the day of the
     week.
    </simpara>
   </listitem>
  </varlistentry>
  <varlistentry xml:id="constant.cal-month-gregorian-short">
   <term>
    <constant>CAL_MONTH_GREGORIAN_SHORT</constant>
    (<type>int</type>)
   </term>
   <listitem>
    <simpara>
     For <function>jdmonthname</function>: the abbreviated Gregorian month name.
    </simpara>
   </listitem>
  </varlistentry>
  <varlistentry xml:id="constant.cal-month-gregorian-long">
   <term>
    <constant>CAL_MONTH_GREGORIAN_LONG</constant>
    (<type>int</type>)
   </term>
   <listitem>
    <simpara>
     For <function>jdmonthname</function>: the Gregorian month name.
    </simpara>
   </listitem>
  </varlistentry>
  <varlistentry xml:id="constant.cal-month-julian-short">
   <term>
    <constant>CAL_MONTH_JULIAN_SHORT</constant>
    (<type>int</type>)
   </term>
   <listitem>
    <simpara>
     For <function>jdmonthname</function>: the abbreviated Julian month name.
    </simpara>
   </listitem>
  </varlistentry>
  <varlistentry xml:id="constant.cal-month-julian-long">
   <term>
    <constant>CAL_MONTH_JULIAN_LONG</constant>
    (<type>int</type>)
   </term>
   <listitem>
    <simpara>
     For <function>jdmonthname</function>: the Julian month name.
    </simpara>
   </listitem>
  </varlistentry>
  <varlistentry xml:id="constant.cal-month-jewish">
   <term>
    <constant>CAL_MONTH_JEWISH</constant>
    (<type>int</type>)
   </term>
   <listitem>
    <simpara>
     For <function>jdmonthname</function>: the Jewish month name.
    </simpara>
   </listitem>
  </varlistentry>
  <varlistentry xml:id="constant.cal-month-french">
   <term>
    <constant>CAL_MONTH_FRENCH</constant>
    (<type>int</type>)
   </term>
   <listitem>
    <simpara>
     For <function>jdmonthname</function>: the French Republican month name.
    </simpara>
   </listitem>
  </varlistentry>
 </variablelist>
</appendix>
<!-- 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
-->