r8215: fix documentation
[hyperobject.git] / doc / Makefile
1 ##############################################################################
2 # FILE IDENTIFICATION
3
4 #  Name:         Makefile
5 #  Purpose:      Makefile for the hyperobject documentation
6 #  Programer:    Kevin M. Rosenberg
7 #  Date Started: Mar 2002
8 #
9 #  CVS Id:   $Id$
10 #
11 # This file, part of HYPEROBJECT, is Copyright (c) 2002-2003 by Kevin M. Rosenberg
12 #
13 # HYPEROBJECT users are granted the rights to distribute and use this software
14 # as governed by the terms of the Lisp Lesser GNU Public License
15 # (http://opensource.franz.com/preamble.html), also known as the LLGPL.
16 ##############################################################################
17
18 DOCFILE_BASE_DEFAULT:=hyperobject
19 DOCFILE_EXT_DEFAULT:=xml
20
21
22 # Standard docfile processing
23
24 DEBIAN=$(shell expr "`cat /etc/issue`" : '.*Debian.*')
25 SUSE=$(shell expr "`cat /etc/issue`" : '.*SuSE.*')
26 REDHAT=$(shell expr "`cat /etc/issue`" : '.*RedHat.*')
27
28
29 ifneq (${DEBIAN},0)
30 OS:=debian
31 else
32   ifneq (${SUSE},0)
33     OS=suse
34   else   
35     ifneq (${REDHAT},0)
36       OS=redhat
37     endif
38   endif
39 endif
40
41
42 ifndef DOCFILE_BASE
43 DOCFILE_BASE=${DOCFILE_BASE_DEFAULT}
44 endif
45
46 ifndef DOCFILE_EXT
47 DOCFILE_EXT=${DOCFILE_EXT_DEFAULT}
48 endif
49
50 DOCFILE:=${DOCFILE_BASE}.${DOCFILE_EXT}
51 FOFILE:=${DOCFILE_BASE}.fo
52 PDFFILE:=${DOCFILE_BASE}.pdf
53 PSFILE:=${DOCFILE_BASE}.ps
54 DVIFILE:=${DOCFILE_BASE}.dvi
55 TXTFILE:=${DOCFILE_BASE}.txt
56 HTMLFILE:=${DOCFILE_BASE}.html
57 TMPFILES:=${DOCFILE_BASE}.aux ${DOCFILE_BASE}.out ${DOCFILE_BASE}.log
58 DOCFILES:=$(shell echo *.xml *.xsl)
59
60 CATALOG:=`pwd`/catalog-${OS}.xml
61 CHECK:=XML_CATALOG_FILES="$(CATALOG)" xmllint --noout --xinclude --postvalid $(DOCFILE) || exit 1
62
63 .PHONY: all
64 all: html pdf 
65
66 .PHONY: dist
67 dist: html pdf
68
69 .PHONY: doc
70 doc: html pdf
71
72 .PHONY: check
73 check:
74         @echo "Operating System Detected: ${OS}"
75         @$(CHECK)
76
77 .PHONY: html
78 html: html.tar.gz
79
80 html.tar.gz: $(DOCFILES) Makefile 
81         @rm -rf html
82         @mkdir html
83         @XML_CATALOG_FILES="$(CATALOG)" xsltproc --xinclude --output html/ html_chunk.xsl $(DOCFILE)
84         @GZIP='-9' tar czf html.tar.gz html 
85
86 .PHONY: fo
87 fo: ${FOFILE}
88
89 ${FOFILE}: $(DOCFILES) Makefile 
90         @XML_CATALOG_FILES="$(CATALOG)" xsltproc --xinclude --output $(FOFILE) fo.xsl $(DOCFILE)
91
92 .PHONY: pdf
93 pdf: ${PDFFILE}
94
95 ${PDFFILE}: ${DOCFILES} Makefile
96         @$(MAKE) fo
97         @fop $(FOFILE) -pdf $(PDFFILE) > /dev/null
98
99 .PHONY: dvi
100 dvi: ${DVIFILE}
101
102 .PHONY: ps
103 ps: ${PSFILE}
104
105 ${PSFILE}: ${DOCFILES} Makefile
106         @$(MAKE) fo
107         @fop $(FOFILE) -ps $(PSFILE) > /dev/null
108
109
110 .PHONY: txt
111 txt: ${TXTFILE}
112
113 ${TXTFILE}: ${FOFILE}
114         @XML_CATALOG_FILES="$(CATALOG)" xsltproc --xinclude --output ${HTMLFILE} html.xsl $(DOCFILE)
115         lynx -dump ${HTMLFILE} > ${TXTFILE}
116
117 .PHONY: clean
118 clean: 
119         @rm -f *~ *.bak *.orig \#*\# .\#* texput.log
120         @rm -rf html ${PSFILE} ${HTMLFILE}
121         @rm -f ${TMPFILES} ${FOFILE}
122         @rm -f  ${DVIFILE} ${TXTFILE}
123
124 .PHONY: distclean
125 distclean: clean