doc: Fix use of @psppsyntax that should have been @psppoutput.
[pspp] / doc / automake.mk
index 54af89a6ffc051248294aebb97f8f1d88990ee87..801f278ce653a1fb8956a6c362b227befdd9d390 100644 (file)
@@ -1,3 +1,19 @@
+## PSPP - a program for statistical analysis.
+## Copyright (C) 2019, 2020 Free Software Foundation, Inc.
+##
+## This program 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.
+##
+## This program 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.
+##
+## You should have received a copy of the GNU General Public License
+## along with this program.  If not, see <http://www.gnu.org/licenses/>.
+
 ## Process this file with automake to produce Makefile.in  -*- makefile -*-
 
 info_TEXINFOS = doc/pspp.texi doc/pspp-dev.texi
@@ -19,6 +35,8 @@ doc_pspp_TEXINFOS = doc/version.texi \
        doc/language.texi \
        doc/license.texi \
        doc/pspp-convert.texi \
+       doc/pspp-output.texi \
+       doc/pspp-dump-sav.texi \
        doc/ni.texi \
        doc/not-implemented.texi \
        doc/statistics.texi \
@@ -28,7 +46,7 @@ doc_pspp_TEXINFOS = doc/version.texi \
        doc/regression.texi \
        doc/utilities.texi \
        doc/variables.texi \
-       doc/fdl.texi 
+       doc/fdl.texi
 
 doc_pspp_dev_TEXINFOS = doc/version-dev.texi \
        doc/dev/intro.texi \
@@ -38,50 +56,185 @@ doc_pspp_dev_TEXINFOS = doc/version-dev.texi \
        doc/dev/i18n.texi \
        doc/dev/output.texi \
        doc/dev/system-file-format.texi \
+       doc/dev/pc+-file-format.texi \
        doc/dev/portable-file-format.texi \
+       doc/dev/spv-file-format.texi \
+       doc/dev/encrypted-file-wrappers.texi \
        doc/dev/q2c.texi
 
-EXTRA_DIST += doc/pspp.man \
-       doc/get-commands.pl
+dist_man_MANS += doc/pspp.1 \
+                 doc/psppire.1
+
+EXTRA_DIST += doc/get-commands.pl \
+              doc/help-pages-list \
+              doc/prepdoc.sh
 
 $(srcdir)/doc/ni.texi: $(top_srcdir)/src/language/command.def doc/get-commands.pl
-       @$(MKDIR_P)  doc
-       $(PERL) $(top_srcdir)/doc/get-commands.pl $(top_srcdir)/src/language/command.def > $@
+       $(AM_V_GEN)$(PERL) $(top_srcdir)/doc/get-commands.pl $(top_srcdir)/src/language/command.def > $@
 
 $(srcdir)/doc/tut.texi:
-       @$(MKDIR_P) doc
-       echo "@set example-dir $(examplesdir)" > $@
-
-
-# The SED and AWK filters in this rule, are to work-around some nasty bugs in makeinfo version 4.13, which produces
-# broken docbook xml.  These workarounds are rather horrible and must be removed asap.
-$(srcdir)/doc/pspp.xml: doc/pspp.texi $(doc_pspp_TEXINFOS)
-       @$(MKDIR_P)  doc
-       $(MAKEINFO) $(AM_MAKEINFOFLAGS) --docbook -I $(top_srcdir) \
-               $(top_srcdir)/doc/pspp.texi -o - \
-               | $(SED) -e 's/Time-&-Date/Time-\&amp;-Date/g' \
-               -e 's/&ldquo;/\&#8220;/g' \
-               -e 's/&rdquo;/\&#8221;/g' \
-               -e 's/&lsquo;/\&#8216;/g' \
-               -e 's/&rsquo;/\&#8217;/g' \
-               -e 's/&mdash;/\&#8212;/g' \
-               -e 's/&ndash;/\&#8242;/g' \
-                -e 's/&eacute;/\&#0233;/g' \
-               -e 's/&copy;/\&#0169;/g' \
-               -e 's/&minus;/\&#8722;/g' \
-               -e 's/&hellip;/\&#8230;/g' \
-               -e 's/&bull;/\&#2022;/g' \
-               -e 's/&period;/./g' \
-               -e 's%\(<figure [^>]*\)>%\1/>%g' \
-        | $(AWK) '/<para>.*<table.*>.*<\/para>/{x=sub("</para>",""); print; s=1;next}/<\/table>/{print; if (s==1) print "</para>"; s=0; next}1' \
-       > $@
-       $(XMLLINT) --output /dev/null $@ || ( $(RM) $@ ; false)
+       $(AM_V_GEN)echo "@set example-dir $(examplesdir)" > $@
+
+
+doc/pspp.xml: doc/pspp.texi $(doc_pspp_TEXINFOS) doc/help-pages-list
+if BROKEN_DOCBOOK_XML
+       touch $@
+else
+       $(AM_V_GEN)$(MAKEINFO) $(AM_MAKEINFOFLAGS) --docbook -I $(top_srcdir) \
+               $< -o $@
+endif
 
 docbookdir = $(docdir)
 dist_docbook_DATA = doc/pspp.xml
 
