File: intro.xml

package info (click to toggle)
cl-hyperobject 2.13-1
  • links: PTS, VCS
  • area: main
  • in suites: bookworm, bullseye, forky, sid, trixie
  • size: 340 kB
  • sloc: lisp: 1,843; xml: 215; makefile: 167
file content (80 lines) | stat: -rw-r--r-- 2,625 bytes parent folder | download
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
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.inc">
%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.kpe.io/"><citetitle>home</citetitle></ulink>.
      Other required packages are:</para> 
      <itemizedlist mark="opencircle">
	<listitem>
	  <para>
	    <ulink url="http://files.kpe.io/kmrcl/"><citetitle>&kmrcl;</citetitle></ulink>
	  </para>
	</listitem>
	<listitem>
	<para>
	  <ulink url="http://files.kpe.io/uffi/"><citetitle>&uffi;</citetitle></ulink>
	  </para>
	</listitem>
	<listitem>
	  <para>
	    <ulink url="http://files.kpe.io/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>