Fixed documentation problems
authorJohn Darrington <john@darrington.wattle.id.au>
Tue, 28 Nov 2006 09:39:37 +0000 (09:39 +0000)
committerJohn Darrington <john@darrington.wattle.id.au>
Tue, 28 Nov 2006 09:39:37 +0000 (09:39 +0000)
doc/ChangeLog
doc/get-commands.pl
doc/language.texi
doc/license.texi
doc/not-implemented.texi
doc/regression.texi
doc/statistics.texi

index ca7ba9a7a16132d07528b5aa92d12cbe8ab2d351..d1325342b039ab034cc4ff094ba848c0564b7582 100644 (file)
@@ -1,3 +1,13 @@
+Tue Nov 28 17:33:31 WST 2006 <john@darrington.wattle.id.au>
+
+       * get-commands.pl: Fixed generation of ni.texi, which was broken
+       after commands.def was reorganised.
+
+       * not-implemented.texi language.texi regression.texi 
+          statistics.texi: Added some indeces.
+
+       * license.texi: Added information from GPL.
+
 Sat Oct  7 11:02:44 WST 2006 <john@darrington.wattle.id.au>
 
        * Added documentation for RANK.
index c5cd163192da7cc1754fa1587eec055b99bdf011..7b6b2b581db9d2e2e3e7596f8ae7e6e68871c7ad 100755 (executable)
@@ -1,28 +1,32 @@
-
-#
+#!/usr/bin/perl
 # Creates Texinfo documentation from the source 
 
 $file = $ARGV[0]; 
 open(INFO, $file) || die "Cannot open \"$file\"\n" ;   
