summaryrefslogtreecommitdiff
path: root/Master/texmf-dist/doc/latex/struktex/struktex.mk
blob: c652b677e50716d19d3121cfb0060a945452a835 (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
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283

#-----------------------------------------------------------------------
# Purpose: generation of the documentation of the struktex package
# Notice:  this file can be used only with dmake and the option "-B";
#          this option lets dmake interpret the leading spaces as
#          distinguishing characters for commands in the make rules.
#
# Rules:
#          - all-de:     generate all the files and the (basic) german
#                        documentation
#          - all-en:     generate all the files and the (basic) english
#                        documentation
#          - test:       format the examples
#          - history:    generate the documentation with revision
#                        history
#          - develop-de: generate the german documentation with revision
#                        history and source code
#          - develop-en: generate the english documentation with
#                        revision history and source code
#          - realclean
#          - clean
#          - clean-example
#
# Author:  Jobst Hoffmann, Fachhochschule Aachen, Standort Juelich
# Date:    2017/06/06
#-----------------------------------------------------------------------

# The texmf-directory, where to install new stuff (see texmf.cnf)
# If you don't know what to do, search for directory texmf at /usr.
# With teTeX and linux often one of following is used:
#INSTALLTEXMF=/usr/TeX/texmf
#INSTALLTEXMF=/usr/local/TeX/texmf
#INSTALLTEXMF=/usr/share/texmf
#INSTALLTEXMF=/usr/local/share/texmf
# user tree:
#INSTALLTEXMF=$(HOME)/texmf
# Try to use user's tree known by kpsewhich:
INSTALLTEXMF=`kpsewhich --expand-var '$$TEXMFHOME'`
# Try to use the local tree known by kpsewhich:
#INSTALLTEXMF=`kpsewhich --expand-var '$$TEXMFLOCAL'`
# But you may set INSTALLTEXMF to every directory you want.
# Use following, if you only want to test the installation:
#INSTALLTEXMF=/tmp/texmf

# If texhash must run after installation, you can invoke this:
TEXHASH=texhash

######### Edit following only, if you want to change defaults!

# The directory, where to install *.cls and *.sty
CLSDIR=$(INSTALLTEXMF)/tex/latex/$(PACKAGE)

# The directory, where to install documentation
DOCDIR=$(INSTALLTEXMF)/doc/latex/$(PACKAGE)

# The directory, where to install the sources
SRCDIR=$(INSTALLTEXMF)/source/latex/$(PACKAGE)

# The directory, where to install demo-files
# If we have some, we have to add following 2 lines to install rule:
#     $(MKDIR) $(DEMODIR); \
#     $(INSTALL) $(DEMO_FILES) $(DEMODIR); \
DEMODIR=$(DOCDIR)/demo

# We need this, because the documentation needs the classes and packages
# It's not really a good solution, but it's a working solution.
TEXINPUTS := $(PWD):$(TEXINPUTS)

########################################################################
#   End of customization section
########################################################################

LATEX = latex
PDFLATEX = pdflatex
TEX = TEX

COMMON_OPTIONS = # \OnlyDescription\CodelineNumbered\PageIndex
HISTORY_OPTIONS = \RecordChanges
DEVELOPER_OPTIONS = \EnableCrossrefs\RecordChanges\AlsoImplementation\CodelineIndex

# tarring options
EXgit = --exclude .git --exclude .gitignore --exclude auto --exclude tests \
 --exclude *.tgz --exclude *.bib

# The name of the game
PACKAGE = struktex

DISTRIBUTION_FILES = ../$(PACKAGE)/$(PACKAGE).de.pdf \
../$(PACKAGE)/$(PACKAGE).en.pdf \
 ../$(PACKAGE)/$(PACKAGE).dtx \
 ../$(PACKAGE)/$(PACKAGE).ins \
 ../$(PACKAGE)/LIESMICH.md \
 ../$(PACKAGE)/README.md
PACKAGE_FILES_A = $(subst ../$(PACKAGE)/,,$(DISTRIBUTION_FILES))
PACKAGE_FILES_B = $(subst $(PACKAGE).dtx ,,$(PACKAGE_FILES_A))
PACKAGE_FILES_C = $(subst $(PACKAGE).ins ,,$(PACKAGE_FILES_B))
PACKAGE_FILES_D = $(subst LIESMICH.md,,$(PACKAGE_FILES_C))
PACKAGE_FILES = $(subst README.md,,$(PACKAGE_FILES_D))

# To generate the version number of the distribution from the source
VERSION_L := git describe --long | xargs git --no-pager show -s \
         --date=short --format=format:"$(PACKAGE) version ???? of %ad%n" |\
         sed -e "s/????/`git describe --long`/"
VERSION_S := `git describe --long | \
             sed 's+-g.*++'`

# to create the correct tar-file
define TAR_COMMANDS
echo $$@
OUT_DIR=$$(mktemp -d)
mkdir $${OUT_DIR}/struktex
cp $$@ $${OUT_DIR}/struktex
pushd $${OUT_DIR}
tar cfvz struktex.tgz struktex
popd
cp $${OUT_DIR}/struktex.tgz .
endef

export TAR_COMMANDS

## Main Targets

# strip off the comments from the package
$(PACKAGE).sty $(PACKAGE)-test-*.tex: $(PACKAGE).ins $(PACKAGE).dtx $(PACKAGE).sed
 +$(TEX) $<; \
  source $(PACKAGE).makemake; \
  make revision_no; \
  source $(PACKAGE).sed  # set version number

all-de: $(PACKAGE).de.pdf

all-en: $(PACKAGE).en.pdf

# prepare the file with git revision information
.PHONY: revision_no
revision_no: $(PACKAGE).sed

$(PACKAGE).sed: $(PACKAGE).dtx
 printf "%b\n" "set_git_info() {" \
    > $(PACKAGE).sed; \
 printf "%b\n" "sed -i -e 's/^[ \\\\t]*%% git revision information$$/\\"  \
    >> $(PACKAGE).sed; \
 git describe --long | \
    xargs git --no-pager show -s --format=format:\
 "    \\\\@git@ \$$Date: %ci $$%%\%n" >> $(PACKAGE).sed; \
 git describe --long | cut -c 2- |\
    sed -e "s/^/      \$$Revision: /" -e "s/$$/ $$\\\\/" \
    >> $(PACKAGE).sed; \
 git describe --long | \
    xargs git --no-pager show -s --format=format:"    %%%% \$$Author: %an $$\\%n" \
    >> $(PACKAGE).sed; \
 printf "%b\n" "/' \$$1" \
    >> $(PACKAGE).sed; \
 printf "%b\n" "};" \
    >> $(PACKAGE).sed; \
 printf "%b\n" "for f in  \\\\" \
    >> $(PACKAGE).sed; \
 printf "%b\n" "$(PACKAGE).sty \\\\" \
    >> $(PACKAGE).sed; \
 printf "%b\n" "struktxf.sty \\\\" \
    >> $(PACKAGE).sed; \
 printf "%b\n" "struktxp.sty \\\\" \
    >> $(PACKAGE).sed; \
 printf "%b\n" "strukdoc.sty \\\\" \
    >> $(PACKAGE).sed; \
 printf "%b\n" "; do \\\\" \
    >> $(PACKAGE).sed; \
 printf "%b\n" "  set_git_info \$$f; done" \
    >> $(PACKAGE).sed; \

# generate the documentation
$(PACKAGE).de.pdf: $(PACKAGE).dtx $(PACKAGE).sty struktex.sed
 +$(PDFLATEX) "\AtBeginDocument{$(COMMON_OPTIONS)}\input{$<}"
 +$(PDFLATEX) "\AtBeginDocument{$(COMMON_OPTIONS)}\input{$<}"
 +mv $(<:.dtx=.pdf) $(<:.dtx=.de.pdf)

$(PACKAGE).en.pdf: $(PACKAGE).dtx $(PACKAGE).sty
 +$(PDFLATEX) "\AtBeginDocument{$(COMMON_OPTIONS)}\def\primarylanguage{english}\input{$<}"
 +$(PDFLATEX) "\AtBeginDocument{$(COMMON_OPTIONS)}\def\primarylanguage{english}\input{$<}"
 +mv $(<:.dtx=.pdf) $(<:.dtx=.en.pdf)

# generate the documentation with revision history (only german)
history: $(PACKAGE).dtx $(PACKAGE).sty
 +$(PDFLATEX) "\AtBeginDocument{$(COMMON_OPTIONS)$(HISTORY_OPTIONS)}\input{$<}"
 +$(PDFLATEX) "\AtBeginDocument{$(COMMON_OPTIONS)$(HISTORY_OPTIONS)}\input{$<}"
 +makeindex -s gind.ist                 $(PACKAGE).idx
 +makeindex -s gglo.ist -o $(PACKAGE).gls -t $(PACKAGE).glg $(PACKAGE).glo
 +$(PDFLATEX) "\AtBeginDocument{$(COMMON_OPTIONS)$(HISTORY_OPTIONS)}\input{$<}"

# generate the documentation for the developer (revision history always
# in german)
develop-de: $(PACKAGE).dtx $(PACKAGE).sty
 +$(PDFLATEX) "\AtBeginDocument{$(HISTORY_OPTIONS)$(DEVELOPER_OPTIONS)}\input{$<}"
 +$(PDFLATEX) "\AtBeginDocument{$(HISTORY_OPTIONS)$(DEVELOPER_OPTIONS)}\input{$<}"
 +makeindex -s gind.ist                 $(PACKAGE).idx
 +makeindex -s gglo.ist -o $(PACKAGE).gls -t $(PACKAGE).glg $(PACKAGE).glo
 +$(PDFLATEX) "\AtBeginDocument{$(HISTORY_OPTIONS)$(DEVELOPER_OPTIONS)}\input{$<}"
 +mv $(<:.dtx=.pdf) $(<:.dtx=.de.pdf)

develop-en: $(PACKAGE).dtx $(PACKAGE).sty
 +$(PDFLATEX) "\AtBeginDocument{$(COMMON_OPTIONS)$(DEVELOPER_OPTIONS)}\def\primarylanguage{english}\input{$<}"
 +$(PDFLATEX) "\AtBeginDocument{$(COMMON_OPTIONS)$(DEVELOPER_OPTIONS)}\def\primarylanguage{english}\input{$<}"
 +makeindex -s gind.ist                 $(PACKAGE).idx
 +makeindex -s gglo.ist -o $(PACKAGE).gls -t $(PACKAGE).glg $(PACKAGE).glo
 +$(PDFLATEX) "\AtBeginDocument{$(COMMON_OPTIONS)$(DEVELOPER_OPTIONS)}\def\primarylanguage{english}\input{$<}"
 +mv $(<:.dtx=.pdf) $(<:.dtx=.en.pdf)

# format the example/test files
test:
 for i in `seq 1 3`; do \
     f=$(PACKAGE)-test-$$i; \
     echo file: $$f; \
     $(PDFLATEX) $$f; \
 done

install: $(PACKAGE).dtx $(PACKAGE).dvi
 [ -d $(CLSDIR) ] || mkdir -p $(CLSDIR)
 [ -d $(DOCDIR) ] || mkdir -p $(DOCDIR)
 [ -d $(SRCDIR) ] || mkdir -p $(SRCDIR)
 cp $(PACKAGE).sty      $(CLSDIR)
 cp $(PACKAGE).dvi      $(DOCDIR)
 cp $(PACKAGE).ins      $(SRCDIR)
 cp $(PACKAGE).dtx      $(SRCDIR)
 cp $(PACKAGE)-test-*.tex   $(SRCDIR)
 cp LIESMICH        $(SRCDIR)
 cp README          $(SRCDIR)
 cp THIS-IS-VERSION-$(VERSION)  $(SRCDIR)

uninstall:
 rm -f  $(CLSDIR)/$(PACKAGE).sty
 rm -fr $(DOCDIR)
 rm -fr $(SRCDIR)

dist: $(PACKAGE).de.pdf $(PACKAGE).en.pdf  $(PACKAGE).dtx  $(PACKAGE).ins \
LIESMICH.md README.md
 + echo "$$TAR_COMMANDS" > ./tar_commands; \
 rm -f THIS_IS_VERSION_*; \
 $(VERSION_L) > THIS_IS_VERSION_$(VERSION_S); \
 sh  ./tar_commands $^; \
 mv ./struktex.tgz ./struktex-$(VERSION_S).tgz
 rm ./tar_commands

tds-zip:  $(PACKAGE_FILES)
 + rm -f THIS_IS_VERSION_* *.zip; \
 $(VERSION_L) | sed -e "s/??????????/$(VERSION_S)/" > THIS_IS_VERSION_$(VERSION_S); \
 DOC_FILES="LIESMICH.md README.md THIS_IS_* $(PACKAGE).??.pdf"; \
 MAKE_FILES="$(PACKAGE).m*"; \
 SRC_FILES="$(PACKAGE).dtx $(PACKAGE).ins"; \
 STY_FILES="struk*.sty"; \
 TEST_FILES="./$(PACKAGE)-test*"; \
 SUPPORT_FILES="./$(PACKAGE).el"; \
 if [[ -d /tmp/texmf ]]; then \
   rm -rf /tmp/texmf; \
 fi; \
 if [[ -f $(PACKAGE)-TDS.zip ]]; then \
   rm $(PACKAGE)-TDS.zip; \
 fi; \
 mkdir -p /tmp/texmf/doc/latex/$(PACKAGE); \
 mkdir -p /tmp/texmf/source/latex/$(PACKAGE); \
 mkdir -p /tmp/texmf/tex/latex/$(PACKAGE); \
 cp -a $${DOC_FILES} /tmp/texmf/doc/latex/$(PACKAGE); \
 cp -a $${MAKE_FILES} /tmp/texmf/doc/latex/$(PACKAGE); \
 cp -a $${SRC_FILES} /tmp/texmf/source/latex/$(PACKAGE); \
 cp -a $${STY_FILES} /tmp/texmf/tex/latex/$(PACKAGE); \
 cp -a $${TEST_FILES} /tmp/texmf/doc/latex/$(PACKAGE); \
 cp -a $${SUPPORT_FILES} /tmp/texmf/doc/latex/$(PACKAGE); \
 VERSION_SHORT="xxx"; \
 pushd /tmp/texmf; \
 zip -r /tmp/$(PACKAGE)-TDS.zip .; \
 popd; \
 mv /tmp/$(PACKAGE)-TDS.zip ./$(PACKAGE)-TDS-$(VERSION_S).zip

clean:
 -rm -f *.log *.aux *.brf *.idx *.ilg *.ind
 -rm -f *.glg *.glo *.gls *.lof *.lot *.out *.toc *.tmp *~
 -rm *.mk *.makemake

realclean:  clean
 -rm -f *.sty *.cls *.pdf
 -rm -f *-test-* Makefile

clean-test:
 rm $(PACKAGE)-test-*.* # this $-sign is needed for font-locking in XEmacs only