From 6014da385d5f3f2a3971f0049d2d54c0dc6e95f8 Mon Sep 17 00:00:00 2001 From: Ben Pfaff Date: Fri, 27 Nov 2020 15:38:07 -0800 Subject: [PATCH] doc: Move output examples from "examples" to "pspp-figures". The Texinfo manual suggests this convention: If you want to install image files for use by Info readers too, we recommend putting them in a subdirectory like 'FOO-figures' for a package FOO. Copying the files into '$(infodir)/FOO-figures/' should be done in your 'Makefile'. Although it suggests this convention for the installed Info, it helps to use the convention for the source and build directories, because "makeinfo" looks for the files at Info build time. --- configure.ac | 2 +- doc/automake.mk | 126 +++++++++--------- doc/{examples => pspp-figures}/autorecode.sps | 0 doc/{examples => pspp-figures}/chisquare.sps | 0 doc/{examples => pspp-figures}/compute.sps | 0 doc/{examples => pspp-figures}/count.sps | 0 .../descriptives.sps | 0 doc/{examples => pspp-figures}/flip.sps | 0 .../frequencies.sps | 0 .../independent-samples-t.sps | 0 doc/{examples => pspp-figures}/means.sps | 0 .../one-sample-t.sps | 0 .../reliability.sps | 0 doc/{examples => pspp-figures}/split.sps | 0 doc/{examples => pspp-figures}/tutorial1.sps | 0 doc/{examples => pspp-figures}/tutorial2.sps | 0 doc/{examples => pspp-figures}/tutorial3.sps | 0 doc/{examples => pspp-figures}/tutorial4.sps | 0 doc/{examples => pspp-figures}/tutorial5.sps | 0 doc/{examples => pspp-figures}/tutorial6.sps | 0 doc/{examples => pspp-figures}/tutorial7.sps | 0 doc/{examples => pspp-figures}/weight.sps | 0 doc/pspp.texi | 2 +- 23 files changed, 65 insertions(+), 65 deletions(-) rename doc/{examples => pspp-figures}/autorecode.sps (100%) rename doc/{examples => pspp-figures}/chisquare.sps (100%) rename doc/{examples => pspp-figures}/compute.sps (100%) rename doc/{examples => pspp-figures}/count.sps (100%) rename doc/{examples => pspp-figures}/descriptives.sps (100%) rename doc/{examples => pspp-figures}/flip.sps (100%) rename doc/{examples => pspp-figures}/frequencies.sps (100%) rename doc/{examples => pspp-figures}/independent-samples-t.sps (100%) rename doc/{examples => pspp-figures}/means.sps (100%) rename doc/{examples => pspp-figures}/one-sample-t.sps (100%) rename doc/{examples => pspp-figures}/reliability.sps (100%) rename doc/{examples => pspp-figures}/split.sps (100%) rename doc/{examples => pspp-figures}/tutorial1.sps (100%) rename doc/{examples => pspp-figures}/tutorial2.sps (100%) rename doc/{examples => pspp-figures}/tutorial3.sps (100%) rename doc/{examples => pspp-figures}/tutorial4.sps (100%) rename doc/{examples => pspp-figures}/tutorial5.sps (100%) rename doc/{examples => pspp-figures}/tutorial6.sps (100%) rename doc/{examples => pspp-figures}/tutorial7.sps (100%) rename doc/{examples => pspp-figures}/weight.sps (100%) diff --git a/configure.ac b/configure.ac index 28ae3e4efd..2edf516a95 100644 --- a/configure.ac +++ b/configure.ac @@ -328,7 +328,7 @@ PSPP_CHECK_PREREQS AC_CONFIG_FILES( [Makefile gl/Makefile po/Makefile tests/atlocal perl-module/lib/PSPP.pm]) -AC_CONFIG_COMMANDS([doc/examples/dummy], [:]) +AC_CONFIG_COMMANDS([doc/pspp-figures/dummy], [:]) m4_ifdef([AM_SILENT_RULES], [AM_SILENT_RULES]) diff --git a/doc/automake.mk b/doc/automake.mk index 9f801bc8ac..37a62153cb 100644 --- a/doc/automake.mk +++ b/doc/automake.mk @@ -107,91 +107,91 @@ EXTRA_DIST += \ 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 +AM_MAKEINFOFLAGS=-I $(top_srcdir)/doc/pspp-figures -I $(top_builddir)/doc/pspp-figures +am__TEXINFO_TEX_DIR=:$(top_srcdir)/doc/pspp-figures:$(top_builddir)/doc/pspp-figures ################# 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_PDF = $(EXAMPLE_SPVS:.spv=.pdf) - -example-spv: $(EXAMPLE_SPVS) -example-txts: $(EXAMPLE_TXTS) -example-texis: $(EXAMPLE_TEXIS) -example-html: $(EXAMPLE_HTML) -example-pdf: $(EXAMPLE_PDF) -PHONY += example-spv example-txts example-texis example-html example-pdf - -$(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) +FIGURE_SYNTAX = \ + doc/pspp-figures/autorecode.sps \ + doc/pspp-figures/chisquare.sps \ + doc/pspp-figures/compute.sps \ + doc/pspp-figures/count.sps \ + doc/pspp-figures/descriptives.sps \ + doc/pspp-figures/flip.sps \ + doc/pspp-figures/frequencies.sps \ + doc/pspp-figures/means.sps \ + doc/pspp-figures/one-sample-t.sps \ + doc/pspp-figures/independent-samples-t.sps \ + doc/pspp-figures/reliability.sps \ + doc/pspp-figures/split.sps \ + doc/pspp-figures/tutorial1.sps \ + doc/pspp-figures/tutorial2.sps \ + doc/pspp-figures/tutorial3.sps \ + doc/pspp-figures/tutorial4.sps \ + doc/pspp-figures/tutorial5.sps \ + doc/pspp-figures/tutorial6.sps \ + doc/pspp-figures/tutorial7.sps \ + doc/pspp-figures/weight.sps + + +EXTRA_DIST += $(FIGURE_SYNTAX) + +FIGURE_SPVS = $(FIGURE_SYNTAX:.sps=.spv) \ + doc/pspp-figures/tutorial2a.spv \ + doc/pspp-figures/tutorial2b.spv \ + doc/pspp-figures/tutorial5a.spv \ + doc/pspp-figures/tutorial5b.spv \ + doc/pspp-figures/tutorial7a.spv \ + doc/pspp-figures/tutorial7b.spv +FIGURE_TXTS = $(FIGURE_SPVS:.spv=.txt) +FIGURE_TEXIS = $(FIGURE_TXTS:.txt=.texi) +FIGURE_HTML = $(FIGURE_SPVS:.spv=.html) +FIGURE_PDF = $(FIGURE_SPVS:.spv=.pdf) + +figure-spv: $(FIGURE_SPVS) +figure-txts: $(FIGURE_TXTS) +figure-texis: $(FIGURE_TEXIS) +figure-html: $(FIGURE_HTML) +figure-pdf: $(FIGURE_PDF) +PHONY += figure-spv figure-txts figure-texis figure-html figure-pdf + +$(top_builddir)/doc/pspp.info: $(FIGURE_TEXIS) +$(top_builddir)/doc/pspp.ps: $(FIGURE_TEXIS) +$(top_builddir)/doc/pspp.dvi: $(FIGURE_TEXIS) +$(top_builddir)/doc/pspp.html: $(FIGURE_HTML) +$(top_builddir)/doc/pspp.pdf: $(FIGURE_TEXIS) +$(top_builddir)/doc/pspp.xml: $(FIGURE_TEXIS) + +CLEANFILES += $(FIGURE_TXTS) $(FIGURE_SPVS) $(FIGURE_TEXIS) $(FIGURE_HTML) SUFFIXES += .sps .spv .txt .html .texi .pdf # Use pspp to process a syntax file into an output file. pspp = src/ui/terminal/pspp -$(EXAMPLE_SPVS): $(pspp)$(EXEEXT) +$(FIGURE_SPVS): $(pspp)$(EXEEXT) .sps.spv: $(AM_V_GEN)(cd $(top_srcdir)/examples \ - && $(abs_top_builddir)/$(pspp) ../doc/examples/$( $@.tmp + && $(abs_top_builddir)/$(pspp) ../doc/pspp-figures/$( $@.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) +doc/pspp-figures/tutorial2a.spv: doc/pspp-figures/tutorial2.spv $(pspp_output) $(convert) --command='Descriptives' -doc/examples/tutorial2b.spv: doc/examples/tutorial2.spv $(pspp_output) +doc/pspp-figures/tutorial2b.spv: doc/pspp-figures/tutorial2.spv $(pspp_output) $(convert) --label='Extreme Values' -doc/examples/tutorial5a.spv: doc/examples/tutorial5.spv $(pspp_output) +doc/pspp-figures/tutorial5a.spv: doc/pspp-figures/tutorial5.spv $(pspp_output) $(convert) --commands=examine --nth-command=1 --labels=descriptives -doc/examples/tutorial5b.spv: doc/examples/tutorial5.spv $(pspp_output) +doc/pspp-figures/tutorial5b.spv: doc/pspp-figures/tutorial5.spv $(pspp_output) $(convert) --commands=examine --nth-command=2 --labels=descriptives -doc/examples/tutorial7a.spv: doc/examples/tutorial7.spv $(pspp_output) +doc/pspp-figures/tutorial7a.spv: doc/pspp-figures/tutorial7.spv $(pspp_output) $(convert) --commands=regression --nth-command=1 --subtypes=coefficients -doc/examples/tutorial7b.spv: doc/examples/tutorial7.spv $(pspp_output) +doc/pspp-figures/tutorial7b.spv: doc/pspp-figures/tutorial7.spv $(pspp_output) $(convert) --commands=regression --nth-command=2 --subtypes=coefficients # Convert an output file into a text file or HTML file. -$(EXAMPLE_TXTS) $(EXAMPLE_HTML): $(pspp_output) +$(FIGURE_TXTS) $(FIGURE_HTML): $(pspp_output) .spv.txt: $(AM_V_GEN)utilities/pspp-output convert $< $@ .spv.pdf: diff --git a/doc/examples/autorecode.sps b/doc/pspp-figures/autorecode.sps similarity index 100% rename from doc/examples/autorecode.sps rename to doc/pspp-figures/autorecode.sps diff --git a/doc/examples/chisquare.sps b/doc/pspp-figures/chisquare.sps similarity index 100% rename from doc/examples/chisquare.sps rename to doc/pspp-figures/chisquare.sps diff --git a/doc/examples/compute.sps b/doc/pspp-figures/compute.sps similarity index 100% rename from doc/examples/compute.sps rename to doc/pspp-figures/compute.sps diff --git a/doc/examples/count.sps b/doc/pspp-figures/count.sps similarity index 100% rename from doc/examples/count.sps rename to doc/pspp-figures/count.sps diff --git a/doc/examples/descriptives.sps b/doc/pspp-figures/descriptives.sps similarity index 100% rename from doc/examples/descriptives.sps rename to doc/pspp-figures/descriptives.sps diff --git a/doc/examples/flip.sps b/doc/pspp-figures/flip.sps similarity index 100% rename from doc/examples/flip.sps rename to doc/pspp-figures/flip.sps diff --git a/doc/examples/frequencies.sps b/doc/pspp-figures/frequencies.sps similarity index 100% rename from doc/examples/frequencies.sps rename to doc/pspp-figures/frequencies.sps diff --git a/doc/examples/independent-samples-t.sps b/doc/pspp-figures/independent-samples-t.sps similarity index 100% rename from doc/examples/independent-samples-t.sps rename to doc/pspp-figures/independent-samples-t.sps diff --git a/doc/examples/means.sps b/doc/pspp-figures/means.sps similarity index 100% rename from doc/examples/means.sps rename to doc/pspp-figures/means.sps diff --git a/doc/examples/one-sample-t.sps b/doc/pspp-figures/one-sample-t.sps similarity index 100% rename from doc/examples/one-sample-t.sps rename to doc/pspp-figures/one-sample-t.sps diff --git a/doc/examples/reliability.sps b/doc/pspp-figures/reliability.sps similarity index 100% rename from doc/examples/reliability.sps rename to doc/pspp-figures/reliability.sps diff --git a/doc/examples/split.sps b/doc/pspp-figures/split.sps similarity index 100% rename from doc/examples/split.sps rename to doc/pspp-figures/split.sps diff --git a/doc/examples/tutorial1.sps b/doc/pspp-figures/tutorial1.sps similarity index 100% rename from doc/examples/tutorial1.sps rename to doc/pspp-figures/tutorial1.sps diff --git a/doc/examples/tutorial2.sps b/doc/pspp-figures/tutorial2.sps similarity index 100% rename from doc/examples/tutorial2.sps rename to doc/pspp-figures/tutorial2.sps diff --git a/doc/examples/tutorial3.sps b/doc/pspp-figures/tutorial3.sps similarity index 100% rename from doc/examples/tutorial3.sps rename to doc/pspp-figures/tutorial3.sps diff --git a/doc/examples/tutorial4.sps b/doc/pspp-figures/tutorial4.sps similarity index 100% rename from doc/examples/tutorial4.sps rename to doc/pspp-figures/tutorial4.sps diff --git a/doc/examples/tutorial5.sps b/doc/pspp-figures/tutorial5.sps similarity index 100% rename from doc/examples/tutorial5.sps rename to doc/pspp-figures/tutorial5.sps diff --git a/doc/examples/tutorial6.sps b/doc/pspp-figures/tutorial6.sps similarity index 100% rename from doc/examples/tutorial6.sps rename to doc/pspp-figures/tutorial6.sps diff --git a/doc/examples/tutorial7.sps b/doc/pspp-figures/tutorial7.sps similarity index 100% rename from doc/examples/tutorial7.sps rename to doc/pspp-figures/tutorial7.sps diff --git a/doc/examples/weight.sps b/doc/pspp-figures/weight.sps similarity index 100% rename from doc/examples/weight.sps rename to doc/pspp-figures/weight.sps diff --git a/doc/pspp.texi b/doc/pspp.texi index e96ca4c1ff..6914697691 100644 --- a/doc/pspp.texi +++ b/doc/pspp.texi @@ -25,7 +25,7 @@ graphic user interface @end html @cartouche @smallexample -@verbatiminclude \FILE\ +@verbatiminclude pspp-figures/\FILE\ @end smallexample @end cartouche @html -- 2.30.2