Add extra code examples to the documentation

[pspp] / doc / pspp.texi

diff --git a/doc/pspp.texi b/doc/pspp.texi
index 84e4003d856be89e0a12ef1d1a3fb27bd48ca8b2..14e97b07bdeff41d55584f815d7d7ba78f7b7131 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,38 @@
 @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
+@verbatiminclude \FILE\
+@end cartouche
+@html
+</div>
+@end html
+@end macro
+
+@macro psppoutput{FILE}
+@ifnothtml
+@verbatiminclude \FILE\.out
+@end ifnothtml
+@ifhtml
+@cartouche
+@html
+
+<div class="pspp">
+@include \FILE\.html
+</div>
+
+@end html
+@end cartouche
+@end ifhtml
+@end macro
 
 @macro note{param1}
 @quotation
@@ -22,6 +54,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,