doc: Generate, embed and animate a table of contents in the navbar itself
[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 .PHONY: setup html1page
30
31 # Default target: build postscript, pdf, and html:
32
33 all: pdf ps html
34
35 # PostScript Target:
36 ps: $(FILE).ps
37
38 # latex does not create dvi anymore on new linux distributions
39 #$(FILE).dvi: $(TEX) $(FILE).aux 
40 #       latex $(FILE).tex
41
42 $(FILE).ps: $(FILE).pdf
43         pdftops -level1 -paper letter $(FILE).pdf $(FILE).ps
44         #dvips -t letter -f $(FILE).dvi > $(FILE).ps
45
46
47 # PDF Target:
48 pdf: $(FILE).pdf
49
50 $(FILE).pdf: $(TEX) $(FILE).aux
51         pdflatex $(FILE).tex
52         pdflatex $(FILE).tex
53
54 # HTML Target:
55 html: html1page $(FILE)
56
57 tmpFile = tmp-navmenu.html
58
59 $(FILE): setup $(TEX) $(FILE).aux
60         export MANUALTITLE=$(DOCTITLE) && $(LATEX2HTML) $(FILE).tex && unset MANUALTITLE
61         ../l2h_sanitize_markup.sh
62         ../navmenuGenerator.py $@/index.html > $(tmpFile)
63         for f in $@/*.html; do echo "Sanitizing $$f"; ../markupSanitizer.py $$f $(tmpFile) > tmpop && cat tmpop > $$f && rm tmpop; done
64         rm -f $(tmpFile)
65
66 html1page: setup $(TEX) $(FILE).aux
67         $(L2H) -split 0 $(FILE).tex
68         -@mv $(FILE)/$(FILE).html $(FILE)/$(FILE)-1p.html
69
70 setup:
71         -@ln -s ../pplmanual.* .
72         -@ln -s ../dot.latex2html-init .latex2html-init
73         -@rm -fr $(FILE)/*.html $(FILE)/*.aux
74         -@mkdir $(FILE)
75         -@/bin/cp ../manual.css $(FILE)
76         -@/bin/cp ../*.js $(FILE)
77         -@/bin/cp ../navbarbkgd.png $(FILE)
78
79 # LaTeX Index and link support
80 $(FILE).aux: $(TEX) index.tex $(FIG_TARGET)
81         pdflatex $(FILE).tex
82
83 index.tex: $(FILE).idx
84         makeindex -o index.tex $(FILE).idx
85
86 $(FILE).idx:
87         touch $(FILE).idx
88
89 # Clean out all TeX droppings:
90 clean:
91         -rm -fr *.aux *.log *.dvi *.ps *.pdf *.out *.ilg $(FILE)
92         -rm -fr *.idx *.log *.bbl *.blg *.toc *~ fig/*.bak
93         -rm -fr index.tex $(FIG_CLEAN)
94
95 # Build local copy of documentation:
96 doc: all
97         if [ ! -d $(DOCDIR) ] ; then mkdir $(DOCDIR) ; fi
98         if [ ! -d $(DOCDIR)/ps ] ; then mkdir $(DOCDIR)/ps ; fi
99         if [ ! -d $(DOCDIR)/pdf ] ; then mkdir $(DOCDIR)/pdf ; fi
100         if [ ! -d $(DOCDIR)/html ] ; then mkdir $(DOCDIR)/html ; fi
101         /bin/cp $(FILE).ps $(DOCDIR)/ps/$(DEST).ps
102         chmod 664 $(DOCDIR)/ps/$(DEST).ps
103         /bin/cp $(FILE).pdf $(DOCDIR)/pdf/$(DEST).pdf
104         chmod 664 $(DOCDIR)/pdf/$(DEST).pdf
105         /bin/rm -rf $(DOCDIR)/html/$(DEST)
106         /bin/cp -R $(FILE) $(DOCDIR)/html/$(DEST)
107         find $(DOCDIR)/html/$(DEST) $(DOCDIR)/p*/$(DEST).p* -type f -exec chmod 664 {} \;
108         find $(DOCDIR)/html/$(DEST) -type d -exec chmod 775 {} \;
109
110 # Build web copy of documentation (PPL-only):
111 web: all
112         /bin/cp $(FILE).ps $(WEBDIR)/ps/$(DEST).ps
113         -chmod 664 $(WEBDIR)/ps/$(DEST).ps
114         /bin/cp $(FILE).pdf $(WEBDIR)/pdf/$(DEST).pdf
115         -chmod 664 $(WEBDIR)/pdf/$(DEST).pdf
116         /bin/rm -rf $(WEBDIR)/html/$(DEST)
117         /bin/cp -R $(FILE) $(WEBDIR)/html/$(DEST)
118         find $(WEBDIR)/html/$(DEST) $(WEBDIR)/p*/$(DEST).p* -type f -exec chmod 664 {} \;
119         find $(WEBDIR)/html/$(DEST) -type d -exec chmod 775 {} \;
120         -chgrp -R kale $(WEBDIR)/html/$(DEST) $(WEBDIR)/p*/$(DEST).p*
121