From 85cef9b9391f1aaf4b27bd90a02f8ce5daf004ee Mon Sep 17 00:00:00 2001 From: John Darrington Date: Tue, 28 Nov 2006 09:39:37 +0000 Subject: [PATCH] Fixed documentation problems --- doc/ChangeLog | 10 ++++++++++ doc/get-commands.pl | 40 ++++++++++++++++++++++------------------ doc/language.texi | 13 +++++++++++-- doc/license.texi | 18 ++++++++++++++---- doc/not-implemented.texi | 3 +++ doc/regression.texi | 2 ++ doc/statistics.texi | 10 +++++----- 7 files changed, 67 insertions(+), 29 deletions(-) diff --git a/doc/ChangeLog b/doc/ChangeLog index ca7ba9a7..d1325342 100644 --- a/doc/ChangeLog +++ b/doc/ChangeLog @@ -1,3 +1,13 @@ +Tue Nov 28 17:33:31 WST 2006 + + * 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 * Added documentation for RANK. diff --git a/doc/get-commands.pl b/doc/get-commands.pl index c5cd1631..7b6b2b58 100755 --- a/doc/get-commands.pl +++ b/doc/get-commands.pl @@ -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 = ) { - 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 diff --git a/doc/language.texi b/doc/language.texi index 3e551345..7ce4d889 100644 --- a/doc/language.texi +++ b/doc/language.texi @@ -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 diff --git a/doc/license.texi b/doc/license.texi index 3521a21d..7902cd1e 100644 --- a/doc/license.texi +++ b/doc/license.texi @@ -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}). - diff --git a/doc/not-implemented.texi b/doc/not-implemented.texi index b38a1e5a..4e7f5827 100644 --- a/doc/not-implemented.texi +++ b/doc/not-implemented.texi @@ -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 diff --git a/doc/regression.texi b/doc/regression.texi index ff91df23..af3c0aaf 100644 --- a/doc/regression.texi +++ b/doc/regression.texi @@ -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: diff --git a/doc/statistics.texi b/doc/statistics.texi index 8d5971da..8fe77a39 100644 --- a/doc/statistics.texi +++ b/doc/statistics.texi @@ -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] -- 2.30.2