Difference between revisions of "Official ESTEL Documentation"

From SourceWiki
Jump to navigation Jump to search
Line 1: Line 1:
 
[[Category:Projects]]
 
[[Category:Projects]]
 
[[Category:Estel]]
 
[[Category:Estel]]
 
=Build system=
 
The ESTEL documentation is slowly being moved to the estel-doc subversion repository. It consists of several files in LaTeX and BibTex format which can be compiled with pdfLaTeX to generate screen-ready PDF documents.
 
 
The PDFs are not stored in the subversion tree and instead, the PDFs are rebuilt daily (if any of the LaTeX files has been modified). Therefore, the documents linked below might change at any time and without notice. The date a PDF file has been rebuilt last is explicitly written on the first page of the document.
 
  
 
=Documents=
 
=Documents=
 
==Version v5p6==
 
==Version v5p6==
[http://source.ggy.bris.ac.uk/estel-doc/v5p6/estel3d-um.pdf ESTEL-3D User Manual]
+
[http://source.ggy.bris.ac.uk/subversion-hooks/estel-doc/v5p6/estel3d-um.pdf ESTEL-3D User Manual]
  
[http://source.ggy.bris.ac.uk/estel-doc/v5p6/estel2d-um.pdf ESTEL-2D User Manual]
+
<!--[http://source.ggy.bris.ac.uk/subversion-hooks/estel-doc/v5p6/estel2d-um.pdf ESTEL-2D User Manual] -->
  
Note: although v5p6 is currently the stable version of ESTEL, the documentation of ESTEL-2D is not complete (in the automated build system).  
+
Note: although v5p6 is currently the stable version of ESTEL, the documentation of ESTEL-2D is not complete (in the automated build system, see below) and will be available from here shortly.
 
   
 
   
 +
<!--
 
==Development version==
 
==Development version==
Documentation files not yet available.
+
[http://source.ggy.bris.ac.uk/subversion-hooks/estel-doc/latest/estel3d-um.pdf ESTEL-3D User Manual]
 +
-->
  
=Subversion access=
+
=Build system=
The source files are hosted under the estel-doc repository on the source subversion server. All ESTEL developers have access to these files. Following a similar subversion repository structure to that of ESTEL-2D or ESTEL-3D, the documentation for the latest version is in the "trunk/" and for a given stable version in "branches/RB-vxpy/"
+
The ESTEL documentation is slowly being moved to the [[ESTEL:Generate_the_documentation estel-doc subversion repository]] (restricted access). It consists of several files to generate screen or print ready PDF documents.
 
 
=Requirements to build the documentation=
 
pdfLaTeX (list required packages)
 
  
BibTex
+
The PDFs are not stored in the subversion tree and instead, they are rebuilt after each change . Therefore, the documents linked above might change at any time and without notice. The date a PDF file has been rebuilt last is explicitly written on the first page of the document.

Revision as of 15:55, 14 March 2007


Documents

Version v5p6

ESTEL-3D User Manual


Note: although v5p6 is currently the stable version of ESTEL, the documentation of ESTEL-2D is not complete (in the automated build system, see below) and will be available from here shortly.


Build system

The ESTEL documentation is slowly being moved to the ESTEL:Generate_the_documentation estel-doc subversion repository (restricted access). It consists of several files to generate screen or print ready PDF documents.

The PDFs are not stored in the subversion tree and instead, they are rebuilt after each change . Therefore, the documents linked above might change at any time and without notice. The date a PDF file has been rebuilt last is explicitly written on the first page of the document.