User manual: Move some sentances out of the future tense.
[pspp] / doc / automake.mk
index 61a35f9fe339abd0b666e75fadbc716d86aed51a..bf09d6a3eb13b8e50ab509fb08cc529716ee664e 100644 (file)
@@ -70,19 +70,16 @@ EXTRA_DIST += doc/get-commands.pl \
               doc/prepdoc.sh
 
 $(srcdir)/doc/ni.texi: $(top_srcdir)/src/language/command.def doc/get-commands.pl
-       @$(MKDIR_P)  doc
        $(AM_V_GEN)$(PERL) $(top_srcdir)/doc/get-commands.pl $(top_srcdir)/src/language/command.def > $@
 
 $(srcdir)/doc/tut.texi:
-       @$(MKDIR_P) doc
        $(AM_V_GEN)echo "@set example-dir $(examplesdir)" > $@
 
 
-$(srcdir)/doc/pspp.xml: doc/pspp.texi $(doc_pspp_TEXINFOS) $(top_srcdir)/doc/help-pages-list
+doc/pspp.xml: doc/pspp.texi $(doc_pspp_TEXINFOS) doc/help-pages-list
 if BROKEN_DOCBOOK_XML
        touch $@
 else
-       @$(MKDIR_P)  doc
        $(AM_V_GEN)$(MAKEINFO) $(AM_MAKEINFOFLAGS) --docbook -I $(top_srcdir) \
                $< -o $@
 endif
@@ -91,13 +88,13 @@ docbookdir = $(docdir)
 dist_docbook_DATA = doc/pspp.xml
 
 
-CLEANFILES += pspp-dev.dvi $(docbook_DATA) doc/pspp.info*
+CLEANFILES += pspp-dev.dvi $(docbook_DATA) doc/pspp.info* doc/pspp.xml
 
 
 doc: $(INFO_DEPS) $(DVIS) $(PDFS) $(PSS) $(HTMLS) $(dist_docbook_DATA)
 PHONY += doc
 
-$(top_srcdir)/doc/help-pages-list: $(UI_FILES)
+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
@@ -127,52 +124,108 @@ EXAMPLE_SYNTAX = \
  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_OUTPUTS = $(EXAMPLE_SYNTAX:.sps=.out)
-EXAMPLE_HTML = $(EXAMPLE_SYNTAX:.sps=.html)
-
-$(top_builddir)/doc/pspp.info:  $(EXAMPLE_OUTPUTS)
-$(top_builddir)/doc/pspp.ps:    $(EXAMPLE_OUTPUTS)
-$(top_builddir)/doc/pspp.dvi:   $(EXAMPLE_OUTPUTS)
+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_OUTPUTS)
-
-# The examples cannot be built until the binary has been built
-$(EXAMPLE_OUTPUTS): $(top_builddir)/src/ui/terminal/pspp
-$(EXAMPLE_HTML): $(top_builddir)/src/ui/terminal/pspp
-
-CLEANFILES += $(EXAMPLE_OUTPUTS)
-
-SUFFIXES: .sps
-
-# use pspp to process a syntax file and reap the output into a text file
-.sps.out:
-       $(MKDIR_P) $(@D)
-       where=$$PWD ; \
-       (cd $(top_srcdir)/examples; ${abs_builddir}/src/ui/terminal/pspp $(abs_srcdir)/doc/examples/$(<F) -o $$where/$@)
-
-# Use pspp to process a syntax file and reap the output into a html file
-# Then, use sed to delete everything up to and including <body> and
-# everything after and including </body>
-.sps.html:
-       $(MKDIR_P) $(@D)
-       where=$$PWD ; \
-       (cd $(top_srcdir)/examples; ${abs_builddir}/src/ui/terminal/pspp $(abs_srcdir)/doc/examples/$(<F) -o $$where/$@,x -O format=html)
-       $(SED) -e '\%</body%,$$d' -e '0,/<body/d' $@,x > $@
-
-# 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
-
+$(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 -O bare=true > $@.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 $@
+
+AM_MAKEINFOHTMLFLAGS = $(AM_MAKEINFOFLAGS) --css-ref=pspp-manual.css
 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