[armedbear-cvs] r13331 - trunk/abcl/doc/manual

[mevenson at common-lisp.net]

Author: mevenson
Date: Wed Jun 15 11:17:12 2011
New Revision: 13331

Log:
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.

Added:
   trunk/abcl/doc/manual/
   trunk/abcl/doc/manual/abcl.tex

Added: trunk/abcl/doc/manual/abcl.tex
==============================================================================
--- /dev/null	00:00:00 1970	(empty, because file is newly added)
+++ trunk/abcl/doc/manual/abcl.tex	Wed Jun 15 11:17:12 2011	(r13331)
@@ -0,0 +1,73 @@
+\documentclass[10pt]{article}
+
+\usepackage{color,hyperref}
+\definecolor{darkblue}{rgb}{0.0,0.0,0.3}
+\hypersetup{colorlinks,breaklinks,
+            linkcolor=darkblue,urlcolor=darkblue,
+            anchorcolor=darkblue,citecolor=darkblue}
+
+\usepackage{a4wide}
+
+\begin{document}
+\title{A Manual for Armed Bear Common Lisp}
+\date{June 15, 2011}
+\author{Mark Evenson, Erik Huelsmann, Alessio Stallo, Ville Voutilainen}
+
+\section{Introduction}
+\subsection{Version}
+
+This manual corresponds to abcl-0.26.0, as yet unreleased.
+
+\section{Obtaining}
+
+\subsection{Requirements}
+
+java-1.5.xx, java-1.6.0_10+ recommended.
+
+\subsection{Building from Source}
+% TODO repeat install 
+
+\subsection{Contributing}
+
+\section{Interaction with host JVM}
+
+% describe calling Java from Lisp, and calling Lisp from Java,
+% probably in two separate sections.  Presumably, we can partition our
+% audience into those who are more comfortable with Java, and those
+% that are more comforable with Lisp
+
+\subsection{Lisp to Java}
+
+\subsection{Lisp from Java}
+
+\subsection{JAVA}
+
+% include autogen docs for the JAVA package.
+
+\section{ANSI Common Lisp Conformance}
+
+ABCL is currently a non-conforming ANSI Common Lisp implementation due
+to the following (known) issues:
+
+\begin{itemize}
+  \item Lack of long form of DEFINE-METHOD-COMBINATION
+  \item Missing statement of conformance in accompanying documentation
+  \item Incomplete MOP 
+    % TODO go through AMOP with symbols, starting by looking for
+    % matching function signature.
+\end{itemize}
+
+ABCL aims to be be a fully conforming ANSI Common Lisp
+implementation.  Any other behavior should be reported as a bug.
+
+\section{Extensions}
+
+% TODO document the EXTENSIONS package.
+
+\section{Multithreading}
+
+% TODO document the THREADS package.
+
+\section{History}
+
+\end{document}