1 <!-- -*- DocBook -*- -->
4 <title>Introduction</title>
7 <para> This reference guide describes
8 &hyperobject;, which provides an object representation
9 library for Common Lisp programs.
14 <title>Supported Implementations</title>
15 <para>The primary tested and supported platforms for &hyperobject; are:
17 <itemizedlist mark="opencircle">
18 <listitem><para>&acl; v6.2</para></listitem>
19 <listitem><para>&lw; v4.2</para></listitem>
20 <listitem><para>&cmucl; 18d</para></listitem>
21 <listitem><para>&sbcl; 0.7.10</para></listitem>
22 <listitem><para>&scl; 1.1.1</para></listitem>
27 <title>Installation</title>
29 <title>Download</title>
31 You need to download the &hyperobject; package from its web
32 <ulink url="http://hyperobject.b9.com"><citetitle>home</citetitle></ulink>.
33 Other require packages are:</para>
34 <itemizedlist mark="opencircle">
35 <listitem><para>&kmrcl; from it's <ulink url="ftp://kmrcl.b9.com"><citetitle>home</citetitle></ulink>.</para></listitem>
36 <listitem><para>&uffi; from it's <ulink url="http://uffi.b9.com"><citetitle>home</citetitle></ulink>.</para></listitem>
37 <listitem><para>&clsql; from it's <ulink url="ftp://clsql.b9.com"><citetitle>home</citetitle></ulink>.</para></listitem>
38 <listitem><para>&asdf; from it's home <ulink url="http://www.sourceforge.net/projects/cclan"><citetitle>CCLAN</citetitle></ulink> package. You can download
39 the file <filename>asdf.lisp</filename> from the CVS
40 <ulink url="http://cvs.sourceforge.net/cgi-bin/viewcvs.cgi/cclan/asdf/asdf.lisp"><citetitle>tree</citetitle></ulink>.</para></listitem>
44 <title>Loading</title>
46 After downloading and installing &asdf;, simply
47 <function>push</function> the
48 directories containing &hyperobject;, &kmrcl;, &uffi;, and &clsql; onto
49 <varname>asdf:*central-registry*</varname> variable. Whenever you
50 want to load the &hyperobject; package, use the function
51 <computeroutput>(asdf:oos 'asdf:load-op :hyperobject)</computeroutput>.
59 <title>Overview</title>
61 &hyperobject; was designed as a cross-implementation
62 compatible <emphasis>Foreign Function Interface</emphasis>.
64 only a common subset of functionality can be
65 provided. Likewise, not every optimization for that a specific
66 implementation provides can be supported. Wherever possible,
67 though, implementation-specific optimizations are invoked.