aboutsummaryrefslogtreecommitdiff
path: root/reproduce/analysis/make/paper.mk
blob: 08fd766eab62209414d83af2f28459f47f13288c (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
# Build the final PDF paper/report.
#
# Copyright (C) 2018-2020 Mohammad Akhlaghi <mohammad@akhlaghi.org>
#
# This Makefile is part of Maneage. Maneage is free software: you can
# redistribute it and/or modify it under the terms of the GNU General
# Public License as published by the Free Software Foundation, either
# version 3 of the License, or (at your option) any later version.
#
# Maneage is distributed in the hope that it will be useful, but WITHOUT
# ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
# FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License for
# more details. See <http://www.gnu.org/licenses/>.




# LaTeX macros for paper
# ----------------------
#
# To report the input settings and results, the final report's PDF (final
# target of this project) uses macros generated from various steps of the
# project. All these macros are defined through `$(mtexdir)/project.tex'.
#
# `$(mtexdir)/project.tex' is actually just a combination of separate files
# that keep the LaTeX macros related to each workhorse Makefile (in
# `reproduce/src/make/*.mk'). Those individual macros are pre-requisites to
# `$(mtexdir)/verify.tex' which will check them before starting to build
# the paper. The only workhorse Makefile that doesn't need to produce LaTeX
# macros is this Makefile (`reproduce/src/make/paper.mk').
#
# This file is thus the interface between the analysis/processing steps and
# the final PDF: when we get to this point, all the processing has been
# completed.
#
# Note that if you don't want the final PDF and just want the processing
# and file outputs, you can remove the value of `pdf-build-final' in
# `reproduce/analysis/config/pdf-build.conf'.
$(mtexdir)/project.tex: $(mtexdir)/verify.tex

        # If no PDF is requested, or if LaTeX isn't available, don't
        # continue to building the final PDF. Otherwise, merge all the TeX
        # macros into one for building the PDF.
	@if [ -f .local/bin/latex ] && [ x"$(pdf-build-final)" != x ]; then

          # Put a LaTeX input command for all the necessary macro files.
	  rm -f $(mtexdir)/project.tex
	  for t in $(subst paper,,$(makesrc)); do
	    echo "\input{tex/build/macros/$$t.tex}" >> $(mtexdir)/project.tex
	  done
	else
	  echo
	  echo "-----"
	  echo "The processing has COMPLETED SUCCESSFULLY! But the final "
	  echo "LaTeX-built PDF paper will not be built."
	  echo
	  if [ x$(more-on-building-pdf) = x1 ]; then
	    echo "To do so, make sure you have LaTeX within the project (you"
	    echo "can check by running './.local/bin/latex --version'), _AND_"
	    echo "make sure that the 'pdf-build-final' variable has a value."
	    echo "'pdf-build-final' is defined in: "
	    echo     "'reproduce/analysis/config/pdf-build.conf'."
	    echo
	    echo "If you don't have LaTeX within the project, please re-run"
	    echo "'./project configure -e' when you have internet access."
	  else
	    echo "For more, run './project make more-on-building-pdf=1'"
	  fi
	  echo
	  echo "" > $@
	fi





# The bibliography
# ----------------
#
# We need to run the `biber' program on the output of LaTeX to generate the
# necessary bibliography before making the final paper. So we'll first have
# one run of LaTeX (similar to the `paper.pdf' recipe), then `biber'.
#
# NOTE: `$(mtexdir)/project.tex' is an order-only-prerequisite for
# `paper.bbl'. This is because we need to run LaTeX in both the `paper.bbl'
# recipe and the `paper.pdf' recipe. But if `tex/src/references.bib' hasn't
# been modified, we don't want to re-build the bibliography, only the final
# PDF.
$(texbdir)/paper.bbl: tex/src/references.tex $(mtexdir)/dependencies-bib.tex \
                      | $(mtexdir)/project.tex
        # If `$(mtexdir)/project.tex' is empty, don't build PDF.
	@macros=$$(cat $(mtexdir)/project.tex)
	if [ x"$$macros" != x ]; then

          # Unfortunately I can't get bibtex to look into a special
          # directory for the references, so we'll copy it here.
	  p=$$(pwd)
	  if ! [ -L $(texbdir)/references.bib ]; then
	    ln -s $$p/tex/src/references.tex $(texbdir)/references.bib
	  fi

          # Copy the improved IEEE bst file into the build directory.
          # The improved bst file provides ArXiv clickable URLs and
          # if available, open-access URLs based on the DOIs, with
          # closed-access URLs as a fallback, via https://oadoi.org .
	  cp -pv $$p/tex/src/IEEEtran_openaccess.bst $(texbdir)

          # We'll run LaTeX first to generate the `.bcf' file (necessary
          # for `biber') and then run `biber' to generate the `.bbl' file.
	  export TEXINPUTS=$$p:
	  cd $(texbdir);
	  latex -shell-escape -halt-on-error $$p/paper.tex
	  bibtex paper
          # Hack: tidy up eprint+doi style that didn't work in .bst file.
          # TODO (better): read Part 4 of
          # http://mirrors.ctan.org/info/bibtex/tamethebeast/ttb_en.pdf
          # and fix the .bst style properly.
	  cp paper.bbl paper-tmp.bbl \
	    && sed -e "s/\'/EOLINE/g" paper-tmp.bbl \
	    | tr -d '\n' \
	    | sed -e 's/\([0-9]\)\( \|EOLINE\)}/\1}/g' \
	    | sed -e 's/\([^,]\) *\( \|EOLINE\) *\\eprint/\1, \\eprint/g' \
	    | sed -e 's/\([^,]\) *\( \|EOLINE\) *\\doi/\1, \\doi/g' \
	    | sed -e 's/EOLINE/\n/g' > paper.bbl
	  latex -shell-escape -halt-on-error $$p/paper.tex
	fi





# The final paper
# ---------------
#
# Run LaTeX in the `$(texbdir)' directory so all the intermediate and
# auxiliary files stay there and keep the top directory clean. To be able
# to run everything cleanly from there, it is necessary to add the current
# directory (top project directory) to the `TEXINPUTS' environment
# variable.
paper.pdf: $(mtexdir)/project.tex paper.tex $(texbdir)/paper.bbl

        # If `$(mtexdir)/project.tex' is empty, don't build the PDF.
	@macros=$$(cat $(mtexdir)/project.tex)
	if [ x"$$macros" != x ]; then

          # Go into the top TeX build directory and make the paper.
	  p=$$(pwd)
	  export TEXINPUTS=$$p:
	  cd $(texbdir)
	  latex -shell-escape -halt-on-error $$p/paper.tex

          # Convert the DVI to PostScript, and the PostScript to PDF. The
          # `-dNOSAFER' option to GhostScript allows transparencies in the
          # conversion from PostScript to PDF, see
          # https://www.ghostscript.com/doc/current/Language.htm#Transparency
	  dvips paper.dvi
	  ps2pdf -dNOSAFER paper.ps

          # Come back to the top project directory and copy the built PDF
          # file here.
	  cd $$p
	  cp $(texbdir)/$@ $(final-paper)
	fi