# Example makefile using mjotex and a BibTeX references database.
#
-# The latex compiler.
-LATEX = pdflatex -file-line-error -halt-on-error
+# The latex compiler. The SOURCE_DATE_EPOCH=0 prevents the creation
+# and modification dates from being embedded as metadata into the
+# output file; that in turn is important because it allows us to tell
+# when the output stops changing (that is, when we are done). The
+# variable is supported in pdftex v1.40.17 and later.
+LATEX = SOURCE_DATE_EPOCH=0 pdflatex -file-line-error -halt-on-error
# The name of this document.
+#
+# For example, to use the name of our parent directory:
+#
+# PN = $(notdir $(realpath .))
+#
PN = examples
# A space-separated list of bib files. These must all belong to paths
#
# Leave commented if you don't use a bibliography database.
#
-#BIBS = references.bib
+BIBS = local-references.bib
# A space-separated list of the mjotex files that you use. The path to
# mjotex must be contain in your $TEXINPUTS environment variable.
-MJOTEX = mjo-algorithm.tex mjo-arrow.tex mjo-common.tex mjo-cone.tex
-MJOTEX += mjo-convex.tex mjo-font.tex mjo-linear_algebra.tex mjo-listing.tex
-MJOTEX += mjo-misc.tex mjo-proof_by_cases.tex mjo-theorem.tex
+#
+# MJOTEX = mjotex.sty
+#
+MJOTEX = mjo-algebra.tex mjo-algorithm.tex mjo-arrow.tex mjo-calculus.tex
+MJOTEX += mjo-common.tex mjo-complex.tex mjo-cone.tex mjo-convex.tex
+MJOTEX += mjo-eja.tex mjo-font.tex mjo-hurwitz.tex mjo-linear_algebra.tex
+MJOTEX += mjo-listing.tex mjo-proof_by_cases.tex mjo-set.tex mjo-theorem.tex
MJOTEX += mjo-theorem-star.tex mjo-topology.tex mjo.bst
+# Compile a list of raw source code listings (*.listing) and their
+# associated output files (*.py) that will be tested by check-sage.
+SAGE_LISTING_SRCS = $(wildcard sage_listings/*.listing)
+SAGE_LISTING_DSTS = $(patsubst %.listing,%.py,$(SAGE_LISTING_SRCS))
+
+# A space-separated list of indices (just their names). Usually you'll
+# have just one, and it will be named the same thing as your document,
+# because that's what the makeidx package does.
+#
+# Leave commented if you don't use an index.
+#
+INDICES = $(PN)
+
+# We have to rebuild the index whenever the contents of the document
+# change, because page numbers get moved around. But when no INDICES
+# are defined, rebuilding them should be a no-op. This next definition
+# ensures that.
+ifdef INDICES
+REMAKE_INDICES = makeindex $(INDEX_SRCS)
+else
+REMAKE_INDICES = true
+endif
+
# Use kpsewhich (from the kpathsea suite) to find the absolute paths
# of the bibtex/mjotex files listed in in $(BIBS)/$(MJOTEX). The SRCS
# variable should contain all (Bib)TeX source files for the document.
MJOTEXPATHS = $(shell kpsewhich $(MJOTEX))
SRCS += $(MJOTEXPATHS)
endif
+ifdef SAGE_LISTING_DSTS
+SRCS += $(SAGE_LISTING_DSTS)
+endif
+ifdef INDICES
+INDEX_SRCS = $(addsuffix .idx,$(INDICES))
+INDEX_DSTS = $(addsuffix .ind,$(INDICES))
+endif
# The first target is the default, so put the PDF document first.
#
# in a makefile?
#
# At the start of this target, we call $(LATEX) to compile $(PN).tex.
-# If you ignore the "sed" for now, then the next step is to check for
-# the existence of a "previous" file. If there isn't one, this is the
-# first time that we've tried to build the PDF. In that case, take the
-# PDF that we've just built and make *that* the previous file. Then
-# start all over. If there is a previous file, then this is the second
-# (or more) time that we've tried to build the PDF. We diff the PDF
-# file that we've just built against the previous file; if they're the
-# same, then we've succeeded and stop. Otherwise, we make the new PDF
-# the previous file, and start all over. The end result is that we
-# will loop until the newly-created PDF and the previous file are
-# identical.
-#
-# But what about the "sed" call? By default, pdflatex will compile the
-# creation date, modification date, and a unique ID into the output
-# PDF. That means that two otherwise-identical documents, created
-# seconds apart, will look different. We only need to know when the
-# *contents* of the document are the same -- we don't care about the
-# metadata -- so sed is used to remove those three nondeterministic
-# pieces of information.
-#
-# The creation and modification dates should become optional in pdftex
-# v1.40.17 thanks to Debian's SOURCE_DATE_EPOCH initiative. When that
-# version of pdflatex makes it into TeX Live 2016, we can replace
-# those two sed scripts with something smarter.
-#
-$(PN).pdf: $(SRCS) $(PN).bbl
+# Afterwards, we check for the existence of a "previous" file. If
+# there isn't one, then this is the first time that we've built the
+# PDF. In that case, we take the PDF that we've just built and make it
+# the "previous" file before starting all over. If, on the other hand,
+# there already *was* a "previous" file, then this is the second (or
+# third...) time that we've built the PDF. We diff the newly-built PDF
+# against the "previous" file; if they're the same, then we've
+# succeeded and stop. Otherwise, we make the new PDF the "previous"
+# one, and start all over. The end result is that we will loop until
+# the newly-created PDF and the "previous" one are identical.
+#
+$(PN).pdf: $(SRCS) $(PN).bbl $(INDEX_DSTS)
$(LATEX) $(PN).tex
- sed --in-place \
- -e '/^\/ID \[<.*>\]/d' \
- -e "s/^\/\(ModDate\) (.*)/\/\1 (D:19700101000000Z00'00')/" \
- -e "s/^\/\(CreationDate\) (.*)/\/\\1 (D:19700101000000Z00'00')/" \
- $@
-
- if [ ! -f $@.previous ]; then \
- mv $@ $@.previous; \
- $(MAKE) $@; \
- fi;
-
- if cmp -s $@ $@.previous; then \
+ if [ -f $@.previous ] && cmp -s $@ $@.previous; then \
rm $@.previous; \
else \
mv $@ $@.previous; \
+ $(REMAKE_INDICES); \
$(MAKE) $@; \
fi;
$(LATEX) $(PN).tex
+ifdef INDICES
+# We need to be able to build the index source files without involving
+# the main $(PN).pdf rule, in order to avoid a chicken-and-egg problem.
+# This is similar to the $(PN).aux rule above, except that an index is
+# optional and there might be more than one of them.
+$(INDEX_SRCS): $(PN).tex
+ $(LATEX) $(PN).tex
+endif
+
+ifdef INDICES
+# Create real indices from source files by running "makeindex" on
+# them. We depend on SRCS here because we *do* want to rebuild the
+# index if the source document changes, but we use an order-only
+# dependency (see the bbl rule below) on the idx files to prevent us
+# from going into a rebuild loop when the idx files are regenerated.
+%.ind: $(SRCS) | %.idx
+ makeindex $|
+endif
+
# The pipe below indicates an "order-only dependency" on the aux file.
# Without it, every compilation of $(PN).tex would produce a new
# $(PN).aux, and thus $(PN).bbl would be rebuilt. This in turn causes
ifdef BIBS
bibtex $(PN).aux
else
- echo -n '' > $@
+ printf '' > $@
endif
# If the output PDF exists but the log file does not, then an attempt
$(MAKE) clean
$(MAKE)
+# How do we convert a raw listing into something testable by sage? We
+# append/prepend triple quotes to make the whole thing into a doctest,
+# and then we replace any blank lines by "<BLANKLINE>".
+sage_listings/%.py: sage_listings/%.listing
+ echo '"""' > $@ && cat $< >> $@ && echo '"""' >> $@ && sed -i 's/^[[:space:]]*$$/<BLANKLINE>/' $@
+
# Ensure that there are no overfull or underfull boxes in the output
# document by parsing the log for said warnings.
.PHONY: check-boxes
@! grep -i 'overfull\|underfull' $<
# Run chktex to find silly mistakes. There is some exit code weirdness
-# (Savannah bug 45979), so we just look for empty output.
+# (Savannah bug 53129), so we just look for empty output.
.PHONY: check-chktex
+CHKTEX = chktex --localrc .chktexrc --quiet --inputfiles=0
check-chktex:
- @[ -z "$(shell chktex --quiet mjotex.sty)" ]
+ @chktexout=$$($(CHKTEX) $(PN).tex); \
+ test -z "$${chktexout}" || { echo "$${chktexout}" 1>&2; exit 1; }
# Ensure that there are no undefined references in the document by
# parsing the log file for said warnings.
check-undefined: $(PN).log
@! grep -i 'undefined' $<
+# Use sage to doctest any \sagelisting{}s in SAGE_LISTING_DSTS.
+# The actuall command is ifdef'd so that we can comment out
+# the definition of SAGE_LISTING_DSTS without breaking the
+# default definition of the "check" target.
+.PHONY: check-sage
+check-sage: $(SAGE_LISTING_DSTS)
+ifdef SAGE_LISTING_DSTS
+ sage -t --timeout=0 $^
+endif
+
# Run a suite of checks.
.PHONY: check
-check: check-boxes check-chktex check-undefined
+check: check-boxes check-chktex check-undefined check-sage
# Clean up leftover junk. This only looks overcomplicated because
# the *.{foo,bar} syntax supported by Bash is not POSIX, and Make
# will execute these commands using /bin/sh (which should be POSIX).
-JUNK_EXTENSIONS = aux bbl bcf bib blg listing lof log nav out pdf
+JUNK_EXTENSIONS = aux bbl bcf blg glo ilg ist listing lof log nav out pdf
JUNK_EXTENSIONS += snm spl toc xml
.PHONY: clean
clean:
for ext in $(JUNK_EXTENSIONS); do rm -f *.$$ext; done;
rm -rf dist/
+ rm -f $(SAGE_LISTING_DSTS) $(INDEX_SRCS) $(INDEX_DSTS)
# If this document will be published, the publisher isn't going to
# have your BibTeX database or your mjotex files. So, you need to
.PHONY: dist
dist: $(PN).bbl
mkdir -p dist
- cp $(SRCS) $(PN).bbl $(BIBPATHS) $(MJOTEXPATHS) dist/
+ cp $(SRCS) $(PN).bbl dist/
projects / mjotex.git / blobdiff