source: trunk/abcl/doc/manual/abcl.tex @ 13331

Last change on this file since 13331 was 13331, checked in by Mark Evenson, 10 years ago

Start outlining a manual.

We go with LaTex? for source. I want:

a) a diff-able documentaion source format
b) reasonable control over both print and online typography
c) free (libre) toolchain
d) the ability to include diagrams
e) extensible reference (and cross reference) processing

Honestly, I am not very satisfied with current mechanisms to go from
LaTeX source to online content, so I hope to improve the transformation.

File size: 1.8 KB
Line 
1\documentclass[10pt]{article}
2
3\usepackage{color,hyperref}
4\definecolor{darkblue}{rgb}{0.0,0.0,0.3}
5\hypersetup{colorlinks,breaklinks,
6            linkcolor=darkblue,urlcolor=darkblue,
7            anchorcolor=darkblue,citecolor=darkblue}
8
9\usepackage{a4wide}
10
11\begin{document}
12\title{A Manual for Armed Bear Common Lisp}
13\date{June 15, 2011}
14\author{Mark Evenson, Erik Huelsmann, Alessio Stallo, Ville Voutilainen}
15
16\section{Introduction}
17\subsection{Version}
18
19This manual corresponds to abcl-0.26.0, as yet unreleased.
20
21\section{Obtaining}
22
23\subsection{Requirements}
24
25java-1.5.xx, java-1.6.0_10+ recommended.
26
27\subsection{Building from Source}
28% TODO repeat install
29
30\subsection{Contributing}
31
32\section{Interaction with host JVM}
33
34% describe calling Java from Lisp, and calling Lisp from Java,
35% probably in two separate sections.  Presumably, we can partition our
36% audience into those who are more comfortable with Java, and those
37% that are more comforable with Lisp
38
39\subsection{Lisp to Java}
40
41\subsection{Lisp from Java}
42
43\subsection{JAVA}
44
45% include autogen docs for the JAVA package.
46
47\section{ANSI Common Lisp Conformance}
48
49ABCL is currently a non-conforming ANSI Common Lisp implementation due
50to the following (known) issues:
51
52\begin{itemize}
53  \item Lack of long form of DEFINE-METHOD-COMBINATION
54  \item Missing statement of conformance in accompanying documentation
55  \item Incomplete MOP
56    % TODO go through AMOP with symbols, starting by looking for
57    % matching function signature.
58\end{itemize}
59
60ABCL aims to be be a fully conforming ANSI Common Lisp
61implementation.  Any other behavior should be reported as a bug.
62
63\section{Extensions}
64
65% TODO document the EXTENSIONS package.
66
67\section{Multithreading}
68
69% TODO document the THREADS package.
70
71\section{History}
72
73\end{document}
Note: See TracBrowser for help on using the repository browser.