Index of /instruments/software/secchi/secchi_software_in_ssw/idl/scraytrace/doc
Name Last modified Size
![[PARENTDIR]](/icons/back.gif)
Parent Directory -
![[ ]](/icons/unknown.gif)
tex-math-equations.aux 2006-09-15 16:25 8
![[ ]](/icons/tex.gif)
tex-math-equations.tex 2006-09-15 16:25 143
![[ ]](/icons/dvi.gif)
tex-math-equations.dvi 2006-09-15 16:25 300
![[TXT]](/icons/text.gif)
Makefile 2009-01-12 17:28 476
docbook.css 2006-09-08 16:02 813
config.xsl 2006-09-08 16:02 851
tex-math-equations.log 2006-09-15 16:25 2.4K
bi01.html 2006-09-15 16:25 2.5K
coordsys01.fig 2006-09-08 16:02 3.3K
overview.html 2006-09-15 16:25 4.8K
guide.html 2006-09-15 16:25 5.3K
![[IMG]](/icons/image2.gif)
cme20070515ABgui02.png 2009-02-11 05:47 9.6K
cme20070515ABgui03.png 2009-02-11 05:47 11K
coordsys01.png 2006-09-08 16:02 11K
cme20070515ABgui04.png 2009-02-11 05:47 11K
install.html 2006-09-15 16:25 11K
cme20070515ABgui01.png 2009-02-11 05:47 12K
capture05.png 2006-09-08 16:02 12K
raytracing.html 2006-09-15 16:25 13K
![[ ]](/icons/a.gif)
coordsys01.eps 2006-09-08 16:02 16K
examples.html 2006-09-15 16:25 17K
capture06.png 2006-09-08 16:02 20K
newmodel.html 2006-09-15 16:25 21K
raytracecomponentsUS.png 2009-07-10 16:04 21K
cor2cmesimusimu.png 2007-07-09 09:25 24K
capture03.png 2006-09-08 16:02 29K
cme20070515ABthomson01.png 2007-07-23 16:56 29K
capture02.png 2006-09-08 16:02 30K
capture04.png 2006-09-08 16:02 36K
capture01.png 2006-09-08 16:02 59K
raytraceman.docbook.xml 2009-04-15 04:49 77K
frame41circ.png 2007-07-09 09:25 176K
cor2cmesimuevent.png 2007-07-09 09:25 296K
cme20070515ABeuvi01.png 2007-07-23 16:56 366K
cor2cmesimusimu.eps 2007-07-09 09:25 565K
cme20070515ABscreen01.png 2007-07-23 16:56 846K
frame41circ.eps 2007-07-09 09:25 1.0M
cme20070515ABgui01.eps 2009-02-11 05:47 2.0M
cme20070515ABgui02.eps 2009-02-11 05:47 2.0M
cme20070515ABgui03.eps 2009-02-11 05:47 2.0M
cme20070515ABgui04.eps 2009-02-11 05:47 2.0M
cor2cmesimuevent.eps 2007-07-09 09:25 2.1M
cme20070515ABeuvi01.eps 2007-07-23 16:57 3.2M
cme20070515ABthomson01.eps 2007-07-23 16:57 3.2M
cme20070515ABscreen01.eps 2007-07-23 16:57 3.3M
Small doc on how to generate the html files from the Docbook formated documentation.
$Id: README,v 1.2 2006/11/01 14:55:32 thernis Exp $
1) What's Docbook ?
Like latex, it's a way to generate documents. It's oriented for technical and software documentation. The source file is formated in XML. The definition of the markup tags are given by the Docbook standard. From the source file, it's supposedly possible to generate the documentation in different format such as html, pdf, ps, rtf.
For more info you can check:
http://www.docbook.org/
http://www.docbook.org/tdg/en/html/docbook.html
http://docbook.sourceforge.net/
http://www.sagehill.net/docbookxsl/index.html
2) Generate the html doc.
Go to the directory where the raytraceman.docbook.xml and this REAME are and just do make.
shell> make
Note that you might need to edit the Makefile.
Required programs:
- xsltproc, xmlto: programs that come from libxml2 package:
http://xmlsoft.org/index.html
- latex
- dvi2bitmap
3) Release of the html doc on the net.
For the moment it is available there:
http://ares.nrl.navy.mil/~thernis/
It's also password protected for the moment: ask me (arnaud) if you need the login/password.
4) Generate the pdf formated doc
I still have to deal with that. It shouldn't be too much of a hassle but I've got an error when I try to use xmlto pdf. Still need to fix that.