work on docs
[pspp] / doc / pspp.texi
index 7c7c4da6eff18daf213c70c12ab104257f0936ce..204feada5862577aad02fbdf37cbf51b6c870e80 100644 (file)
@@ -1,4 +1,13 @@
 \input texinfo @c -*- texinfo -*-
+@c PSPP - a program for statistical analysis.
+@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;
+@c with no Invariant Sections, no Front-Cover Texts, and no Back-Cover Texts.
+@c A copy of the license is included in the section entitled "GNU
+@c Free Documentation License".
+
 @c %**start of header
 @setfilename pspp.info
 @settitle PSPP
@@ -6,6 +15,74 @@
 @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}
+@c Use @image for Info and for plaintext output.
+@ifinfo
+
+@noindent @image{pspp-figures/\FILE\}
+
+@end ifinfo
+@ifplaintext
+
+@noindent @image{pspp-figures/\FILE\}
+
+@end ifplaintext
+@c Use HTML for HTML output.
+@ifhtml
+@cartouche
+@html
+
+<div class="pspp">
+@include pspp-figures/\FILE\.html
+</div>
+
+@end html
+@end cartouche
+@end ifhtml
+@c Use the Texi-fied version of the plaintext output for other output formats.
+@c Some of these could do better, but we have not yet implemented it.
+@ifnotinfo
+@ifnotplaintext
+@ifnothtml
+@smallexample
+@include pspp-figures/\FILE\.texi
+@end smallexample
+@end ifnothtml
+@end ifnotplaintext
+@end ifnotinfo
+@end macro
 
 @macro note{param1}
 @quotation
 @end quotation
 @end macro
 
+@ifnottex
+@macro times{}
+@end macro
+@macro ne{}
+≠
+@end macro
+@end ifnottex
+
+@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, 
+@c This macro should be used for marking command names.  For the purposes of markup,
 @c  no distinction is made between ``commands'' and ``procedures''.
 @macro cmd{CMDNAME}
 @code{\CMDNAME\}
 @sc{pspp}
 @end macro
 
-
-@ifset MISSING_CLICKSEQUENCE
-@alias clicksequence = asis
-@macro click {}
-->
-@end macro
-@end ifset
-
 @iftex
 @finalout
 @end iftex
 This manual is for GNU PSPP version @value{VERSION},
 software for statistical analysis.
 
-Copyright @copyright{} 1997, 1998, 2004, 2005, 2009, 2012, 2013, 2014, 2016 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
@@ -75,13 +159,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
 
 
@@ -105,14 +182,16 @@ in the production of this manual.
 * 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.
 * Statistics::                  Basic statistical procedures.
+* Matrices::                    Matrix operations and transformations.
 * 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.
@@ -139,9 +218,11 @@ in the production of this manual.
 @include data-selection.texi
 @include flow-control.texi
 @include statistics.texi
+@include matrices.texi
 @include utilities.texi
 
 @include pspp-convert.texi
+@include pspp-output.texi
 @include pspp-dump-sav.texi
 @include not-implemented.texi
 @include bugs.texi
@@ -153,8 +234,3 @@ in the production of this manual.
 @include fdl.texi
 
 @bye
-
-@c Local Variables:
-@c use (texinfo-multiple-files-update "pspp.texi")  in emacs to keep these files consistent
-@c compile-command: "makeinfo pspp.texi"
-@c End: