Documentation: New example for the temporary command
[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/autorecode.sps \
115  doc/pspp-figures/chisquare.sps \
116  doc/pspp-figures/compute.sps \
117  doc/pspp-figures/count.sps \
118  doc/pspp-figures/descriptives.sps \
119  doc/pspp-figures/flip.sps \
120  doc/pspp-figures/frequencies.sps \
121  doc/pspp-figures/means.sps \
122  doc/pspp-figures/one-sample-t.sps \
123  doc/pspp-figures/independent-samples-t.sps \
124  doc/pspp-figures/reliability.sps \
125  doc/pspp-figures/split.sps \
126  doc/pspp-figures/temporary.sps \
127  doc/pspp-figures/tutorial1.sps \
128  doc/pspp-figures/tutorial2.sps \
129  doc/pspp-figures/tutorial3.sps \
130  doc/pspp-figures/tutorial4.sps \
131  doc/pspp-figures/tutorial5.sps \
132  doc/pspp-figures/tutorial6.sps \
133  doc/pspp-figures/tutorial7.sps \
134  doc/pspp-figures/weight.sps
135
136
137 EXTRA_DIST += $(FIGURE_SYNTAX)
138
139 FIGURE_SPVS = $(FIGURE_SYNTAX:.sps=.spv) \
140         doc/pspp-figures/tutorial2a.spv \
141         doc/pspp-figures/tutorial2b.spv \
142         doc/pspp-figures/tutorial5a.spv \
143         doc/pspp-figures/tutorial5b.spv \
144         doc/pspp-figures/tutorial7a.spv \
145         doc/pspp-figures/tutorial7b.spv
146 FIGURE_TXTS = $(FIGURE_SPVS:.spv=.txt)
147 FIGURE_TEXIS = $(FIGURE_TXTS:.txt=.texi)
148 FIGURE_HTMLS = $(FIGURE_SPVS:.spv=.html)
149 FIGURE_PDFS = $(FIGURE_SPVS:.spv=.pdf)
150
151 figure-spvs: $(FIGURE_SPVS)
152 figure-txts: $(FIGURE_TXTS)
153 figure-texis: $(FIGURE_TEXIS)
154 figure-htmls: $(FIGURE_HTMLS)
155 figure-pdfs: $(FIGURE_PDFS)
156 PHONY += figure-spv figure-txts figure-texis figure-htmls figure-pdfs
157
158 $(top_builddir)/doc/pspp.info:  $(FIGURE_TEXIS)
159 $(top_builddir)/doc/pspp.ps:    $(FIGURE_TEXIS)
160 $(top_builddir)/doc/pspp.dvi:   $(FIGURE_TEXIS)
161 $(top_builddir)/doc/pspp.html:  $(FIGURE_HTMLS)
162 $(top_builddir)/doc/pspp.pdf:   $(FIGURE_TEXIS)
163 $(top_builddir)/doc/pspp.xml:   $(FIGURE_TEXIS)
164
165 CLEANFILES += $(FIGURE_TXTS) $(FIGURE_SPVS) $(FIGURE_TEXIS) $(FIGURE_HTMLS)
166 SUFFIXES += .sps .spv .txt .html .texi .pdf
167
168 # Use pspp to process a syntax file into an output file.
169 pspp = src/ui/terminal/pspp
170 $(FIGURE_SPVS): $(pspp)$(EXEEXT)
171 .sps.spv:
172         $(AM_V_GEN)(cd $(top_srcdir)/examples \
173          && $(abs_top_builddir)/$(pspp) ../doc/pspp-figures/$(<F) -o - -O format=spv) > $@.tmp
174         $(AM_V_at)mv $@.tmp $@
175
176 # In some cases, the tutorial only wants some parts of the output.
177 pspp_output = utilities/pspp-output
178 convert = $(AM_V_GEN)$(pspp_output) convert $< $@
179 doc/pspp-figures/tutorial2a.spv: doc/pspp-figures/tutorial2.spv $(pspp_output)
180         $(convert) --command='Descriptives'
181 doc/pspp-figures/tutorial2b.spv: doc/pspp-figures/tutorial2.spv $(pspp_output)
182         $(convert) --label='Extreme Values'
183 doc/pspp-figures/tutorial5a.spv: doc/pspp-figures/tutorial5.spv $(pspp_output)
184         $(convert) --commands=examine --nth-command=1 --labels=descriptives
185 doc/pspp-figures/tutorial5b.spv: doc/pspp-figures/tutorial5.spv $(pspp_output)
186         $(convert) --commands=examine --nth-command=2 --labels=descriptives
187 doc/pspp-figures/tutorial7a.spv: doc/pspp-figures/tutorial7.spv $(pspp_output)
188         $(convert) --commands=regression --nth-command=1 --subtypes=coefficients
189 doc/pspp-figures/tutorial7b.spv: doc/pspp-figures/tutorial7.spv $(pspp_output)
190         $(convert) --commands=regression --nth-command=2 --subtypes=coefficients
191
192 # Convert an output file into a text file or HTML file.
193 $(FIGURE_TXTS) $(FIGURE_HTMLS): $(pspp_output)
194 .spv.txt:
195         $(convert)
196 .spv.pdf:
197         $(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
198 .spv.html:
199         $(convert) -O format=html -O bare=true
200
201 # Convert a text file into a Texinfo file.
202 .txt.texi:
203         $(AM_V_GEN)$(SED) -e 's/@/@@/g' $< > $@
204
205 AM_MAKEINFOHTMLFLAGS = $(AM_MAKEINFOFLAGS) --css-ref=pspp-manual.css
206 html-local:
207
208 install-html-local: html-local
209         $(MKDIR_P) $(DESTDIR)$(prefix)/share/doc/pspp/pspp.html
210         $(INSTALL_DATA) ${top_srcdir}/doc/pspp-manual.css $(DESTDIR)$(prefix)/share/doc/pspp/pspp.html
211
212
213 \f
214
215 desktopdir = $(datadir)/applications
216
217 doc/org.fsf.pspp.metainfo.xml: doc/org.fsf.pspp.metainfo.xml.in $(POFILES)
218         $(AM_V_GEN)$(MSGFMT) --xml --template $< -o $@ -d $(top_srcdir)/po || \
219           $(MSGFMT) -L appdata --xml --template $< -o $@ -d $(top_srcdir)/po
220
221 doc/org.fsf.pspp.desktop: doc/org.fsf.pspp.desktop.in $(POFILES)
222         $(AM_V_GEN)$(MSGFMT) --desktop --template $< -o $@ -d $(top_srcdir)/po
223
224 CLEANFILES+=doc/org.fsf.pspp.desktop \
225             doc/org.fsf.pspp.metainfo.xml
226
227 desktop_DATA = doc/org.fsf.pspp.desktop
228
229 appdatadir = $(datadir)/metainfo
230 dist_appdata_DATA = doc/org.fsf.pspp.metainfo.xml
231
232 EXTRA_DIST += doc/org.fsf.pspp.metainfo.xml.in \
233         doc/org.fsf.pspp.desktop.in