Documentation: Add some screenshots to the user manual.

[pspp] / doc / pspp.texi

diff --git a/doc/pspp.texi b/doc/pspp.texi
index 84e4003d856be89e0a12ef1d1a3fb27bd48ca8b2..1394150289d83a609766fc936898558e57ba3d74 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,56 @@
 @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 psppimage{FILE}
+@cartouche
+@ifhtml
+@image{screenshots/\FILE\-ad} @c Adwaita theme is better for web pages.
+@end ifhtml
+@iftex
+@image{screenshots/\FILE\-hc,433.62pt} @c High Contrast theme, width \\the\\hsize
+@end iftex
+@ifinfo
+@image{screenshots/\FILE\-ad} @c Adwaita theme for stand aloneinfo
+@end ifinfo
+@end cartouche
+@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 +72,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 +119,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
@@ -107,7 +163,7 @@ Free Documentation License".
 * Data Input and Output::       Reading data from user files.
 * System and Portable File IO:: Reading and writing system & portable files.
 * Combining Data Files::        Combining data from multiple files.
-* Variable Attributes::         Adjusting and examining variables.
+* Manipulating Variables::      Adjusting and examining variables.
 * Data Manipulation::           Simple operations on data.
 * Data Selection::              Select certain cases for analysis.
 * Conditionals and Looping::    Doing things many times or not at all.