-CLEANFILES += pspp-dev.dvi $(docbook_DATA)
+
+CLEANFILES += pspp-dev.dvi $(docbook_DATA) doc/pspp.info* doc/pspp.xml
+
 
 doc: $(INFO_DEPS) $(DVIS) $(PDFS) $(PSS) $(HTMLS) $(dist_docbook_DATA)
-.PHONY: doc
+PHONY += doc
+
+doc/help-pages-list: $(UI_FILES)
+        $(AM_V_GEN)cat $^ | grep '"help[-_]page"' | \
+   $(SED) -e 's% *<property name="help[-_]page">\([^<]*\)</property>%//*[@id='"'"'\1'"'"']%' \
+       -e 's%#%'"'"']/*[@id='"'"'%g' > $@,tmp
+       test -s $@,tmp
+       mv $@,tmp $@
+
+EXTRA_DIST += \
+       doc/help-pages-list \
+       doc/pspp-manual.css
+
+
+AM_MAKEINFOFLAGS=-I $(top_srcdir)/doc/examples -I $(top_builddir)/doc/examples
+am__TEXINFO_TEX_DIR=:$(top_srcdir)/doc/examples:$(top_builddir)/doc/examples
+
+################# Example programs ##############################
+
+EXAMPLE_SYNTAX = \
+ doc/examples/autorecode.sps \
+ doc/examples/chisquare.sps \
+ doc/examples/compute.sps \
+ doc/examples/count.sps \
+ doc/examples/descriptives.sps \
+ doc/examples/flip.sps \
+ doc/examples/frequencies.sps \
+ doc/examples/means.sps \
+ doc/examples/one-sample-t.sps \
+ doc/examples/independent-samples-t.sps \
+ doc/examples/reliability.sps \
+ doc/examples/split.sps \
+ doc/examples/tutorial1.sps \
+ doc/examples/tutorial2.sps \
+ doc/examples/tutorial3.sps \
+ doc/examples/tutorial4.sps \
+ doc/examples/tutorial5.sps \
+ doc/examples/tutorial6.sps \
+ doc/examples/tutorial7.sps \
+ doc/examples/weight.sps
+
+
+EXTRA_DIST += $(EXAMPLE_SYNTAX)
+
+EXAMPLE_SPVS = $(EXAMPLE_SYNTAX:.sps=.spv) \
+       doc/examples/tutorial2a.spv \
+       doc/examples/tutorial2b.spv \
+       doc/examples/tutorial5a.spv \
+       doc/examples/tutorial5b.spv \
+       doc/examples/tutorial7a.spv \
+       doc/examples/tutorial7b.spv
+EXAMPLE_TXTS = $(EXAMPLE_SPVS:.spv=.txt)
+EXAMPLE_TEXIS = $(EXAMPLE_TXTS:.txt=.texi)
+EXAMPLE_HTML = $(EXAMPLE_SPVS:.spv=.html)
+
+example-spv: $(EXAMPLE_SPVS)
+example-txts: $(EXAMPLE_TXTS)
+example-texis: $(EXAMPLE_TEXIS)
+example-html: $(EXAMPLE_HTML)
+PHONY += example-spv example-txts example-texis example-html
+
+$(top_builddir)/doc/pspp.info:  $(EXAMPLE_TEXIS)
+$(top_builddir)/doc/pspp.ps:    $(EXAMPLE_TEXIS)
+$(top_builddir)/doc/pspp.dvi:   $(EXAMPLE_TEXIS)
+$(top_builddir)/doc/pspp.html:  $(EXAMPLE_HTML)
+$(top_builddir)/doc/pspp.pdf:   $(EXAMPLE_TEXIS)
+$(top_builddir)/doc/pspp.xml:   $(EXAMPLE_TEXIS)
+
+CLEANFILES += $(EXAMPLE_TXTS) $(EXAMPLE_SPVS) $(EXAMPLE_TEXIS) $(EXAMPLE_HTML)
+SUFFIXES += .sps .spv .txt .html .texi
+
+# Use pspp to process a syntax file into an output file.
+pspp = src/ui/terminal/pspp
+$(EXAMPLE_SPVS): $(pspp)
+.sps.spv:
+       $(AM_V_GEN)(cd $(top_srcdir)/examples \
+         && $(abs_top_builddir)/$(pspp) ../doc/examples/$(<F) -o - -O format=spv) > $@.tmp
+       $(AM_V_at)mv $@.tmp $@
+
+# In some cases, the tutorial only wants some parts of the output.
+pspp_output = utilities/pspp-output
+convert = $(AM_V_GEN)$(pspp_output) convert $< $@
+doc/examples/tutorial2a.spv: doc/examples/tutorial2.spv $(pspp_output)
+       $(convert) --command='Descriptives'
+doc/examples/tutorial2b.spv: doc/examples/tutorial2.spv $(pspp_output)
+       $(convert) --label='Extreme Values'
+doc/examples/tutorial5a.spv: doc/examples/tutorial5.spv $(pspp_output)
+       $(convert) --commands=examine --nth-command=1 --labels=descriptives
+doc/examples/tutorial5b.spv: doc/examples/tutorial5.spv $(pspp_output)
+       $(convert) --commands=examine --nth-command=2 --labels=descriptives
+doc/examples/tutorial7a.spv: doc/examples/tutorial7.spv $(pspp_output)
+       $(convert) --commands=regression --nth-command=1 --subtypes=coefficients
+doc/examples/tutorial7b.spv: doc/examples/tutorial7.spv $(pspp_output)
+       $(convert) --commands=regression --nth-command=2 --subtypes=coefficients
+
+# Convert an output file into a text file or HTML file.
+#
+# (For HTML, use sed to include only the contents of <body>.)
+$(EXAMPLE_TXTS) $(EXAMPLE_HTML): $(pspp_output)
+.spv.txt:
+       $(AM_V_GEN)utilities/pspp-output convert $< $@
+.spv.html:
+       $(AM_V_GEN)utilities/pspp-output convert $< - -O format=html \
+       | $(SED) -e '\%</body%,$$d' -e '0,/<body/d' > $@.tmp
+       $(AM_V_at)mv $@.tmp $@
+
+# Convert a text file into a Texinfo file.
+.txt.texi:
+       $(AM_V_GEN)sed 's/@/@@/g' < $< > $@.tmp
+       $(AM_V_at)mv $@.tmp $@
+
+# Insert the link tag for the cascading style sheet.
+# But make sure these operations are idempotent.
+html-local:
+       for h in doc/pspp.html/*.html; do \
+               if grep -Fq '<link rel="stylesheet"' $$h; then continue; fi ; \
+               $(SED) -i -e '/^<\/head>/i \\\
+<link rel="stylesheet" href="pspp-manual.css">' $$h; \
+       done
+
+install-html-local: html-local
+       $(MKDIR_P) $(DESTDIR)$(prefix)/share/doc/pspp/pspp.html
+       $(INSTALL_DATA) ${top_srcdir}/doc/pspp-manual.css $(DESTDIR)$(prefix)/share/doc/pspp/pspp.html
+
+
+\f
+
+desktopdir = $(datadir)/applications
+
+doc/org.fsf.pspp.metainfo.xml: doc/org.fsf.pspp.metainfo.xml.in $(POFILES)
+       $(AM_V_GEN)$(MSGFMT) --xml --template $< -o $@ -d $(top_srcdir)/po || \
+         $(MSGFMT) -L appdata --xml --template $< -o $@ -d $(top_srcdir)/po
+
+doc/org.fsf.pspp.desktop: doc/org.fsf.pspp.desktop.in $(POFILES)
+       $(AM_V_GEN)$(MSGFMT) --desktop --template $< -o $@ -d $(top_srcdir)/po
+
+CLEANFILES+=doc/org.fsf.pspp.desktop \
+            doc/org.fsf.pspp.metainfo.xml
+
+desktop_DATA = doc/org.fsf.pspp.desktop
+
+appdatadir = $(datadir)/metainfo
+dist_appdata_DATA = doc/org.fsf.pspp.metainfo.xml
+
+EXTRA_DIST += doc/org.fsf.pspp.metainfo.xml.in \
+       doc/org.fsf.pspp.desktop.in