r8215: fix documentation

[hyperobject.git] / doc / intro.xml

diff --git a/doc/intro.xml b/doc/intro.xml
new file mode 100644 (file)
index 0000000..e4431f7
--- /dev/null
+++ b/doc/intro.xml
@@ -0,0 +1,80 @@
+<?xml version="1.0" encoding="utf-8"?>
+<!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN"
+"http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd" [
+<!ENTITY % myents SYSTEM "entities.xml">
+%myents;
+]>
+
+<chapter id="introduction">
+  <title>Introduction</title>
+  <sect1 id="purpose">
+    <title>Purpose</title>
+    <para> This reference guide describes
+    &hyperobject;, which provides an object representation
+    library for Common Lisp programs. 
+    </para>
+  </sect1>
+
+  <sect1 id="supported_impl">
+    <title>Supported Implementations</title> 
+    <para>The primary tested and supported platforms for &hyperobject; are: 
+    </para>
+    <itemizedlist mark="opencircle">
+      <listitem><para>&acl; v6.2</para></listitem>
+      <listitem><para>&lw; v4.3</para></listitem>
+      <listitem><para>&cmucl; 18e</para></listitem>
+      <listitem><para>&sbcl; 0.8.5</para></listitem>
+      <listitem><para>&scl; 1.1.1</para></listitem>
+      <listitem><para>&openmcl; 0.14</para></listitem>
+    </itemizedlist>
+  </sect1>
+
+  <sect1 id="download">
+    <title>Installation</title>
+    <sect2>
+      <title>Download</title>
+      <para>
+       You need to download the &hyperobject; package from its web
+       <ulink url="http://hyperobject.b9.com/"><citetitle>home</citetitle></ulink>.
+      Other required packages are:</para> 
+      <itemizedlist mark="opencircle">
+       <listitem>
+         <para>
+           <ulink url="http://files.b9.com/kmrcl/"><citetitle>&kmrcl;</citetitle></ulink>
+         </para>
+       </listitem>
+       <listitem>
+       <para>
+         <ulink url="http://files.b9.com/uffi/"><citetitle>&uffi;</citetitle></ulink>
+         </para>
+       </listitem>
+       <listitem>
+         <para>
+           <ulink url="http://files.b9.com/clsql/"><citetitle>&clsql;</citetitle></ulink>
+         </para>
+       </listitem>
+       <listitem>
+         <para>
+           &asdf; from it's home <ulink
+           url="http://www.sourceforge.net/projects/cclan"><citetitle>CCLAN</citetitle></ulink>
+           package. You can download the file
+           <filename>asdf.lisp</filename> from the CVS <ulink
+           url="http://cvs.sourceforge.net/cgi-bin/viewcvs.cgi/cclan/asdf/asdf.lisp"><citetitle>tree</citetitle></ulink>.
+         </para>
+       </listitem>
+      </itemizedlist>
+    </sect2>   
+    <sect2>
+      <title>Loading</title>
+      <para>
+       After downloading and installing &asdf;, simply
+       <function>push</function> the
+       directories containing &hyperobject;, &kmrcl;, &uffi;, and &clsql; onto
+       <varname>asdf:*central-registry*</varname> variable. Whenever you
+       want to load the &hyperobject; package, use the function
+       <computeroutput>(asdf:operate 'asdf:load-op :hyperobject)</computeroutput>.
+      </para>
+    </sect2>
+  </sect1>
+  
+</chapter>