Difference between revisions of "Official ESTEL Documentation"

From SourceWiki
Jump to navigation Jump to search
 
(13 intermediate revisions by the same user not shown)
Line 1: Line 1:
 
[[Category:Projects]]
 
[[Category:Projects]]
 
[[Category:Estel]]
 
[[Category:Estel]]
−
 
+
The ESTEL documentation is currently moving to a version control system. the move is only partially complete and all files are not available yet. this page will be updated when new files become available.
−
=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==
+
*Development version ( will be called v5p9)
−
[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/latest/estel3d-um.pdf ESTEL-3D User Manual]
  
−
[http://source.ggy.bris.ac.uk/estel-doc/v5p6/estel2d-um.pdf ESTEL-2D User Manual]
+
*Version v5p8
 +
** [http://source.ggy.bris.ac.uk/subversion-hooks/estel-doc/v5p8/estel3d-um.pdf 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).
+
*Version v5p7
−
+
** [http://source.ggy.bris.ac.uk/subversion-hooks/estel-doc/v5p7/estel3d-um.pdf ESTEL-3D User Manual]
−
==Development version==
 
−
Documentation files not yet available.
 
  
−
=Subversion access=
+
* Version v5p6
−
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/"
+
** [http://source.ggy.bris.ac.uk/subversion-hooks/estel-doc/v5p6/estel3d-um.pdf ESTEL-3D User Manual]
 +
<!-- ** [http://source.ggy.bris.ac.uk/subversion-hooks/estel-doc/v5p6/estel2d-um.pdf ESTEL-2D User Manual] -->
  
−
=Requirements to build the documentation=
+
=Build system=
−
pdfLaTeX (list required packages)
+
The ESTEL documentation is stored in the [[ESTEL:Generate_the_documentation | estel-doc/ subversion repository]] (restricted access).
  
−
BibTex
+
The PDFs are not stored in the subversion tree and instead, they are rebuilt automatically 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.

Latest revision as of 16:26, 28 March 2008

The ESTEL documentation is currently moving to a version control system. the move is only partially complete and all files are not available yet. this page will be updated when new files become available.

Documents

Build system

The ESTEL documentation is stored in the estel-doc/ subversion repository (restricted access).

The PDFs are not stored in the subversion tree and instead, they are rebuilt automatically 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.

Retrieved from "https://source.geography.bristol.ac.uk/mediawiki/index.php?title=Official_ESTEL_Documentation&oldid=5088"