juliantojd.xml

<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<refentry xml:id="function.juliantojd" xmlns="http://docbook.org/ns/docbook">
 <refnamediv>
  <refname>JulianToJD</refname> 
  <refpurpose>Converts a Julian Calendar date to Julian Day Count</refpurpose>
 </refnamediv>
 <refsect1 role="description">
  &reftitle.description;
  <methodsynopsis>
   <type>int</type><methodname>juliantojd</methodname>
   <methodparam><type>int</type><parameter>month</parameter></methodparam>
   <methodparam><type>int</type><parameter>day</parameter></methodparam>
   <methodparam><type>int</type><parameter>year</parameter></methodparam>
  </methodsynopsis>
  <para>
   Valid Range for Julian Calendar 4713 B.C. to 9999 A.D.
  </para>
  <para>
   Although this function can handle dates all the way back to 4713
   B.C., such use may not be meaningful. The calendar was created in
   46 B.C., but the details did not stabilize until at least 8 A.D.,
   and perhaps as late at the 4th century. Also, the beginning of a
   year varied from one culture to another - not all accepted
   January as the first month.
  </para>
  <caution>
   <para>
    Remember, the current calendar system being used worldwide is the
    Gregorian calendar.  <function>gregoriantojd</function> can be used to
    convert such dates to their Julian Day count.
   </para>
  </caution>
 </refsect1>

 <refsect1 role="parameters">
  &reftitle.parameters;
  <para>
   <variablelist>
    <varlistentry>
     <term><parameter>month</parameter></term>
     <listitem>
      <para>
       The month as a number from 1 (for January) to 12 (for December)
      </para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><parameter>day</parameter></term>
     <listitem>
      <para>
       The day as a number from 1 to 31
      </para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><parameter>year</parameter></term>
     <listitem>
      <para>
       The year as a number between -4713 and 9999
      </para>
     </listitem>
    </varlistentry>  
   </variablelist>
  </para>
 </refsect1>

 <refsect1 role="returnvalues">
  &reftitle.returnvalues;
  <para>
   The julian day for the given julian date as an integer.
  </para>
 </refsect1>

 <refsect1 role="seealso">
  &reftitle.seealso;
  <para>
   <simplelist>
    <member><function>jdtojulian</function></member> 
    <member><function>cal_to_jd</function></member>
   </simplelist>
  </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
-->