summaryrefslogtreecommitdiff
path: root/info/latex2e-help-texinfo/Makefile
blob: a5490434a6bb81828bf39b58b2a95388f103ca94 (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
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
# $Id: Makefile 1173 2024-05-13 15:17:28Z karl $
# Public domain.  Originally written 2006, Karl Berry.
# Makefile for latexrefman.

en_tex_output = latex2e.dvi latex2e.pdf
es_tex_output = latex2e-es.dvi latex2e-es.pdf
fr_tex_output = latex2e-fr.dvi latex2e-fr.pdf
#
xref_suffixes := ky cp vr fn cp pg tp
xref_suffixes := $(xref_suffixes) $(addsuffix s,$(xref_suffixes))
xref_suffixes := aux log toc $(xref_suffixes)
mi_suffixes = dbk html info txt xml
en_mi_output = $(addprefix latex2e., $(mi_suffixes))
es_mi_output = $(addprefix latex2e-es., $(mi_suffixes))
fr_mi_output = $(addprefix latex2e-fr., $(mi_suffixes))
#
all_suffixes = dvi pdf $(mi_suffixes)


#  how to build.
# 
texi2dvi = texfot texi2dvi --batch --tidy --build-dir=$*.t2dvi
texi2pdf = texfot texi2pdf --batch --tidy --build-dir=$*.t2pdf
#
makeinfo = makeinfo
texi2docbook = $(makeinfo) --docbook
texi2html = $(makeinfo) --no-split $(htmlopts)
texi2info = $(makeinfo) --no-split
texi2txt = $(makeinfo) --plaintext --no-split
texi2xml = $(makeinfo) --xml
#
htmlopts = --html $(html_css) $(t2html_config)
#
html_css = --css-include=latex2e.css
#
t2html_config = $(t2html_top) $(t2html_pagewords) $(t2html_menu) $(t2html_home)
#
# Go somewhere useful from Top:
t2html_top = -c TOP_NODE_UP_URL=https://tug.org/texinfohtml/
#
# Nodes must be larger than this to get navigation panel at bottom of
# page; default is 300.
t2html_pagewords = -c WORDS_IN_PAGE=10000
#
# For makeinfo 7.0, needed this to get warnings about tree structure:
#t2html_menu = -c CHECK_NORMAL_MENU_STRUCTURE=1
# https://lists.gnu.org/archive/html/bug-texinfo/2024-01/msg00021.html
# But as of 7.1, it is the default again (whew).
t2html_menu =
#
# Incidentally, a tree transformation can generate missing menu entries:
#   -c TREE_TRANSFORMATIONS=complete_tree_nodes_menus file.texi
#
# Put a link in the footer:
t2html_home = -c PRE_BODY_CLOSE="<hr/><div class='referenceinfo'>\
<a href='https://latexref.xyz/'>\
<i>Unofficial LaTeX2e reference manual</i></a></div>"

%.pdf: %.texi
	$(texi2pdf) $<
%.dvi: %.texi
	$(texi2dvi) $<
#
%.dbk: %.texi
	$(texi2docbook) -o $@ $<
%.html: %.texi latex2e.css
	$(texi2html) $<
%.info: %.texi
	$(texi2info) $<
%.txt: %.texi
	$(texi2txt) -o $@ $<
%.xml: %.texi
	$(texi2xml) $<


#  targets follow.
#
default: check-en

# to test changes, build a subset: html and info (since these formats
# exercise significantly different code paths), and pdf for tex.
check_suffixes = html info pdf
#
check-en: spell-en $(addprefix latex2e., $(check_suffixes))
check-es: $(addprefix latex2e-es., $(check_suffixes))
check-fr: $(addprefix latex2e-fr., $(check_suffixes))
check: check-en check-es check-fr

# Build per language.
en: $(en_mi_output) $(en_tex_output)
es: $(es_mi_output) $(es_tex_output)
fr: $(fr_mi_output) $(fr_tex_output)

# To build everything in all languages.
all: en es fr

# Sort of following the GNU sequence of clean targets.
distclean clean mostlyclean:
	rm -rf latex2e*.t2* $(distname)-tree*

realclean maintainer-clean: distclean
	rm -f $(addprefix latex2e*., pdf dvi $(mi_suffixes) $(xref_suffixes))


#  Basic dist target for CTAN, but please see ./README
# for all the necessary steps.
# 
txt_files = ChangeLog Makefile NEWS README \
            aspell.en.pws latex2e.css ltx-help.el
# html_files = index.html mirroring.html writing.html 
figure_files = list.eps list.pdf list.png list.txt
figure_source_files = asy/list.asy
distname = latex2e-help-texinfo
disttree = $(distname)-tree
distzip = $(distname).zip
#
htmlsplit = $(disttree)
htmlsplitzip = $(htmlsplit).zip
#
dist: en es
	@echo Making $@ ...
	rm -rf $(distname)
	mkdir $(distname) && cd $(distname) && ln -s ../* .
	mkdir $(distname)/spanish && cd $(distname)/spanish && ln -s ../../* .
	rm -f $(distzip)
	zip -q $(distzip) \
$(addprefix $(distname)/, $(txt_files) \
latex2e.texi common.texi $(en_mi_output) latex2e.pdf) \
$(addprefix $(distname)/spanish/,  $(es_mi_output) latex2e-es.pdf) \
$(addprefix $(distname)/latex2e-figures/,  $(figure_files)) \
$(addprefix $(distname)/graphics/,  README $(figure_source_files))
	rm -f $(htmlsplitzip)
	cd $(htmlsplit) && zip -qr ../$(htmlsplitzip) latex2e
	zip -q $(distzip) $(distname)
	@ls -l $(distzip); unzip -l $(distzip)

easyurls: htmlsplit dist
	@echo Making $@ ...
	cd src \
        && rm -rf testdist && mkdir -p testdist \
        && cp ../$(disttree).zip testdist \
        && rm -rf latex2e && unzip -q testdist/$(distname)-tree \
        && $(easyurls_python) ./easyurls.py $(easyurls_opt) \
        && zip -rq ../$(disttree)-easyurls.zip latex2e

easyurls_python = python # depends on bs4 (beautifulsoup4)
easyurls_debug = # --debug
easyurls_opt = --directory latex2e --action softlink --lower_case --rewrite_index $(easyurls_debug)

# To update web site, after basic build is ok (check-dw, spelling, etc.),
# first undo temporary build results:
#   make svr       # revert generated single files
#   make svrsplit  # revert generated split html
# then update ChangeLog, etc.,
# then svn commit the modified source files,
# then make commitready, which runs:
# 
#	$(MAKE)
#	$(MAKE) htmlsplit
#	$(MAKE) dist
#	$(MAKE) easyurls     # depends on htmlsplit and dist
#	$(MAKE) commitready  # depends on easyurls;
#			     # many files will have status !
# and then:
#   svn commit        # to commit regenerated files
# then:
#   svn -q update     # restore easy url stubs
#   make svrsplit  # restore generated split html
#
# If uploading to CTAN:
#   see file ./CTAN (update NEWS, write announcement, etc.)
#   upload latex2e-help-texinfo.zip
#
# Clean up:
postwebclean:
	rm -rf src/testdist src/latex2e
	rm -rf $(distname)
	rm $(disttree).zip $(distname)-easyurls.zip
	rm $(distname).zip
	make svri
	svn status

# In Texinfo 7.0, the default output directory changed to foo_html.
# Change it back.
html_split_opts = $(htmlopts) -o latex2e

# Get many small .html files.
htmlsplit: en
	@echo Making $@ ...
	rm -rf $(htmlsplit)
	mkdir $(htmlsplit) && cd $(htmlsplit) && ln -s ../* .
	cd $(htmlsplit) && $(makeinfo) $(html_split_opts) latex2e.texi
	cd $(htmlsplit)/latex2e && ln -s ../../latex2e-figures .

# Right before a commit, delete html files that are gone and add new ones.
htmlsplitstatus = cd $(htmlsplit)/latex2e && svn status *.html
commitready: easyurls
	@echo Making $@ ...
	$(htmlsplitstatus) | sed -n 's/^\!//p' | xargs -r svn rm
	$(htmlsplitstatus) | sed -n 's/^\?//p' | xargs -r svn add
# we linked everything above, remove the unused upper-level links.
	cd $(htmlsplit) && svn status | sed -n 's/^\?//p' | xargs rm -f
	rm -rf latex2e.t2dvi # fix requires rebuilding svn repo, it seems
	svn status

# A hacky spell check target.
# Remove \commandnames to reduce exception list, but not {args} or
# [args], since they are often words.
spell spell-en:
	sed -e 's/\\[a-zA-Z]*//g' -e 's/U+[0-9A-F]\{4\}//' latex2e.texi \
	| aspell list --mode=texinfo --add-extra-dicts=`pwd`/aspell.en.pws \
        | sort -f -u

# Check for doubled words.
# https://www.math.utah.edu/~beebe/software/file-tools.html#dw
# The first sed expression elides a few @-command lines which cause
# duplicates; the second expr some text in the middle of lines.
check-dw:
	sed -e 's/^@\(c\|node\|item\|anchor\|.index\|.*section\) .*//' \
	    -e 's/ da da\|xxx\|overwrite\|{test test}\|[iI][jJ]//g' \
	  latex2e.texi | dw

# Convenience targets for svn operations.
svat:
	svn status
svup:
	svn -q update
svr:
	svn revert $(addprefix latex2e*., $(all_suffixes))
	svn status
svri svrsplit:
	svn revert --depth infinity $(htmlsplit)
svd:
	svn diff -x -p $(txt_files) *.texi