doc/intro.xml

   1 <?xml version="1.0" encoding="utf-8"?>
   2 <!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN"
   3 "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd" [
   4 <!ENTITY % myents SYSTEM "entities.inc">
   5 %myents;
   6 ]>
   7
   8 <chapter id="introduction">
   9   <title>Introduction</title>
  10   <sect1 id="purpose">
  11     <title>Purpose</title>
  12     <para> This reference guide describes
  13     &hyperobject;, which provides an object representation
  14     library for Common Lisp programs.
  15     </para>
  16   </sect1>
  17
  18   <sect1 id="supported_impl">
  19     <title>Supported Implementations</title>
  20     <para>The primary tested and supported platforms for &hyperobject; are:
  21     </para>
  22     <itemizedlist mark="opencircle">
  23       <listitem><para>&acl; v6.2</para></listitem>
  24       <listitem><para>&lw; v4.3</para></listitem>
  25       <listitem><para>&cmucl; 18e</para></listitem>
  26       <listitem><para>&sbcl; 0.8.5</para></listitem>
  27       <listitem><para>&scl; 1.1.1</para></listitem>
  28       <listitem><para>&openmcl; 0.14</para></listitem>
  29     </itemizedlist>
  30   </sect1>
  31
  32   <sect1 id="download">
  33     <title>Installation</title>
  34     <sect2>
  35       <title>Download</title>
  36       <para>
  37         You need to download the &hyperobject; package from its web
  38         <ulink url="http://hyperobject.b9.com/"><citetitle>home</citetitle></ulink>.
  39       Other required packages are:</para>
  40       <itemizedlist mark="opencircle">
  41         <listitem>
  42           <para>
  43             <ulink url="http://files.b9.com/kmrcl/"><citetitle>&kmrcl;</citetitle></ulink>
  44           </para>
  45         </listitem>
  46         <listitem>
  47         <para>
  48           <ulink url="http://files.b9.com/uffi/"><citetitle>&uffi;</citetitle></ulink>
  49           </para>
  50         </listitem>
  51         <listitem>
  52           <para>
  53             <ulink url="http://files.b9.com/clsql/"><citetitle>&clsql;</citetitle></ulink>
  54           </para>
  55         </listitem>
  56         <listitem>
  57           <para>
  58             &asdf; from it's home <ulink
  59             url="http://www.sourceforge.net/projects/cclan"><citetitle>CCLAN</citetitle></ulink>
  60             package. You can download the file
  61             <filename>asdf.lisp</filename> from the CVS <ulink
  62             url="http://cvs.sourceforge.net/cgi-bin/viewcvs.cgi/cclan/asdf/asdf.lisp"><citetitle>tree</citetitle></ulink>.
  63           </para>
  64         </listitem>
  65       </itemizedlist>
  66     </sect2>
  67     <sect2>
  68       <title>Loading</title>
  69       <para>
  70         After downloading and installing &asdf;, simply
  71         <function>push</function> the
  72         directories containing &hyperobject;, &kmrcl;, &uffi;, and &clsql; onto
  73         <varname>asdf:*central-registry*</varname> variable. Whenever you
  74         want to load the &hyperobject; package, use the function
  75         <computeroutput>(asdf:operate 'asdf:load-op :hyperobject)</computeroutput>.
  76       </para>
  77     </sect2>
  78   </sect1>
  79
  80 </chapter>