[Adonthell-commits] CVS: doc/architecture intro.tex,NONE,1.1 abstract.tex,1.1,1.2 architecture.tex,1.2,1.3 edesign.tex,1.1,1.2 overview.tex,1.2,1.3

[Kai Sterker <address@hidden>]

Update of /cvsroot/adonthell/doc/architecture
In directory subversions:/tmp/cvs-serv8372/architecture

Modified Files:
        abstract.tex architecture.tex edesign.tex overview.tex 
Added Files:
        intro.tex 
Log Message:
ADDED beginning of Adonthell Scripting Guide
ADDED distributing and obtaining information


--- NEW FILE ---
\section{Introduction}
\thispagestyle{empty}

\subsection{Abstract}
This document is a supplement to the Adonthell API documentation. It is 
intented for new programmers and everyone else interested into the general 
concepts and design of the Adonthell game engine.\\

It is not meant to be a complete reference, but it should give the reader a 
good overview of the codebase and ideas behind various implementation details.
It won't explain the code itself; that's what the API docs are meant for, but 
it might help to understand why certain things are the way they are.\\

In brief, this is a guide through the Adonthell source code. No more, no less. 

\subsection{Obtaining and Distributing}
The Adonthell Architecture Documentation can be redistributed freely. The most 
recent version can be obtained from the Adonthell website\footnote{\sf 
\href{http://adonthell.linuxgames.com/download/documentation.shtml}{http://adonthell.linuxgames.com/download/documentation.shtml}}.
 The \LaTeX{} sources are available via anonymous CVS. To retrieve them, issue 
the following commands:

{\footnotesize
\begin{verbatim}
cvs -d:pserver:address@hidden:/cvsroot/adonthell login
cvs -z3 -d:pserver:address@hidden:/cvsroot/adonthell co -P doc
\end{verbatim}
}

If prompted for a password, simply hit enter. To update your copy of the code, 
run

{\footnotesize
\begin{verbatim}
cvs -z3 -update -dP
\end{verbatim}
}

within the documentation directory from time to time.

Index: abstract.tex
===================================================================
RCS file: /cvsroot/adonthell/doc/architecture/abstract.tex,v
retrieving revision 1.1
retrieving revision 1.2
diff -C2 -r1.1 -r1.2
*** abstract.tex        1 Jan 2003 13:12:41 -0000       1.1
--- abstract.tex        22 Feb 2003 11:27:05 -0000      1.2
***************
*** 1,4 ****
! \section{Abstract}
  
  This document is a supplement to the Adonthell API documentation. It is 
  intented for new programmers and everyone else interested into the general 
concepts and design of the Adonthell game engine.\\
--- 1,6 ----
! \section{Introduction}
! \thispagestyle{empty}
  
+ \subsection{About the Architecture Documentation}
  This document is a supplement to the Adonthell API documentation. It is 
  intented for new programmers and everyone else interested into the general 
concepts and design of the Adonthell game engine.\\
***************
*** 10,11 ****
--- 12,34 ----
  
  In brief, this is a guide through the Adonthell source code. No more, no 
less. 
+ 
+ \subsection{Obtaining and Distributing this Document}
+ 
+ The Adonthell Architecture Documentation can be redistributed freely. The 
most recent version can be obtained from the Adonthell website\footnote{\sf 
\href{http://adonthell.linuxgames.com/download/documentation.shtml}{http://adonthell.linuxgames.com/download/documentation.shtml}}.
 The \LaTeX{} sources are available via anonymous CVS. To retrieve them, issue 
the following commands:
+ 
+ {\footnotesize
+ \begin{verbatim}
+ cvs -d:pserver:address@hidden:/cvsroot/adonthell login
+ cvs -z3 -d:pserver:address@hidden:/cvsroot/adonthell co -P doc
+ \end{verbatim}
+ }
+ 
+ If prompted for a password, simply hit enter. To update your copy of the 
code, run
+ 
+ {\footnotesize
+ \begin{verbatim}
+ cvs -z3 -update -dP
+ \end{verbatim}
+ }
+ 
+ within the documentation directory from time to time.

Index: architecture.tex
===================================================================
RCS file: /cvsroot/adonthell/doc/architecture/architecture.tex,v
retrieving revision 1.2
retrieving revision 1.3
diff -C2 -r1.2 -r1.3
*** architecture.tex    2 Jan 2003 23:07:07 -0000       1.2
--- architecture.tex    22 Feb 2003 11:27:05 -0000      1.3
***************
*** 54,60 ****
  \clearemptydoublepage
  
- %------------------------------------------
- \tableofcontents             % Contents
- \clearemptydoublepage        
  %------------- Layout ---------------------
  \pagestyle{fancyplain}
--- 54,57 ----
***************
*** 68,77 ****
  
  %------------------------------------------
! \pagenumbering{arabic}
! \thispagestyle{empty}
! \include{abstract}          % Abstract
  \thispagestyle{empty}
  \include{overview}          % Overview
- \thispagestyle{empty}
  \include{edesign}           % Engine design
  \end{document}
--- 65,74 ----
  
  %------------------------------------------
! \tableofcontents             % Contents
  \thispagestyle{empty}
+ %------------------------------------------
+ \pagenumbering{arabic}
+ \include{intro}             % Introduction
  \include{overview}          % Overview
  \include{edesign}           % Engine design
  \end{document}

Index: edesign.tex
===================================================================
RCS file: /cvsroot/adonthell/doc/architecture/edesign.tex,v
retrieving revision 1.1
retrieving revision 1.2
diff -C2 -r1.1 -r1.2
*** edesign.tex 2 Jan 2003 23:07:07 -0000       1.1
--- edesign.tex 22 Feb 2003 11:27:05 -0000      1.2
***************
*** 1,3 ****
--- 1,4 ----
  \section{Engine Architecture}
+ \thispagestyle{empty}
  
  Now that we have an overview of Adonthell's architecture, we will look at 
select parts of the engine in more detail.

Index: overview.tex
===================================================================
RCS file: /cvsroot/adonthell/doc/architecture/overview.tex,v
retrieving revision 1.2
retrieving revision 1.3
diff -C2 -r1.2 -r1.3
*** overview.tex        2 Jan 2003 23:07:07 -0000       1.2
--- overview.tex        22 Feb 2003 11:27:05 -0000      1.3
***************
*** 1,3 ****
--- 1,4 ----
  \section{Overview}
+ \thispagestyle{empty}
  
  Before describing the different parts and layers of the engine in detail,