mirror of
https://github.com/freedombox/FreedomBox.git
synced 2026-06-10 11:00:22 +00:00
9bee07f1a4
We are going to introduce the Developer Manual that may contain this section and is composed differently that what Colophon talks about.
109 lines
3.1 KiB
Makefile
109 lines
3.1 KiB
Makefile
DOCDIR=../dist/doc
|
|
|
|
PANDOC=pandoc
|
|
PDFLATEX=pdflatex
|
|
|
|
|
|
# List text files in the order in which you want them to appear in the
|
|
# complete manual:
|
|
SOURCES=README.mdwn INSTALL.mdwn themes.mdwn hacking.mdwn modules.mdwn scripts.mdwn COPYING.mdwn
|
|
MAN_SOURCES=$(patsubst COPYING.mdwn,copyright_notice00,$(SOURCES))
|
|
|
|
NEWLINE_SOURCES=$(patsubst %,% oneline.txt,$(SOURCES))
|
|
NEWLINE_MAN_SOURCES=$(patsubst %,% oneline.txt,$(MAN_SOURCES))
|
|
|
|
HTML=plinth.html $(patsubst %.mdwn,%.html,$(SOURCES))
|
|
HTML_PART=$(patsubst %.html,%.part.html,$(HTML))
|
|
LATEX=plinth.tex $(patsubst %.mdwn,%.tex,$(SOURCES))
|
|
PDF=plinth.pdf $(patsubst %.mdwn,%.pdf,$(SOURCES))
|
|
MAN=plinth.1
|
|
|
|
## If you want PDF or Latex files, do them separately. They're not made by default.
|
|
|
|
OUTPUTS=$(HTML) $(MAN) $(HTML_PART)
|
|
DIST_OUTPUT=$(patsubst %,$(DOCDIR)/%,$(OUTPUTS))
|
|
|
|
all: oneline.txt $(OUTPUTS) Makefile
|
|
|
|
$(DOCDIR)/%: %
|
|
cp $< $@
|
|
|
|
dist: $(DIST_OUTPUT)
|
|
|
|
###############################################################################
|
|
oneline.txt: Makefile
|
|
perl -e 'print "\n"' > oneline.txt
|
|
|
|
$(SOURCES):
|
|
@rm -f $@
|
|
if [ -f ../$(patsubst %.mdwn,%.md,$@) ]; then \
|
|
ln -s ../$(patsubst %.mdwn,%.md,$@) $@; \
|
|
else \
|
|
ln -s ../$(patsubst %.mdwn,%,$@) $@; \
|
|
fi
|
|
|
|
###############################################################################
|
|
##
|
|
## MAN PAGES
|
|
##
|
|
$(MAN): $(SOURCES)
|
|
@csplit -s -f copyright_notice COPYING.mdwn '/##/'
|
|
cat $(NEWLINE_MAN_SOURCES) | perl -pe 'BEGIN { $$/=undef } $$_ =~ s/\n\n#\s.*/\n/gm; $$_ =~ s/\n\n#/\n\n/gm; $$_ =~ s/(\n\n#\s.*)/uc($$1)/gme' > .make_man
|
|
$(PANDOC) -s -t man -o $@ .make_man
|
|
@rm -f copyright_notice0? .make_man
|
|
manpages: $(MAN)
|
|
|
|
###############################################################################
|
|
##
|
|
## LaTeX
|
|
##
|
|
%.tex: %.mdwn
|
|
$(PANDOC) -s --toc -f markdown --standalone -o $@ $<
|
|
|
|
hacking.tex: hacking.mdwn
|
|
$(PANDOC) -s --toc -f markdown -o $@ hacking.mdwn
|
|
|
|
plinth.tex: $(NEWLINE_SOURCES)
|
|
$(PANDOC) -s --toc -f markdown -o $@ $(NEWLINE_SOURCES)
|
|
|
|
latex: $(LATEX)
|
|
|
|
###############################################################################
|
|
##
|
|
## HTML
|
|
##
|
|
|
|
# This gets us the html sections complete with TOC, but without the
|
|
# HTML and head section boilerplate. /help/page uses the parts.
|
|
%.part.html: %.html
|
|
csplit -s -f $@ $< '%.*<body>%'
|
|
sed '1d' $@00 > $@01
|
|
csplit -s -f $@ $@01 '/<\/body>/'
|
|
mv $@00 $@
|
|
rm $@01
|
|
|
|
%.html: %.mdwn Makefile
|
|
$(PANDOC) -s --toc -f markdown -o $@ $<
|
|
|
|
plinth.html: $(NEWLINE_SOURCES) Makefile
|
|
@csplit -s -f copyright_notice COPYING.mdwn '/##/'
|
|
$(PANDOC) -s --toc -o $@ -f markdown $(NEWLINE_MAN_SOURCES)
|
|
@rm -f copyright_notice0? .make_man
|
|
|
|
html: $(HTML) $(HTML_PART)
|
|
|
|
###############################################################################
|
|
%.pdf: %.tex
|
|
$(PDFLATEX) -interaction=batchmode $< >/dev/null
|
|
$(PDFLATEX) -interaction=batchmode $< >/dev/null # yes, do it twice so the toc works
|
|
|
|
pdf: $(PDF)
|
|
###############################################################################
|
|
|
|
clean-latex:
|
|
rm -f *.log *.out *.aux *.toc *.tex
|
|
|
|
clean: clean-latex
|
|
rm -f $(OUTPUTS) README.mdwn INSTALL.mdwn COPYING.mdwn \
|
|
copyright_notice0? \#*\# oneline.txt *.pdf
|