+print "\@c Generated from $file by get-commands.pl\n";
+print "\@c Do not modify!\n\n";
+
 print "\@table \@asis\n";
 while ($line = <INFO>)
 {
-       if ( $line =~ /^UNIMPL/ ) 
-       {
-               @fields = split(/,/,$line); 
-               $_ = $fields[0];
-               s/^UNIMPL//;
-               s/ *\(\"// ;
-               s/\"//;
-               $command = $_;
-               $_=$fields[5];
-               s/\"//;
-               s/\"\)//;
-               s/^ *//;
-               chomp;
-               $description = $_;
-               print "\@item $command\n$description\n\n";
-       }
+    if ( $line =~ /^UNIMPL_CMD/ ) 
+    {
+       @fields = split(/,/,$line); 
+       $_ = $fields[0];
+       s/^UNIMPL_CMD//;
+       s/ *\(\"// ;
+       s/\"//;
+       $command = $_;
+       $_=$fields[1];
+       s/^ *\"//;
+       s/\"\)//;
+       chomp;
+       $description = $_;
+       print "\@item $command\n$description\n\n";
+    }
 }
 print "\@end table\n";
+
+print "\@c Local Variables:\n";
+print "\@c buffer-read-only: t\n";
 close(INFO);                   # Close the file
index 3e55134566b92f392b9decb52ace04a91226f44e..7ce4d88938d03786c77fbc3f50ec3792e1850f0a 100644 (file)
@@ -524,8 +524,8 @@ Page width, in characters, in format F3.
 
 @node Sets of Variables, Input and Output Formats, System Variables, Variables
 @subsection Lists of variable names
-@cindex TO convention
-@cindex convention, TO
+@cindex @code{TO} convention
+@cindex convention, @code{TO}
 
 To refer to a set of variables, list their names one after another.
 Optionally, their names may be separated by commas.  To include a
@@ -554,6 +554,7 @@ later commands using the same syntax.
 @node Input and Output Formats, Scratch Variables, Sets of Variables, Variables
 @subsection Input and Output Formats
 
+@cindex formats
 An @dfn{input format} describes how to interpret the contents of an
 input field as a number or a string.  It might specify that the field
 contains an ordinary decimal number, a time or date, a number in binary
@@ -601,6 +602,7 @@ by PSPP.
 @node Basic Numeric Formats
 @subsubsection Basic Numeric Formats
 
+@cindex numeric formats
 The basic numeric formats are used for input and output of real numbers
 in standard or scientific notation.  The following table shows an
 example of how each format displays positive and negative numbers with
@@ -793,6 +795,7 @@ special values are output as asterisks.
 @node Custom Currency Formats
 @subsubsection Custom Currency Formats
 
+@cindex currency formats
 The custom currency formats are closely related to the basic numeric
 formats, but they allow users to customize the output format.  The
 SET command configures custom currency formats, using the syntax
@@ -943,6 +946,8 @@ machines is output as positive.
 @node Binary and Hexadecimal Numeric Formats
 @subsubsection Binary and Hexadecimal Numeric Formats
 
+@cindex binary formats
+@cindex hexadecimal formats
 The binary and hexadecimal formats are primarily designed for
 compatibility with existing machine formats, not for human readability.
 All of them therefore have a F format as default output format.  Some of
@@ -1034,6 +1039,8 @@ with half the given width.
 @node Time and Date Formats
 @subsubsection Time and Date Formats
 
+@cindex time formats
+@cindex date formats
 In PSPP, a @dfn{time} is an interval.  The time formats translate
 between human-friendly descriptions of time intervals and PSPP's
 internal representation of time intervals, which is simply the number of
@@ -1212,6 +1219,7 @@ The default output format is the same as the input format.
 @node String Formats
 @subsubsection String Formats
 
+@cindex string formats
 The A and AHEX formats are the only ones that may be assigned to string
 variables.  Neither format allows any decimal places.
 
@@ -1227,6 +1235,7 @@ format is A format with half the input width.
 @node Scratch Variables,  , Input and Output Formats, Variables
 @subsection Scratch Variables
 
+@cindex scratch variables
 Most of the time, variables don't retain their values between cases.
 Instead, either they're being read from a data file or the active file,
 in which case they assume the value read, or, if created with
index 3521a21dfc9c401c9a1a382744ac1ef4e1a042c6..7902cd1e6265b1bba69494f87d65a34cc35ddab7 100644 (file)
@@ -1,11 +1,13 @@
 @node License, Invocation, Introduction, Top
 @chapter Your rights and obligations
 @cindex license
+@cindex licence
 @cindex your rights and obligations
 @cindex rights, your
+@cindex copyright
 @cindex obligations, your
 
-PSPP is not in the public domain; it is copyrighted and there are
+PSPP is not in the public domain. It is copyrighted and there are
 restrictions on its distribution, but these restrictions are designed
 to permit everything that a good cooperating citizen would want to do.
 What is not allowed is to try to prevent others from further sharing
@@ -28,8 +30,16 @@ modified by someone else and passed on, we want their recipients to
 know that what they have is not what we distributed, so that any
 problems introduced by others will not reflect on our reputation.
 
-The precise conditions of the licenses for PSPP are found in the
-General Public Licenses that accompany them.  This manual specifically
+Finally, any free program is threatened constantly by software
+patents.  We wish to avoid the danger that redistributors of a free
+program will individually obtain patent licenses, in effect making the
+program proprietary.  To prevent this, we have made it clear that any
+patent must be licensed for everyone's free use or not licensed at all.
+
+The precise conditions of the license for PSPP are found in the
+GNU General Public License.  You should have received a copy of
+the GNU General Public License along  with this program; if not, write
+to the Free Software Foundation, Inc., 51 Franklin Street, Fifth
+Floor, Boston, MA 02110-1301 USA. This manual specifically
 is covered by the GNU Free Documentation License (@pxref{GNU Free
 Documentation License}).
-
index b38a1e5a579755999ff86a72dbcc863e581357cd..4e7f582782eeaa3cbddf3e8c1c6ef720ba465bbd 100644 (file)
@@ -4,6 +4,9 @@
 This chapter lists parts of the PSPP language that are not yet
 implemented.
 
+@cindex unimplemented commands
+@cindex commands, unimplemented
+
 @include ni.texi
 
 @setfilename ignored
index ff91df23be3827a35eb5caf63ab28c7ad3f0274c..af3c0aaf244b940f45b7cd5e276db0ac4636181a 100644 (file)
@@ -2,6 +2,8 @@
 @comment  node-name,  next,  previous,  up
 @section REGRESSION
 
+@cindex regression
+@cindex linear regression
 The REGRESSION procedure fits linear models to data via least-squares
 estimation. The procedure is appropriate for data which satisfy those
 assumptions typical in linear regression:
index 8d5971da1c04ae25116566f25682636fb69f882d..8fe77a39b6a35decd09276c41254ef8f5b43bb3b 100644 (file)
@@ -4,9 +4,6 @@
 This chapter documents the statistical procedures that PSPP supports so
 far.
 
-@c If you add any new commands, then don't forget to remove the entry in 
-@c not-implemented.texi
-
 @menu
 * DESCRIPTIVES::                Descriptive statistics.
 * FREQUENCIES::                 Frequency tables.
@@ -207,6 +204,7 @@ value, and MODE, the mode.  (If there are multiple modes, the smallest
 value is reported.)  By default, the mean, standard deviation of the
 mean, minimum, and maximum are reported for each variable.
 
+@cindex percentiles
 PERCENTILES causes the specified percentiles to be reported.
 The percentiles should  be presented at a list of numbers between 0
 and 100 inclusive.  
@@ -272,6 +270,7 @@ If the /COMPARE subcommand is ommitted, then PSPP uses the default value of
 The CINTERVAL subcommand specifies the confidence interval to use in
 calculation of the descriptives command.  The default it 95%.
 
+@cindex percentiles
 The PERCENTILES subcommand specifies which percentiles are to be calculated, 
 and which algorithm to use for calculating them.  The default is to
 calculate the 5, 10, 25, 50, 75, 90, 95 percentiles using the
@@ -414,6 +413,9 @@ The STATISTICS subcommand selects statistics for computation:
 
 @table @asis
 @item CHISQ
+@cindex chisquare
+@cindex chi-square
+
 Pearson chi-square, likelihood ratio, Fisher's exact test, continuity
 correction, linear-by-linear association.
 @item PHI
@@ -655,8 +657,6 @@ to specify different contrast tests.
 @section RANK
 
 @vindex RANK
-@cindex RANK
-
 @display
 RANK
         [VARIABLES=] var_list [@{A,D@}] [BY var_list]