Documentation: Add some screenshots to the user manual.
[pspp] / doc / automake.mk
1 ## PSPP - a program for statistical analysis.
2 ## Copyright (C) 2019, 2020 Free Software Foundation, Inc.
3 ##
4 ## This program is free software: you can redistribute it and/or modify
5 ## it under the terms of the GNU General Public License as published by
6 ## the Free Software Foundation, either version 3 of the License, or
7 ## (at your option) any later version.
8 ##
9 ## This program is distributed in the hope that it will be useful,
10 ## but WITHOUT ANY WARRANTY; without even the implied warranty of
11 ## MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
12 ## GNU General Public License for more details.
13 ##
14 ## You should have received a copy of the GNU General Public License
15 ## along with this program.  If not, see <http://www.gnu.org/licenses/>.
16
17 ## Process this file with automake to produce Makefile.in  -*- makefile -*-
18
19 info_TEXINFOS = doc/pspp.texi doc/pspp-dev.texi
20
21 doc_pspp_TEXINFOS = doc/version.texi \
22         doc/bugs.texi \
23         doc/command-index.texi \
24         doc/concept-index.texi \
25         doc/data-io.texi \
26         doc/data-selection.texi \
27         doc/expressions.texi \
28         doc/files.texi \
29         doc/combining.texi \
30         doc/flow-control.texi \
31         doc/function-index.texi \
32         doc/installing.texi \
33         doc/introduction.texi \
34         doc/invoking.texi \
35         doc/language.texi \
36         doc/license.texi \
37         doc/pspp-convert.texi \
38         doc/pspp-output.texi \
39         doc/pspp-dump-sav.texi \
40         doc/ni.texi \
41         doc/not-implemented.texi \
42         doc/statistics.texi \
43         doc/transformation.texi \
44         doc/tutorial.texi \
45         doc/tut.texi \
46         doc/regression.texi \
47         doc/utilities.texi \
48         doc/variables.texi \
49         doc/fdl.texi
50
51 doc_pspp_dev_TEXINFOS = doc/version-dev.texi \
52         doc/dev/intro.texi \
53         doc/dev/concepts.texi \
54         doc/dev/syntax.texi \
55         doc/dev/data.texi \
56         doc/dev/i18n.texi \
57         doc/dev/output.texi \
58         doc/dev/system-file-format.texi \
59         doc/dev/pc+-file-format.texi \
60         doc/dev/portable-file-format.texi \
61         doc/dev/spv-file-format.texi \
62         doc/dev/tlo-file-format.texi \
63         doc/dev/encrypted-file-wrappers.texi \
64         doc/dev/q2c.texi
65
66 dist_man_MANS += doc/pspp.1 \
67                  doc/psppire.1
68
69 EXTRA_DIST += doc/get-commands.pl \
70               doc/help-pages-list \
71               doc/prepdoc.sh
72
73 $(srcdir)/doc/ni.texi: $(top_srcdir)/src/language/command.def doc/get-commands.pl
74         $(AM_V_GEN)$(PERL) $(top_srcdir)/doc/get-commands.pl $(top_srcdir)/src/language/command.def > $@
75
76 $(srcdir)/doc/tut.texi:
77         $(AM_V_GEN)echo "@set example-dir $(examplesdir)" > $@
78
79
80 doc/pspp.xml: doc/pspp.texi $(doc_pspp_TEXINFOS) doc/help-pages-list
81 if BROKEN_DOCBOOK_XML
82         touch $@
83 else
84         $(AM_V_GEN)$(MAKEINFO) --docbook $(AM_MAKEINFOFLAGS) $(MAKEINFOFLAGS) \
85                 -I doc -I $(srcdir)/doc $< -o $@
86 endif
87
88 docbookdir = $(docdir)
89 dist_docbook_DATA = doc/pspp.xml
90
91
92 CLEANFILES += pspp-dev.dvi $(docbook_DATA) doc/pspp.info* doc/pspp.xml
93
94
95 doc: $(INFO_DEPS) $(DVIS) $(PDFS) $(PSS) $(HTMLS) $(dist_docbook_DATA)
96 PHONY += doc
97
98 doc/help-pages-list: $(UI_FILES)
99          $(AM_V_GEN)cat $^ | grep '"help[-_]page"' | \
100    $(SED) -e 's% *<property name="help[-_]page">\([^<]*\)</property>%//*[@id='"'"'\1'"'"']%' \
101         -e 's%#%'"'"']/*[@id='"'"'%g' > $@,tmp
102         test -s $@,tmp
103         mv $@,tmp $@
104
105 EXTRA_DIST += \
106         doc/help-pages-list \
107         doc/pspp-manual.css
108
109 am__TEXINFO_TEX_DIR=:$(top_srcdir)/doc:$(top_builddir)/doc
110
111 ################# Example programs ##############################
112
113 FIGURE_SYNTAX = \
114  doc/pspp-figures/aggregate.sps \
115  doc/pspp-figures/autorecode.sps \
116  doc/pspp-figures/chisquare.sps \
117  doc/pspp-figures/compute.sps \
118  doc/pspp-figures/count.sps \
119  doc/pspp-figures/descriptives.sps \
120  doc/pspp-figures/flip.sps \
121  doc/pspp-figures/frequencies.sps \
122  doc/pspp-figures/means.sps \
123  doc/pspp-figures/one-sample-t.sps \
124  doc/pspp-figures/independent-samples-t.sps \
125  doc/pspp-figures/reliability.sps \
126  doc/pspp-figures/select-if.sps \
127  doc/pspp-figures/sort-cases.sps \
128  doc/pspp-figures/split.sps \
129  doc/pspp-figures/temporary.sps \
130  doc/pspp-figures/tutorial1.sps \
131  doc/pspp-figures/tutorial2.sps \
132  doc/pspp-figures/tutorial3.sps \
133  doc/pspp-figures/tutorial4.sps \
134  doc/pspp-figures/tutorial5.sps \
135  doc/pspp-figures/tutorial6.sps \
136  doc/pspp-figures/tutorial7.sps \
137  doc/pspp-figures/weight.sps
138
139
140 EXTRA_DIST += $(FIGURE_SYNTAX)
141
142 FIGURE_SPVS = $(FIGURE_SYNTAX:.sps=.spv) \
143         doc/pspp-figures/tutorial2a.spv \
144         doc/pspp-figures/tutorial2b.spv \
145         doc/pspp-figures/tutorial5a.spv \
146         doc/pspp-figures/tutorial5b.spv \
147         doc/pspp-figures/tutorial7a.spv \
148         doc/pspp-figures/tutorial7b.spv
149 FIGURE_TXTS = $(FIGURE_SPVS:.spv=.txt)
150 FIGURE_TEXIS = $(FIGURE_TXTS:.txt=.texi)
151 FIGURE_HTMLS = $(FIGURE_SPVS:.spv=.html)
152 FIGURE_PDFS = $(FIGURE_SPVS:.spv=.pdf)
153
154 figure-spvs: $(FIGURE_SPVS)
155 figure-txts: $(FIGURE_TXTS)
156 figure-texis: $(FIGURE_TEXIS)
157 figure-htmls: $(FIGURE_HTMLS)
158 figure-pdfs: $(FIGURE_PDFS)
159 PHONY += figure-spv figure-txts figure-texis figure-htmls figure-pdfs
160
161 $(top_builddir)/doc/pspp.info:  $(FIGURE_TEXIS)
162 $(top_builddir)/doc/pspp.ps:    $(FIGURE_TEXIS)
163 $(top_builddir)/doc/pspp.dvi:   $(FIGURE_TEXIS)
164 $(top_builddir)/doc/pspp.html:  $(FIGURE_HTMLS)
165 $(top_builddir)/doc/pspp.pdf:   $(FIGURE_TEXIS)
166 $(top_builddir)/doc/pspp.xml:   $(FIGURE_TEXIS)
167
168 CLEANFILES += $(FIGURE_TXTS) $(FIGURE_SPVS) $(FIGURE_TEXIS) $(FIGURE_HTMLS)
169 SUFFIXES += .sps .spv .txt .html .texi .pdf
170
171 # Use pspp to process a syntax file into an output file.
172 pspp = src/ui/terminal/pspp
173 $(FIGURE_SPVS): $(pspp)$(EXEEXT)
174 .sps.spv:
175         $(AM_V_GEN)(cd $(top_srcdir)/examples \
176          && $(abs_top_builddir)/$(pspp) ../doc/pspp-figures/$(<F) -o - -O format=spv) > $@.tmp
177         $(AM_V_at)mv $@.tmp $@
178
179 # In some cases, the tutorial only wants some parts of the output.
180 pspp_output = utilities/pspp-output
181 convert = $(AM_V_GEN)$(pspp_output) convert $< $@
182 doc/pspp-figures/tutorial2a.spv: doc/pspp-figures/tutorial2.spv $(pspp_output)
183         $(convert) --command='Descriptives'
184 doc/pspp-figures/tutorial2b.spv: doc/pspp-figures/tutorial2.spv $(pspp_output)
185         $(convert) --label='Extreme Values'
186 doc/pspp-figures/tutorial5a.spv: doc/pspp-figures/tutorial5.spv $(pspp_output)
187         $(convert) --commands=examine --nth-command=1 --labels=descriptives
188 doc/pspp-figures/tutorial5b.spv: doc/pspp-figures/tutorial5.spv $(pspp_output)
189         $(convert) --commands=examine --nth-command=2 --labels=descriptives
190 doc/pspp-figures/tutorial7a.spv: doc/pspp-figures/tutorial7.spv $(pspp_output)
191         $(convert) --commands=regression --nth-command=1 --subtypes=coefficients
192 doc/pspp-figures/tutorial7b.spv: doc/pspp-figures/tutorial7.spv $(pspp_output)
193         $(convert) --commands=regression --nth-command=2 --subtypes=coefficients
194
195 # Convert an output file into a text file or HTML file.
196 $(FIGURE_TXTS) $(FIGURE_HTMLS): $(pspp_output)
197 .spv.txt:
198         $(convert)
199 .spv.pdf:
200         $(convert) -O left-margin=0pt -O right-margin=0pt -O top-margin=0pt -O bottom-margin=0pt -O paper-size=6x20in -O font-size=12000 --table-look=$(HOME)/pspp/spss15/Looks/report.tlo
201 .spv.html:
202         $(convert) -O format=html -O bare=true
203
204 # Convert a text file into a Texinfo file.
205 .txt.texi:
206         $(AM_V_GEN)$(SED) -e 's/@/@@/g' $< > $@
207
208 AM_MAKEINFOHTMLFLAGS = $(AM_MAKEINFOFLAGS) --css-ref=pspp-manual.css
209 # Adjust the path for screenshot images.
210 # But make sure these operations are idempotent.
211 html-local:
212         for h in doc/pspp.html/*.html; do \
213                 if grep -Fq '<img src="screenshots/' $$h; then continue; fi ; \
214                 $(SED) -i -e 's|<img src="\([^"]*\)"|<img src="screenshots/\1"|' $$h; \
215         done
216
217 install-html-local: html-local $(HTML_SCREENSHOTS)
218         $(MKDIR_P) $(DESTDIR)$(prefix)/share/doc/pspp/pspp.html
219         $(INSTALL) -d $(DESTDIR)$(prefix)/share/doc/pspp/pspp.html/screenshots
220         for p in $(HTML_SCREENSHOTS); do \
221                 $(INSTALL_DATA) $$p $(DESTDIR)$(prefix)/share/doc/pspp/pspp.html/screenshots ;\
222         done
223         $(INSTALL_DATA) ${top_srcdir}/doc/pspp-manual.css $(DESTDIR)$(prefix)/share/doc/pspp/pspp.html
224
225 \f
226
227 desktopdir = $(datadir)/applications
228
229 doc/org.fsf.pspp.metainfo.xml: doc/org.fsf.pspp.metainfo.xml.in $(POFILES)
230         $(AM_V_GEN)$(MSGFMT) --xml --template $< -o $@ -d $(top_srcdir)/po || \
231           $(MSGFMT) -L appdata --xml --template $< -o $@ -d $(top_srcdir)/po
232
233 doc/org.fsf.pspp.desktop: doc/org.fsf.pspp.desktop.in $(POFILES)
234         $(AM_V_GEN)$(MSGFMT) --desktop --template $< -o $@ -d $(top_srcdir)/po
235
236 CLEANFILES+=doc/org.fsf.pspp.desktop \
237             doc/org.fsf.pspp.metainfo.xml
238
239 desktop_DATA = doc/org.fsf.pspp.desktop
240
241 appdatadir = $(datadir)/metainfo
242 dist_appdata_DATA = doc/org.fsf.pspp.metainfo.xml
243
244 EXTRA_DIST += doc/org.fsf.pspp.metainfo.xml.in \
245         doc/org.fsf.pspp.desktop.in
246
247 \f
248
249 SCREENSHOTS = \
250 $(top_srcdir)/doc/screenshots/autorecode.grab \
251 $(top_srcdir)/doc/screenshots/chisquare.grab \
252 $(top_srcdir)/doc/screenshots/count.grab \
253 $(top_srcdir)/doc/screenshots/count-define.grab \
254 $(top_srcdir)/doc/screenshots/compute.grab \
255 $(top_srcdir)/doc/screenshots/descriptives.grab \
256 $(top_srcdir)/doc/screenshots/one-sample-t.grab \
257 $(top_srcdir)/doc/screenshots/independent-samples-t.grab \
258 $(top_srcdir)/doc/screenshots/define-groups-t.grab \
259 $(top_srcdir)/doc/screenshots/frequencies.grab \
260 $(top_srcdir)/doc/screenshots/reliability.grab \
261 $(top_srcdir)/doc/screenshots/split-status-bar.grab \
262 $(top_srcdir)/doc/screenshots/sort-simple.grab \
263 $(top_srcdir)/doc/screenshots/sort.grab
264
265
266 PDF_SCREENSHOTS =  $(SCREENSHOTS:.grab=-hc.png)
267 EPS_SCREENSHOTS =  $(SCREENSHOTS:.grab=-hc.eps)
268 HTML_SCREENSHOTS = $(SCREENSHOTS:.grab=-ad.png)
269 INFO_SCREENSHOTS = $(SCREENSHOTS:.grab=-ad.png)
270
271 doc-make: doc/doc-make.in Makefile
272         $(SED) -e 's|%top_srcdir%|@top_srcdir@|g' \
273         -e 's|%abs_builddir%|@abs_builddir@|g' \
274         -e 's|%MKDIR_P%|@MKDIR_P@|g' \
275         -e 's|%src_ui_gui_psppiredir%|$(src_ui_gui_psppiredir)|g' \
276         -e 's|%UI_FILES%|$(UI_FILES)|g' \
277         -e 's|%IMAGES%|$(INFO_SCREENSHOTS) $(HTML_SCREENSHOTS) $(EPS_SCREENSHOTS) $(PDF_SCREENSHOTS)|g' \
278         $< > $@
279
280
281 # Install all the PNG files so that info readers can recognise them
282 install-info-local:
283         $(MKDIR_P) $(DESTDIR)$(prefix)/share/info/
284         for p in $(INFO_SCREENSHOTS); do \
285                 $(INSTALL_DATA) $$p $(DESTDIR)$(prefix)/share/info/ ;\
286         done
287
288 uninstall-local:
289         for p in $(INFO_SCREENSHOTS); do \
290                 f=`basename $$p ` ; \
291                 $(RM) $(DESTDIR)$(prefix)/share/info/$$f ; \
292         done
293
294 EXTRA_DIST+= $(SCREENSHOTS) doc/doc-make.in doc/screengrab
295
296 EXTRA_DIST+= $(EPS_SCREENSHOTS) $(PDF_SCREENSHOTS) $(INFO_SCREENSHOTS)