Manual Patch: Final Manual Patch?

[Jeffrey Oldham]

This patch moves the POOMA manual toward creation on varying platforms.

2002-Feb-01  Jeffrey D. Oldham  <oldham at codesourcery.com>

	* Makefile (JADEDIR): Revise to more canonical location.
	* README.txt: Explain how to build the POOMA manual.
	* pooma.xml: Revise DocBook XML file to more canonical location.

Applied to	mainline.

Are we done?

Thanks,
Jeffrey D. Oldham
oldham at codesourcery.com
-------------- next part --------------
Index: Makefile
===================================================================
RCS file: /home/pooma/Repository/r2/docs/manual/Makefile,v
retrieving revision 1.6
diff -c -p -r1.6 Makefile
*** Makefile	2002/02/01 02:08:07	1.6
--- Makefile	2002/02/01 17:39:04
***************
*** 7,13 ****
  TEX=		latex
  
  # Definitions for Jade.
! JADEDIR=		/usr/lib/sgml/stylesheets/docbook
  PRINTDOCBOOKDSL=	print.dsl # print/docbook.dsl
  HTMLDOCBOOKDSL=		html.dsl # html/docbook.dsl
  XML=			dtds/decls/xml.dcl
--- 7,13 ----
  TEX=		latex
  
  # Definitions for Jade.
! JADEDIR=		/usr/share/sgml/docbook/dsssl-stylesheets-1.64
  PRINTDOCBOOKDSL=	print.dsl # print/docbook.dsl
  HTMLDOCBOOKDSL=		html.dsl # html/docbook.dsl
  XML=			dtds/decls/xml.dcl
Index: README.txt
===================================================================
RCS file: README.txt
diff -N README.txt
*** /dev/null	Fri Mar 23 21:37:44 2001
--- README.txt	Fri Feb  1 10:39:04 2002
***************
*** 0 ****
--- 1,66 ----
+ Oldham, Jeffrey D.
+ 2002Jan31
+ POOMA
+ 
+ Creating the POOMA Manual
+ 
+ 
+ To create the manual,
+ 
+ 	make
+ 
+ If this fails, keep reading.
+ 
+ The POOMA manual source is written in
+   DocBook - for text
+   MetaPost - for figures
+   C++ - for source code.
+ 
+ Creating it requires the following tools:
+ 
+   jade: James's DSSL engine which converts DocBook into HTML, RTF, TeX, ...
+ 
+   jadetex: TeX + special macros for Jade.  Its fixed constants need to
+     be large enough.
+ 
+   pdfjadetex: pdfTeX + special macros for Jade.  Its fixed constants need to
+     be large enough.
+ 
+   mpost: Converts MetaPost source code into EPS figure files.
+ 
+   peps: Converts EPS files to PNG files.
+ 
+   mproof.tex: Used to proof the EPS files.
+ 
+ If you have having trouble with:
+   jade: Modify $(JADEDIR) in Makefile to the directory containing the
+     DocBook stylesheets.
+     Modify pooma.xml's DOCTYPE line to specify the location of the
+     DocBook docbookx.dtd.
+ 
+   jadetex: Ensure it has large enough TeX capacities.  See
+     http://jadetex.sourceforge.net.
+ 
+   peps: Use any tool you desire to convert the EPS files into PNG
+     files.  Specify the tool in figures/Makefile's $(EPSTOPNG).
+     Alternatively, download peps from
+     http://www.whizkidtech.net/peps/.  Be sure to apply the patch
+     below to ensure the resulting figures are not too large.
+ 
+     The invocation assumes 'pnmtopng' is available.
+ 
+   mproof.tex: Download from any CTAN archive, e.g., www.ctan.org.
+ 
+ 
+ *** peps.c	Wed Jul  4 16:59:56 2001
+ --- peps.c	Tue Jan 29 14:42:51 2002
+ ***************
+ *** 359,362 ****
+ --- 359,365 ----
+     }
+   
+ +   hres *= 0.75;
+ +   vres *= 0.75;
+ + 
+     sprintf(buffer, gsargs,
+   	  gab,
Index: pooma.xml
===================================================================
RCS file: /home/pooma/Repository/r2/docs/manual/pooma.xml,v
retrieving revision 1.2
diff -c -p -r1.2 pooma.xml
*** pooma.xml	2002/02/01 02:00:50	1.2
--- pooma.xml	2002/02/01 17:39:07
***************
*** 1,7 ****
  <?xml version="1.0"?>
  <!-- FIXME: Index this file. -->
  
! <!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook XML V4.1.2//EN" "file:///usr/lib/sgml/docbookx.dtd" [
  
  <!-- Text to Check, Revise, Replace -->
    <!-- FIXME: Revise before releasing. -->
--- 1,7 ----
  <?xml version="1.0"?>
  <!-- FIXME: Index this file. -->
  
! <!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook XML V4.1.2//EN" "/usr/share/sgml/docbook/xml-dtd-4.1.2/docbookx.dtd" [
  
  <!-- Text to Check, Revise, Replace -->
    <!-- FIXME: Revise before releasing. -->