doc: Set manual title in the Makefile itself instead of in a separate title.html
[charm.git] / doc / Makefile.common
1 # Makefile included by each manual: contains the 
2 #   common build commands/targets ("make pdf", "make ps", "make html")
3 #   common "upload-to-web" targets ("make web")
4
5 # The enclosing Makefile is expected to set the variables:
6 #   FILE: base name of master TeX file (typically "manual")
7 #   TEX: all TeX files to depend on (often just "manual.tex")
8 #   DEST: destination manual name (e.g., "fem")
9 #   LATEX2HTML: call to latex2html, which should be "$(L2H) <args>"
10 #   DOCTITLE: title of the manual
11 # (optional) PROJECT_LINK: HTML to include at bottom of page
12
13 # Destination directory for local copy of files (e.g., on user machine)
14 DOCDIR=..
15
16 # Destination directory for web-accessible copy of files (e.g., on PPL machines)
17 WEBDIR=/www/ppl_manuals
18
19 # Call to Latex2html
20 L2H=latex2html -white -antialias -local_icons \
21         -long_titles 1 \
22         -show_section_numbers \
23         -top_navigation \
24         -address '<p align="right">'"`/bin/date +"%B %d, %Y"`"'<br> \
25             '$(PROJECT_LINK)'<a href="http://charm.cs.illinois.edu/">PPL Homepage</a>'
26
27 DEPTEX=$(TEX) $(FILE).aux index.tex
28
29 # Default target: build postscript, pdf, and html:
30
31 all: pdf ps html
32
33 # PostScript Target:
34 ps: $(FILE).ps
35
36 # latex does not create dvi anymore on new linux distributions
37 #$(FILE).dvi: $(TEX) $(FILE).aux 
38 #       latex $(FILE).tex
39
40 $(FILE).ps: $(FILE).pdf
41         pdftops -level1 -paper letter $(FILE).pdf $(FILE).ps
42         #dvips -t letter -f $(FILE).dvi > $(FILE).ps
43
44
45 # PDF Target:
46 pdf: $(FILE).pdf
47
48 $(FILE).pdf: $(TEX) $(FILE).aux
49         pdflatex $(FILE).tex
50         pdflatex $(FILE).tex
51
52 # HTML Target:
53 html: $(FILE)
54
55 $(FILE): $(TEX) $(FILE).aux
56         -@ln -s ../pplmanual.* .
57         -@ln -s ../dot.latex2html-init .latex2html-init
58         -@rm -fr $(FILE)/*.html $(FILE)/*.aux
59         -@mkdir $(FILE)
60         -@/bin/cp ../manual.css $(FILE)
61         -@/bin/cp ../*.js $(FILE)
62         -@/bin/cp ../navbarbkgd.png $(FILE)
63         -/bin/cp title.html $(FILE)
64         $(L2H) -split 0 $(FILE).tex
65         -@mv $(FILE)/$(FILE).html $(FILE)/$(FILE)-1p.html
66         export MANUALTITLE=$(DOCTITLE) && $(LATEX2HTML) $(FILE).tex && unset MANUALTITLE
67         ../l2h_sanitize_markup.sh
68
69 # LaTeX Index and link support
70 $(FILE).aux: $(TEX) index.tex $(FIG_TARGET)
71         pdflatex $(FILE).tex
72
73 index.tex: $(FILE).idx
74         makeindex -o index.tex $(FILE).idx
75
76 $(FILE).idx:
77         touch $(FILE).idx
78
79 # Clean out all TeX droppings:
80 clean:
81         -rm -fr *.aux *.log *.dvi *.ps *.pdf *.out *.ilg $(FILE)
82         -rm -fr *.idx *.log *.bbl *.blg *.toc *~ fig/*.bak
83         -rm -fr index.tex $(FIG_CLEAN)
84
85 # Build local copy of documentation:
86 doc: all
87         if [ ! -d $(DOCDIR) ] ; then mkdir $(DOCDIR) ; fi
88         if [ ! -d $(DOCDIR)/ps ] ; then mkdir $(DOCDIR)/ps ; fi
89         if [ ! -d $(DOCDIR)/pdf ] ; then mkdir $(DOCDIR)/pdf ; fi
90         if [ ! -d $(DOCDIR)/html ] ; then mkdir $(DOCDIR)/html ; fi
91         /bin/cp $(FILE).ps $(DOCDIR)/ps/$(DEST).ps
92         chmod 664 $(DOCDIR)/ps/$(DEST).ps
93         /bin/cp $(FILE).pdf $(DOCDIR)/pdf/$(DEST).pdf
94         chmod 664 $(DOCDIR)/pdf/$(DEST).pdf
95         /bin/rm -rf $(DOCDIR)/html/$(DEST)
96         /bin/cp -R $(FILE) $(DOCDIR)/html/$(DEST)
97         find $(DOCDIR)/html/$(DEST) $(DOCDIR)/p*/$(DEST).p* -type f -exec chmod 664 {} \;
98         find $(DOCDIR)/html/$(DEST) -type d -exec chmod 775 {} \;
99
100 # Build web copy of documentation (PPL-only):
101 web: all
102         /bin/cp $(FILE).ps $(WEBDIR)/ps/$(DEST).ps
103         -chmod 664 $(WEBDIR)/ps/$(DEST).ps
104         /bin/cp $(FILE).pdf $(WEBDIR)/pdf/$(DEST).pdf
105         -chmod 664 $(WEBDIR)/pdf/$(DEST).pdf
106         /bin/rm -rf $(WEBDIR)/html/$(DEST)
107         /bin/cp -R $(FILE) $(WEBDIR)/html/$(DEST)
108         find $(WEBDIR)/html/$(DEST) $(WEBDIR)/p*/$(DEST).p* -type f -exec chmod 664 {} \;
109         find $(WEBDIR)/html/$(DEST) -type d -exec chmod 775 {} \;
110         -chgrp -R kale $(WEBDIR)/html/$(DEST) $(WEBDIR)/p*/$(DEST).p*
111