Documentation: Add an example showing how AGGREGATE works

[pspp] / doc / pspp.texi

diff --git a/doc/pspp.texi b/doc/pspp.texi
index 7da31a4e83817543ede02a4da1b08e249707f5d8..1af4275be012422427f17dfa4a65b980c8a8d563 100644 (file)
--- a/doc/pspp.texi
+++ b/doc/pspp.texi
@@ -1,6 +1,6 @@
 \input texinfo @c -*- texinfo -*-
 @c PSPP - a program for statistical analysis.
-@c Copyright (C) 2017, 2019 Free Software Foundation, Inc.
+@c Copyright (C) 2017, 2019, 2020 Free Software Foundation, Inc.
 @c Permission is granted to copy, distribute and/or modify this document
 @c under the terms of the GNU Free Documentation License, Version 1.3
 @c or any later version published by the Free Software Foundation;
@@ -15,6 +15,42 @@
 @c @setchapternewpage odd
 @c %**end of header
 
+@macro gui
+graphic user interface
+@end macro
+
+@macro psppsyntax{FILE}
+@html
+<div class="pspp-syntax">
+@end html
+@cartouche
+@smallexample
+@verbatiminclude pspp-figures/\FILE\
+@end smallexample
+@end cartouche
+@html
+</div>
+@end html
+@end macro
+
+@macro psppoutput{FILE}
+@ifnothtml
+@smallexample
+@include pspp-figures/\FILE\.texi
+@end smallexample
+@end ifnothtml
+@ifhtml
+@cartouche
+@html
+
+<div class="pspp">
+@include pspp-figures/\FILE\.html
+</div>
+
+@end html
+@end cartouche
+@end ifhtml
+@end macro
 
 @macro note{param1}
 @quotation
@@ -22,6 +58,12 @@
 @end quotation
 @end macro
 
+@c A macro to indicate variable names used in examples.
+@c NOT metasyntactical variables - for that use @var
+@macro exvar{VAR}
+@b{\VAR\}
+@end macro
+
 @include version.texi
 
 @c This macro should be used for marking command names.  For the purposes of markup,
@@ -63,7 +105,7 @@
 This manual is for GNU PSPP version @value{VERSION},
 software for statistical analysis.
 
-Copyright @copyright{} 1997, 1998, 2004, 2005, 2009, 2012, 2013, 2014, 2016, 2019 Free Software Foundation, Inc.
+Copyright @copyright{} 1997, 1998, 2004, 2005, 2009, 2012, 2013, 2014, 2016, 2019, 2020 Free Software Foundation, Inc.
 
 @quotation
 Permission is granted to copy, distribute and/or modify this document
@@ -84,13 +126,6 @@ Free Documentation License".
 @insertcopying
 @end titlepage
 
-@c @chapheading Acknowledgements
-The authors wish to thank Network Theory Ltd
-@url{http://www.network-theory.co.uk}
-for their financial support
-in the production of this manual.
-
-
 @contents
 
 
@@ -122,6 +157,7 @@ in the production of this manual.
 * Utilities::                   Other commands.
 
 * Invoking pspp-convert::       Utility for converting among file formats.
+* Invoking pspp-output::        Utility for working with viewer (SPV) files.
 * Invoking pspp-dump-sav::      Utility for examining raw .sav files.
 * Not Implemented::             What's not here yet
 * Bugs::                        Known problems; submitting bug reports.
@@ -151,6 +187,7 @@ in the production of this manual.
 @include utilities.texi
 
 @include pspp-convert.texi
+@include pspp-output.texi
 @include pspp-dump-sav.texi
 @include not-implemented.texi
 @include bugs.texi