From: Ben Pfaff Date: Thu, 5 Jun 2025 00:05:48 +0000 (-0700) Subject: work on manual X-Git-Url: https://pintos-os.org/cgi-bin/gitweb.cgi?a=commitdiff_plain;h=8d059fda987d613121b855409b5788c340f95b45;p=pspp work on manual --- diff --git a/rust/doc/src/commands/combining/index.md b/rust/doc/src/commands/combining/index.md index d42e7a1d8b..17d7708ebe 100644 --- a/rust/doc/src/commands/combining/index.md +++ b/rust/doc/src/commands/combining/index.md @@ -97,12 +97,12 @@ dictionary of the new active dataset, like so: specified input file that has a variable label for that variable, and similarly for value labels and missing values. -- The file label of the new active dataset (*note FILE LABEL::) is - that of the first specified `FILE` that has a file label. +- The [file label](../utilities/file-label.md) of the new active + dataset is that of the first specified `FILE` that has a file label. -- The documents in the new active dataset (*note DOCUMENT::) are the - concatenation of all the input files' documents, in the order in - which the `FILE` subcommands are specified. +- The [documents](../utilities/document.md) in the new active dataset + are the concatenation of all the input files' documents, in the + order in which the `FILE` subcommands are specified. - If all of the input files are weighted on the same variable, then the new active dataset is weighted on that variable. Otherwise, diff --git a/rust/doc/src/commands/control/loop.md b/rust/doc/src/commands/control/loop.md index 0f91468201..0f9b390f14 100644 --- a/rust/doc/src/commands/control/loop.md +++ b/rust/doc/src/commands/control/loop.md @@ -44,9 +44,9 @@ block is executed. The condition is evaluated at the end of the loop, not at the beginning, so that the body of a loop with only a condition on `END LOOP` will always execute at least once. -If the index clause is not present, then the global `MXLOOPS` -setting, which defaults to 40, limits the number of iterations (*note -SET MXLOOPS::). +If the index clause is not present, then the global +[`MXLOOPS`](../utilities/set.md#mxloops) setting, which defaults to +40, limits the number of iterations. [`BREAK`](break.md) also terminates `LOOP` execution. diff --git a/rust/doc/src/commands/data-io/begin-data.md b/rust/doc/src/commands/data-io/begin-data.md index f75c1b005d..cdda868537 100644 --- a/rust/doc/src/commands/data-io/begin-data.md +++ b/rust/doc/src/commands/data-io/begin-data.md @@ -7,8 +7,8 @@ END DATA. ``` `BEGIN DATA` and `END DATA` can be used to embed raw ASCII data in a -PSPP syntax file. `DATA LIST` or another input procedure must be used -before `BEGIN DATA` (*note DATA LIST::). `BEGIN DATA` and `END DATA` -must be used together. `END DATA` must appear by itself on a single -line, with no leading white space and exactly one space between the -words `END` and `DATA`. +PSPP syntax file. [`DATA LIST`](data-list.md) or another input +procedure must be used before `BEGIN DATA`. `BEGIN DATA` and `END +DATA` must be used together. `END DATA` must appear by itself on a +single line, with no leading white space and exactly one space between +the words `END` and `DATA`. diff --git a/rust/doc/src/commands/data-io/data-list.md b/rust/doc/src/commands/data-io/data-list.md index a205413b3a..00c30146d5 100644 --- a/rust/doc/src/commands/data-io/data-list.md +++ b/rust/doc/src/commands/data-io/data-list.md @@ -78,8 +78,8 @@ of the variable on the line: columnar style and FORTRAN style. field are specified after the variable name, separated by a dash (`-`). For instance, the third through fifth columns on a line would be specified `3-5`. By default, variables are considered to be in -[`F` format](../../language/datasets/formats/basic.html). (This -default can be changed; see *note SET:: for more information.) +[`F` format](../../language/datasets/formats/basic.html). (Use [`SET +FORMAT`](../utilities/set.md#format) to change the default.) In columnar style, to use a variable format other than the default, specify the format type in parentheses after the column numbers. For @@ -218,15 +218,15 @@ where each VAR_SPEC takes one of the forms VAR_LIST * ``` - In free format, the input data is, by default, structured as a series -of fields separated by spaces, tabs, or line breaks. If the current -`DECIMAL` separator is `DOT` (*note SET::), then commas are also treated -as field separators. Each field's content may be unquoted, or it may be -quoted with a pairs of apostrophes (`'`) or double quotes (`"`). -Unquoted white space separates fields but is not part of any field. Any -mix of spaces, tabs, and line breaks is equivalent to a single space for -the purpose of separating fields, but consecutive commas will skip a -field. + In free format, the input data is, by default, structured as a +series of fields separated by spaces, tabs, or line breaks. If the +current [`DECIMAL`](../utilities/set.md#decimal) separator is `DOT`, +then commas are also treated as field separators. Each field's +content may be unquoted, or it may be quoted with a pairs of +apostrophes (`'`) or double quotes (`"`). Unquoted white space +separates fields but is not part of any field. Any mix of spaces, +tabs, and line breaks is equivalent to a single space for the purpose +of separating fields, but consecutive commas will skip a field. Alternatively, delimiters can be specified explicitly, as a parenthesized, comma-separated list of single-character strings diff --git a/rust/doc/src/commands/data-io/datafile-attribute.md b/rust/doc/src/commands/data-io/datafile-attribute.md index 0e0a6f4f60..9fcfb16180 100644 --- a/rust/doc/src/commands/data-io/datafile-attribute.md +++ b/rust/doc/src/commands/data-io/datafile-attribute.md @@ -35,9 +35,9 @@ attribute array. In the latter case, all the array elements numbered higher than the deleted element are shifted down, filling the vacated position. - To associate custom attributes with particular variables, instead of -with the entire active dataset, use `VARIABLE ATTRIBUTE` (*note VARIABLE -ATTRIBUTE::) instead. + To associate custom attributes with particular variables, instead +of with the entire active dataset, use [`VARIABLE +ATTRIBUTE`](../variables/variable-attribute.md) instead. `DATAFILE ATTRIBUTE` takes effect immediately. It is not affected by conditional and looping structures such as `DO IF` or `LOOP`. diff --git a/rust/doc/src/commands/data-io/dataset.md b/rust/doc/src/commands/data-io/dataset.md index 03f8da857f..1c2c71d0b1 100644 --- a/rust/doc/src/commands/data-io/dataset.md +++ b/rust/doc/src/commands/data-io/dataset.md @@ -31,11 +31,11 @@ making the copy. If a dataset with the given name already exists, it is replaced. If the name is the name of the active dataset, then the active dataset becomes unnamed. - The `DATASET DECLARE` command creates a new dataset that is initially -"empty," that is, it has no dictionary or data. If a dataset with the -given name already exists, this has no effect. The new dataset can be -used with commands that support output to a dataset, e.g. AGGREGATE -(*note AGGREGATE::). + The `DATASET DECLARE` command creates a new dataset that is +initially "empty," that is, it has no dictionary or data. If a +dataset with the given name already exists, this has no effect. The +new dataset can be used with commands that support output to a +dataset, such as. [`AGGREGATE`](../data/aggregate.md). The `DATASET CLOSE` command deletes a dataset. If the active dataset is specified by name, or if `*` is specified, then the active dataset diff --git a/rust/doc/src/commands/data-io/file-handle.md b/rust/doc/src/commands/data-io/file-handle.md index 909bfe07e4..72ebe282e4 100644 --- a/rust/doc/src/commands/data-io/file-handle.md +++ b/rust/doc/src/commands/data-io/file-handle.md @@ -176,9 +176,9 @@ use is forbidden. The `ENCODING` subcommand specifies the encoding of text in the file. For reading text files in `CHARACTER` mode, all of the forms -described for `ENCODING` on the `INSERT` command are supported (*note -INSERT::). For reading in other file-based modes, encoding -autodetection is not supported; if the specified encoding requests -autodetection then the default encoding is used. This is also true -when a file handle is used for writing a file in any mode. +described for `ENCODING` on the [`INSERT`](../utilities/insert.md) +command are supported. For reading in other file-based modes, +encoding autodetection is not supported; if the specified encoding +requests autodetection then the default encoding is used. This is +also true when a file handle is used for writing a file in any mode. diff --git a/rust/doc/src/commands/data-io/print.md b/rust/doc/src/commands/data-io/print.md index 79bf679d7d..8fea40363e 100644 --- a/rust/doc/src/commands/data-io/print.md +++ b/rust/doc/src/commands/data-io/print.md @@ -16,9 +16,10 @@ ARG takes one of the following forms: ``` The `PRINT` transformation writes variable data to the listing file -or an output file. `PRINT` is executed when a procedure causes the data -to be read. Follow `PRINT` by `EXECUTE` to print variable data without -invoking a procedure (*note EXECUTE::). +or an output file. `PRINT` is executed when a procedure causes the +data to be read. Follow `PRINT` by +[`EXECUTE`](../utilities/execute.md) to print variable data without +invoking a procedure. All `PRINT` subcommands are optional. If no strings or variables are specified, `PRINT` outputs a single blank line. diff --git a/rust/doc/src/commands/data-io/repeating-data.md b/rust/doc/src/commands/data-io/repeating-data.md index 94c4b21236..02ca4eb40b 100644 --- a/rust/doc/src/commands/data-io/repeating-data.md +++ b/rust/doc/src/commands/data-io/repeating-data.md @@ -74,6 +74,6 @@ columns that the identifier will occupy, followed by an equals sign been declared with `NUMERIC` or another command. `REPEATING DATA` should be the last command given within an [`INPUT -PROGRAM`](input-program.md). It should not be enclosed within a -`LOOP` structure (*note LOOP::). Use `DATA LIST` before, not after, -`REPEATING DATA`. +PROGRAM`](input-program.md). It should not be enclosed within +[`LOOP`…`END LOOP`](../control/loop.md). Use `DATA LIST` before, not +after, [`REPEATING DATA`](../data-io/repeating-data.md). diff --git a/rust/doc/src/commands/data/aggregate.md b/rust/doc/src/commands/data/aggregate.md index 55ca0dedc1..6905ef4df9 100644 --- a/rust/doc/src/commands/data/aggregate.md +++ b/rust/doc/src/commands/data/aggregate.md @@ -50,10 +50,10 @@ If the active dataset is already sorted or grouped by the break variables, specify `PRESORTED` to save time. With `MODE=ADDVARIABLES`, the data must be pre-sorted. -Specify `DOCUMENT` (*note DOCUMENT::) to copy the documents from the -active dataset into the aggregate file. Otherwise, the aggregate file -does not contain any documents, even if the aggregate file replaces -the active dataset. +Specify [`DOCUMENT`](../utilities/document.md) to copy the documents +from the active dataset into the aggregate file. Otherwise, the +aggregate file does not contain any documents, even if the aggregate +file replaces the active dataset. Normally, `AGGREGATE` produces a non-missing value whenever there is enough non-missing data for the aggregation function in use, that is, @@ -144,8 +144,8 @@ variables: * `N(VAR_NAME...)` `NMISS(VAR_NAME...)` Total weight of non-missing or missing values, respectively. The - default format is `F7.0` if weighting is not enabled, `F8.2` if it is - (*note WEIGHT::). + default format is `F7.0` if weighting is not enabled, `F8.2` if it + is (see [`WEIGHT`](../selection/weight.md)). * `NU(VAR_NAME...)` `NUMISS(VAR_NAME...)` @@ -164,8 +164,8 @@ These aggregation functions do not accept source variables: * `N` Total weight of cases aggregated to form this group. The default - format is `F7.0` if weighting is not enabled, `F8.2` if it is (*note - WEIGHT::). + format is `F7.0` if weighting is not enabled, `F8.2` if it is (see + [`WEIGHT`](../selection/weight.md)). * `NU` Count of cases aggregated to form this group, ignoring case @@ -180,8 +180,8 @@ from calculations. To include user-missing values, insert a period specifying such a function as the last token on a line causes the period to be interpreted as the end of the command.) -`AGGREGATE` both ignores and cancels the current `SPLIT FILE` settings -(*note SPLIT FILE::). +`AGGREGATE` both ignores and cancels the current [`SPLIT +FILE`](../selection/split-file.md) settings. ## Example diff --git a/rust/doc/src/commands/data/compute.md b/rust/doc/src/commands/data/compute.md index b154311606..11ecabcbb8 100644 --- a/rust/doc/src/commands/data/compute.md +++ b/rust/doc/src/commands/data/compute.md @@ -34,8 +34,9 @@ left state. Therefore, `LEAVE` should be specified following `COMPUTE` is a transformation. It does not cause the active dataset to be read. -When `COMPUTE` is specified following `TEMPORARY` (*note TEMPORARY::), -the [`LAG`](../../language/expressions/functions/miscellaneous.md) +When `COMPUTE` is specified following +[`TEMPORARY`](../selection/temporary.md), the +[`LAG`](../../language/expressions/functions/miscellaneous.md) function may not be used. ## Example diff --git a/rust/doc/src/commands/data/flip.md b/rust/doc/src/commands/data/flip.md index ce04ed2a4d..42e0767830 100644 --- a/rust/doc/src/commands/data/flip.md +++ b/rust/doc/src/commands/data/flip.md @@ -37,9 +37,9 @@ characters are truncated. If `FLIP` is called again on this dataset, the `CASE_LBL` variable can be passed to the `NEWNAMES` subcommand to recreate the original variable names. -`FLIP` honors `N OF CASES` (*note N OF CASES::). It ignores -`TEMPORARY` (*note TEMPORARY::), so that "temporary" transformations -become permanent. +`FLIP` honors [`N OF CASES`](../selection/n.md). It ignores +[`TEMPORARY`](../selection/temporary.md), so that "temporary" +transformations become permanent. ## Example diff --git a/rust/doc/src/commands/data/if.md b/rust/doc/src/commands/data/if.md index a1a3273392..b56fb60c56 100644 --- a/rust/doc/src/commands/data/if.md +++ b/rust/doc/src/commands/data/if.md @@ -34,7 +34,7 @@ Using `IF` to assign to a variable specified on [`LEAVE`](../../commands/variables/leave.md) resets the variable's left state. Therefore, use `LEAVE` after `IF`, not before. -When `IF` follows `TEMPORARY` (*note TEMPORARY::), the +When `IF` follows [`TEMPORARY`](../selection/temporary.md), the [`LAG`](../../language/expressions/functions/miscellaneous.md) function may not be used. diff --git a/rust/doc/src/commands/data/sort-cases.md b/rust/doc/src/commands/data/sort-cases.md index 2501c63cb6..58761335fb 100644 --- a/rust/doc/src/commands/data/sort-cases.md +++ b/rust/doc/src/commands/data/sort-cases.md @@ -95,4 +95,5 @@ order. `SORT CASES` affects only the active file. It does not have any effect upon the `physiology.sav` file itself. For that, you would -have to rewrite the file using the `SAVE` command (*note SAVE::). +have to rewrite the file using the [`SAVE`](../spss-io/save.md) +command. diff --git a/rust/doc/src/commands/matrix/matrix.md b/rust/doc/src/commands/matrix/matrix.md index 51fa4252de..ab6f08b3ff 100644 --- a/rust/doc/src/commands/matrix/matrix.md +++ b/rust/doc/src/commands/matrix/matrix.md @@ -124,7 +124,8 @@ macros may not appear within a matrix program. The following sections describe the details of the matrix language: first, the syntax of matrix expressions, then each of the supported -commands. The `COMMENT` command (*note COMMENT::) is also supported. +commands. The [`COMMENT`](../utilities/comment.md) command is also +supported. ## Matrix Expressions @@ -659,8 +660,8 @@ like the [elementwise operators](#elementwise-binary-operators). * `UNIFORM(NR, NC)` Returns a `NR`×`NC` matrix in which each element is randomly chosen from a uniform distribution of real numbers between 0 - and 1. Random number generation honors the current seed setting - (*note SET SEED::). + and 1. Random number generation honors the current + [seed](../utilities/set.md#seed) setting. The following example shows one possible output, but of course every result will be different (given different seeds): @@ -1161,8 +1162,8 @@ PRINT [expression] The `PRINT` command is commonly used to display a matrix. It evaluates the restricted EXPRESSION, if present, and outputs it either -as text or a pivot table, depending on the setting of `MDISPLAY` (*note -SET MDISPLAY::). +as text or a pivot table, depending on the setting of +[`MDISPLAY`](../utilities/set.md#mdisplay). Use the `FORMAT` subcommand to specify a format, such as `F8.2`, for displaying the matrix elements. `FORMAT` is optional for numerical @@ -1305,13 +1306,14 @@ END LOOP [IF expression]. BREAK. ``` - The `LOOP` command executes a nested group of matrix commands, called -the loop's "body", repeatedly. It has three optional clauses that -control how many times the loop body executes. Regardless of these -clauses, the global `MXLOOPS` setting, which defaults to 40, also limits -the number of iterations of a loop. To iterate more times, raise the -maximum with `SET MXLOOPS` outside of the `MATRIX` command (*note SET -MXLOOPS::). + The `LOOP` command executes a nested group of matrix commands, +called the loop's "body", repeatedly. It has three optional clauses +that control how many times the loop body executes. Regardless of +these clauses, the global `MXLOOPS` setting, which defaults to 40, +also limits the number of iterations of a loop. To iterate more +times, raise the maximum with [`SET +MXLOOPS`](../utilities/set.md#mxloops) outside of the `MATRIX` +command. The optional index clause causes VAR to be assigned successive values on each trip through the loop: first `FIRST`, then `FIRST + @@ -1456,10 +1458,11 @@ name followed by an indexing expression to replace a submatrix of an existing variable. The `FILE` subcommand is required in the first `READ` command that -appears within `MATRIX`. It specifies the text file to be read, either -as a file name in quotes or a file handle previously declared on `FILE -HANDLE` (*note FILE HANDLE::). Later `READ` commands (in syntax order) -use the previous referenced file if `FILE` is omitted. +appears within `MATRIX`. It specifies the text file to be read, +either as a file name in quotes or a file handle previously declared +on [`FILE HANDLE`](../data-io/file-handle.md). Later `READ` +commands (in syntax order) use the previous referenced file if `FILE` +is omitted. The `FIELD` and `FORMAT` subcommands specify how input lines are interpreted. `FIELD` is required, but `FORMAT` is optional. See @@ -1562,11 +1565,12 @@ The `WRITE` command evaluates expression and writes its value to a text file in a specified format. Write the expression to evaluate just after the command name. -The `OUTFILE` subcommand is required in the first `WRITE` command -that appears within `MATRIX`. It specifies the text file to be written, -either as a file name in quotes or a file handle previously declared on -`FILE HANDLE` (*note FILE HANDLE::). Later `WRITE` commands (in syntax -order) use the previous referenced file if `FILE` is omitted. +The `OUTFILE` subcommand is required in the first `WRITE` command that +appears within `MATRIX`. It specifies the text file to be written, +either as a file name in quotes or a file handle previously declared +on [`FILE HANDLE`](../data-io/file-handle.md). Later `WRITE` commands +(in syntax order) use the previous referenced file if `FILE` is +omitted. The `FIELD` and `FORMAT` subcommands specify how output lines are formed. `FIELD` is required, but `FORMAT` is optional. See [`READ` @@ -1717,8 +1721,7 @@ string columns' variable names on `STRINGS`. MGET [/FILE=file] [/TYPE={COV | CORR | MEAN | STDDEV | N | COUNT}]. ``` -The `MGET` command reads the data from a matrix file (*note Matrix -Files::) into matrix variables. +The `MGET` command reads the data from a [matrix file](index.md#matrix-files) into matrix variables. All of `MGET`'s subcommands are optional. Specify the name or handle of the matrix file to be read on the `FILE` subcommand; if it is @@ -1773,8 +1776,7 @@ MSAVE expression [/FNAMES=variable…]. ``` The `MSAVE` command evaluates the expression specified just after the -command name, and writes the resulting matrix to a matrix file (*note -Matrix Files::). +command name, and writes the resulting matrix to a [matrix file](index.md#matrix-files). The `TYPE` subcommand is required. It specifies the `ROWTYPE_` to write along with this matrix. diff --git a/rust/doc/src/commands/selection/n.md b/rust/doc/src/commands/selection/n.md index 7b2396f275..b9d2d6d773 100644 --- a/rust/doc/src/commands/selection/n.md +++ b/rust/doc/src/commands/selection/n.md @@ -8,8 +8,8 @@ N [OF CASES] NUM_OF_CASES [ESTIMATED]. that follow it in the command stream. `N OF CASES 100`, for example, tells PSPP to disregard all cases after the first 100. -When `N OF CASES` is specified after `TEMPORARY`, it affects only the -next procedure (*note TEMPORARY::). Otherwise, cases beyond the limit +When `N OF CASES` is specified after [`TEMPORARY`](temporary.md), it +affects only the next procedure. Otherwise, cases beyond the limit specified are not processed by any later procedure. If the limit specified on `N OF CASES` is greater than the number of diff --git a/rust/doc/src/commands/selection/split-file.md b/rust/doc/src/commands/selection/split-file.md index f1bbe2db8e..66f4741c88 100644 --- a/rust/doc/src/commands/selection/split-file.md +++ b/rust/doc/src/commands/selection/split-file.md @@ -36,12 +36,12 @@ affects only the next procedure. The file `horticulture.sav` contains data describing the yield of a number of horticultural specimens which have been subjected to various treatments. If we wanted to investigate linear statistics of the -yeild, one way to do this is using the `DESCRIPTIVES` (*note -DESCRIPTIVES::). However, it is reasonable to expect the mean to be -different depending on the treatment. So we might want to perform -three separate procedures -- one for each treatment.[^1] The following -syntax shows how this can be done automatically using the `SPLIT FILE` -command. +yeild, one way to do this is using +[`DESCRIPTIVES`](../statistics/descriptives.md). However, it is +reasonable to expect the mean to be different depending on the +treatment. So we might want to perform three separate procedures -- +one for each treatment.[^1] The following syntax shows how this can be +done automatically using the `SPLIT FILE` command. [^1]: There are other, possibly better, ways to achieve a similar result using the `MEANS` or `EXAMINE` commands. diff --git a/rust/doc/src/commands/selection/weight.md b/rust/doc/src/commands/selection/weight.md index 5046944944..7f4532178d 100644 --- a/rust/doc/src/commands/selection/weight.md +++ b/rust/doc/src/commands/selection/weight.md @@ -12,8 +12,9 @@ until data have been read. If a variable name is specified, `WEIGHT` causes the values of that variable to be used as weighting factors for subsequent statistical procedures. Use of keyword `BY` is optional but recommended. -Weighting variables must be numeric. Scratch variables may not be -used for weighting (*note Scratch Variables::). +Weighting variables must be numeric. [Scratch +variables](../../language/datasets/scratch-variables.md) may not be +used for weighting. When `OFF` is specified, subsequent statistical procedures weight all cases equally. @@ -59,10 +60,10 @@ frequencies /variables = item /format=dfreq. One analysis which most surely would be of interest is the relative amounts or each item in stock. However without setting a weight -variable, `FREQUENCIES` (*note FREQUENCIES::) does not tell us what we -want to know, since there is only one case for each stock item. The -output below shows the difference between the weighted and unweighted -frequency tables. +variable, [`FREQUENCIES`](../statistics/frequencies.md) does not tell +us what we want to know, since there is only one case for each stock +item. The output below shows the difference between the weighted and +unweighted frequency tables. ``` Unweighted frequency table diff --git a/rust/doc/src/commands/spss-io/apply-dictionary.md b/rust/doc/src/commands/spss-io/apply-dictionary.md index 3e4e8df6de..705843d13c 100644 --- a/rust/doc/src/commands/spss-io/apply-dictionary.md +++ b/rust/doc/src/commands/spss-io/apply-dictionary.md @@ -25,11 +25,12 @@ active dataset variables: file variable does not have a variable label, then the active dataset variable's variable label, if any, is retained. -- If the system file variable has custom attributes (*note VARIABLE - ATTRIBUTE::), then those attributes replace the active dataset - variable's custom attributes. If the system file variable does not - have custom attributes, then the active dataset variable's custom - attributes, if any, is retained. +- If the system file variable has [variable + attributes](../variables/variable-attribute.md), then those + attributes replace the active dataset variable's variable + attributes. If the system file variable does not have varaible + attributes, then the active dataset variable's variable attributes, + if any, is retained. - If the active dataset variable is numeric or short string, then value labels and missing values, if any, are copied to the active @@ -45,12 +46,12 @@ file dictionary as a whole are updated: those attributes replace the active dataset variable's custom attributes. -- If the active dataset has a weighting variable (*note WEIGHT::), - and the system file does not, or if the weighting variable in the - system file does not exist in the active dataset, then the active - dataset weighting variable, if any, is retained. Otherwise, the - weighting variable in the system file becomes the active dataset - weighting variable. +- If the active dataset has a [weight + variable](../selection/weight.md), and the system file does not, or + if the weighting variable in the system file does not exist in the + active dataset, then the active dataset weighting variable, if any, + is retained. Otherwise, the weighting variable in the system file + becomes the active dataset weighting variable. `APPLY DICTIONARY` takes effect immediately. It does not read the active dataset. The system file is not modified. diff --git a/rust/doc/src/commands/spss-io/export.md b/rust/doc/src/commands/spss-io/export.md index 6c29a27213..0ac99994d0 100644 --- a/rust/doc/src/commands/spss-io/export.md +++ b/rust/doc/src/commands/spss-io/export.md @@ -15,10 +15,10 @@ EXPORT The `EXPORT` procedure writes the active dataset's dictionary and data to a specified portable file. - `UNSELECTED` controls whether cases excluded with `FILTER` (*note -FILTER::) are written to the file. These can be excluded by -specifying `DELETE` on the `UNSELECTED` subcommand. The default is -`RETAIN`. + `UNSELECTED` controls whether cases excluded with +[`FILTER`](../selection/filter.md) are written to the file. These can +be excluded by specifying `DELETE` on the `UNSELECTED` subcommand. +The default is `RETAIN`. Portable files express real numbers in base 30. Integers are always expressed to the maximum precision needed to make them exact. diff --git a/rust/doc/src/commands/spss-io/get-data.md b/rust/doc/src/commands/spss-io/get-data.md index 99a4f2ce19..3845839f6a 100644 --- a/rust/doc/src/commands/spss-io/get-data.md +++ b/rust/doc/src/commands/spss-io/get-data.md @@ -172,9 +172,10 @@ first line. To skip lines at the beginning of an input file, set `FIRSTCASE` to the number of the first line to read: 2 to skip the first line, 3 to skip the first two lines, and so on. - `IMPORTCASES` is ignored, for compatibility. Use `N OF CASES` to -limit the number of cases read from a file (*note N OF CASES::), or -`SAMPLE` to obtain a random sample of cases (*note SAMPLE::). + `IMPORTCASES` is ignored, for compatibility. Use [`N OF +CASES`](../selection/n.md) to limit the number of cases read from a +file, or [`SAMPLE`](../selection/sample.md) to obtain a random sample +of cases. The remaining subcommands apply only to one of the two file arrangements, described below. @@ -204,8 +205,7 @@ FREE`](../../commands/data-io/data-list.md#data-list-free), with a few enhancements. The required `FILE` subcommand and optional `FIRSTCASE` and -`IMPORTCASE` subcommands are described above (*note GET DATA -/TYPE=TXT::). +`IMPORTCASE` subcommands are described [above](#textual-data-files). `DELIMITERS`, which is required, specifies the set of characters that may separate fields. Each character in the string specified on diff --git a/rust/doc/src/commands/spss-io/save-translate.md b/rust/doc/src/commands/spss-io/save-translate.md index 350d4fcc8a..d7337817e1 100644 --- a/rust/doc/src/commands/spss-io/save-translate.md +++ b/rust/doc/src/commands/spss-io/save-translate.md @@ -20,9 +20,9 @@ The `SAVE TRANSLATE` command is used to save data into various formats understood by other applications. The `OUTFILE` and `TYPE` subcommands are mandatory. `OUTFILE` -specifies the file to be written, as a string file name or a file handle -(*note File Handles::). `TYPE` determines the type of the file or -source to read. It must be one of the following: +specifies the file to be written, as a string file name or a [file +handle](../../language/files/file-handles.md). `TYPE` determines the +type of the file or source to read. It must be one of the following: * `CSV` Comma-separated value format, @@ -94,8 +94,8 @@ written to the output file: HH:MM:SS format. `WKDAY` and `MONTH` values are written as decimal numbers. - Numeric values use, by default, the decimal point character set - with `SET DECIMAL` (*note SET DECIMAL::). Use `DECIMAL=DOT` or + Numeric values use, by default, the decimal point character set with + [`SET DECIMAL`](../utilities/set.md#decimal). Use `DECIMAL=DOT` or `DECIMAL=COMMA` to force a particular decimal point character. * `CELLS=VALUES FORMAT=VARIABLE` @@ -117,8 +117,8 @@ that separate values within a line. If `DELIMITER` is specified, then the specified string separate values. If `DELIMITER` is not specified, then the default is a comma with `DECIMAL=DOT` or a semicolon with `DECIMAL=COMMA`. If `DECIMAL` is not given either, it -is inferred from the decimal point character set with `SET DECIMAL` -(*note SET DECIMAL::). +is inferred from the decimal point character set with [`SET +DECIMAL`](../utilities/set.md#decimal). The `TEXTOPTIONS QUALIFIER` setting specifies a character that is output before and after a value that contains the delimiter character or diff --git a/rust/doc/src/commands/spss-io/save.md b/rust/doc/src/commands/spss-io/save.md index 4f426d931b..fe872764b1 100644 --- a/rust/doc/src/commands/spss-io/save.md +++ b/rust/doc/src/commands/spss-io/save.md @@ -46,8 +46,8 @@ determine the system file's compression level: written with this compression level cannot be read by PSPP 0.8.1 or earlier or by SPSS 20 or earlier. -`COMPRESSED` is the default compression level. The SET command (*note -SET::) can change this default. +`COMPRESSED` is the default compression level. The +[`SET`](../utilities/set.md) command can change this default. The `PERMISSIONS` subcommand specifies operating system permissions for the new system file. `WRITEABLE`, the default, creates the file diff --git a/rust/doc/src/commands/statistics/ctables.md b/rust/doc/src/commands/statistics/ctables.md index dc4e10f833..a8890029bc 100644 --- a/rust/doc/src/commands/statistics/ctables.md +++ b/rust/doc/src/commands/statistics/ctables.md @@ -1520,7 +1520,7 @@ controls how variable labels are displayed for the variables listed on `VARIABLES`. The supported values are: * `DEFAULT` - Use the setting from `SET TVARS` (*note SET TVARS::). + Use the setting from [`SET TVARS`](../utilities/set.md#tvars)). * `NAME` Show only a variable name. diff --git a/rust/doc/src/commands/statistics/descriptives.md b/rust/doc/src/commands/statistics/descriptives.md index b268b9fc71..3f32cd704b 100644 --- a/rust/doc/src/commands/statistics/descriptives.md +++ b/rust/doc/src/commands/statistics/descriptives.md @@ -115,8 +115,7 @@ of the variables and no missing values. The mean average of the height and temperature is 16677.12 and 37.02 respectively. The descriptive statistics for temperature seem reasonable. However there is a very high standard deviation for height and a suspiciously low -minimum. This is due to a data entry error in the data (*note -Identifying incorrect data::). +minimum. This is due to a data entry error in the data. In the second Descriptive Statistics output, one can see that the mean and standard deviation of both Z score variables is 0 and 1 diff --git a/rust/doc/src/commands/statistics/factor.md b/rust/doc/src/commands/statistics/factor.md index 4d3a6133f7..e1577c2178 100644 --- a/rust/doc/src/commands/statistics/factor.md +++ b/rust/doc/src/commands/statistics/factor.md @@ -37,12 +37,13 @@ variables that participate; it is useful primarily in conjunction with If `MATRIX IN` instead of `VARIABLES` is specified, then the analysis is performed on a pre-prepared correlation or covariance matrix file -instead of on individual data cases. Typically the matrix file will -have been generated by `MATRIX DATA` (*note MATRIX DATA::) or provided -by a third party. If specified, `MATRIX IN` must be followed by `COV` -or `CORR`, then by `=` and `FILE_SPEC` all in parentheses. -`FILE_SPEC` may either be an asterisk, which indicates the currently -loaded dataset, or it may be a file name to be loaded. See [`MATRIX +instead of on individual data cases. Typically the [matrix +file](../matrix/index.md#matrix-files) will have been generated by +[`MATRIX DATA`](../matrix/matrix-data.md) or provided by a third +party. If specified, `MATRIX IN` must be followed by `COV` or `CORR`, +then by `=` and `FILE_SPEC` all in parentheses. `FILE_SPEC` may +either be an asterisk, which indicates the currently loaded dataset, +or it may be a file name to be loaded. See [`MATRIX DATA`](../matrix/matrix-data.md), for the expected format of the file. The `/EXTRACTION` subcommand is used to specify the way in which diff --git a/rust/doc/src/commands/statistics/t-test.md b/rust/doc/src/commands/statistics/t-test.md index 3586a364a7..547d7d6aa2 100644 --- a/rust/doc/src/commands/statistics/t-test.md +++ b/rust/doc/src/commands/statistics/t-test.md @@ -63,9 +63,9 @@ national average weight of healthy adults is 76.8kg. Accordingly the mean average weight of the population from which the sample was drawn is 76.8kg. - As previously noted (*note Identifying incorrect data::), one sample -in the dataset contains a weight value which is clearly incorrect. So -this is excluded from the analysis using the `SELECT` command. + As previously noted, one sample in the dataset contains a weight +value which is clearly incorrect. So this is excluded from the +analysis using the `SELECT` command. ``` GET FILE='physiology.sav'. @@ -131,9 +131,9 @@ A researcher wishes to know whether within a population, adult males are taller than adult females. The samples are drawn from the population under investigation and recorded in the file `physiology.sav`. -As previously noted (*note Identifying incorrect data::), one sample -in the dataset contains a height value which is clearly incorrect. So -this is excluded from the analysis using the `SELECT` command. +As previously noted, one sample in the dataset contains a height value +which is clearly incorrect. So this is excluded from the analysis +using the `SELECT` command. ``` get file='physiology.sav'. diff --git a/rust/doc/src/commands/utilities/erase.md b/rust/doc/src/commands/utilities/erase.md index 0e2f6cc16c..42b65f6f23 100644 --- a/rust/doc/src/commands/utilities/erase.md +++ b/rust/doc/src/commands/utilities/erase.md @@ -5,6 +5,6 @@ ERASE FILE "FILE_NAME". ``` `ERASE FILE` deletes a file from the local file system. The file's -name must be quoted. This command cannot be used if the SAFER (*note -SET::) setting is active. +name must be quoted. This command cannot be used if the +[`SAFER`](../utilities/set.md#safer) setting is active. diff --git a/rust/doc/src/commands/utilities/host.md b/rust/doc/src/commands/utilities/host.md index bdc6e5e176..1fcb7d0911 100644 --- a/rust/doc/src/commands/utilities/host.md +++ b/rust/doc/src/commands/utilities/host.md @@ -29,8 +29,8 @@ the execution time to the specified number of seconds. PSPP built for mingw does not support all the features of `HOST`. -PSPP rejects this command if the SAFER (*note SET::) setting is -active. +PSPP rejects this command if the [`SAFER`](../utilities/set.md#safer) +setting is active. ## Example diff --git a/rust/doc/src/commands/utilities/insert.md b/rust/doc/src/commands/utilities/insert.md index 245157fec5..8f3efdc7a8 100644 --- a/rust/doc/src/commands/utilities/insert.md +++ b/rust/doc/src/commands/utilities/insert.md @@ -33,10 +33,10 @@ included file. Its argument, which is not case-sensitive, must be in one of the following forms: * `LOCALE` - The encoding used by the system locale, or as overridden by the - `SET` command (*note SET::). On GNU/Linux and other Unix-like - systems, environment variables, e.g. `LANG` or `LC_ALL`, determine - the system locale. + The encoding used by the system locale, or as overridden by [`SET + LOCALE`](../utilities/set.md#locale). On GNU/Linux and other + Unix-like systems, environment variables, e.g. `LANG` or `LC_ALL`, + determine the system locale. * `'CHARSET_NAME'` An [IANA character set diff --git a/rust/doc/src/commands/utilities/output.md b/rust/doc/src/commands/utilities/output.md index 2e32bb8c46..20f53b1df7 100644 --- a/rust/doc/src/commands/utilities/output.md +++ b/rust/doc/src/commands/utilities/output.md @@ -34,8 +34,8 @@ should be selected for modification. Each class can be: default is the weight variable's print format. For an unweighted data set, the default is `F40.0`. -For most other numeric values that appear in tables, `SET FORMAT` may -be used to specify the format (*note SET FORMAT::). +For most other numeric values that appear in tables, [`SET +FORMAT`](set.md#format)) may be used to specify the format. `FMT_SPEC` must be a valid [output format](../../language/datasets/formats/index.md). Not all possible diff --git a/rust/doc/src/commands/utilities/permissions.md b/rust/doc/src/commands/utilities/permissions.md index 61e692f58c..3b0018c4b1 100644 --- a/rust/doc/src/commands/utilities/permissions.md +++ b/rust/doc/src/commands/utilities/permissions.md @@ -12,6 +12,6 @@ should be changed. If you set a file's permission to `READONLY`, then the file will become unwritable either by you or anyone else on the system. If you set the permission to `WRITEABLE`, then the file becomes writeable by you; the permissions afforded to others are unchanged. -This command cannot be used if the `SAFER` (*note SET::) setting is +This command cannot be used if the [`SAFER`](../utilities/set.md#safer) setting is active. diff --git a/rust/doc/src/commands/utilities/preserve.md b/rust/doc/src/commands/utilities/preserve.md index cbff68f829..20932fe3a7 100644 --- a/rust/doc/src/commands/utilities/preserve.md +++ b/rust/doc/src/commands/utilities/preserve.md @@ -6,8 +6,8 @@ PRESERVE. RESTORE. ``` -`PRESERVE` saves all of the settings that `SET` (*note SET::) can -adjust. A later `RESTORE` command restores those settings. +`PRESERVE` saves all of the settings that [`SET`](set.md) can adjust. +A later `RESTORE` command restores those settings. `PRESERVE` can be nested up to five levels deep. diff --git a/rust/doc/src/commands/utilities/set.md b/rust/doc/src/commands/utilities/set.md index 6eb9d73adf..8bb2d9ae39 100644 --- a/rust/doc/src/commands/utilities/set.md +++ b/rust/doc/src/commands/utilities/set.md @@ -89,27 +89,28 @@ files. The data input subcommands are the system-missing value to be assigned to null items. This is the default. Any real value may be assigned. -* `DECIMAL` +* `DECIMAL` This value may be set to `DOT` or `COMMA`. Setting it to `DOT` causes the decimal point character to be `.` and the grouping - character to be `,`. Setting it to `COMMA` causes the decimal - point character to be `,` and the grouping character to be `.`. If - the setting is `COMMA`, then `,` is not treated as a field - separator in the `DATA LIST` command (*note DATA LIST::). The - default value is determined from the system locale. + character to be `,`. Setting it to `COMMA` causes the decimal point + character to be `,` and the grouping character to be `.`. If the + setting is `COMMA`, then `,` is not treated as a field separator in + the [`DATA LIST`](../data-io/data-list.md) command. The default + value is determined from the system locale. -* `FORMAT` - Allows the default numeric [input/output - format](../../language/datasets/formats/index.md) to be specified. - The default is `F8.2`. +* `FORMAT` + Changes the default numeric [input/output + format](../../language/datasets/formats/index.md). The default is + initially `F8.2`. * `EPOCH` - Specifies the range of years used when a 2-digit year is read from - a data file or used in a date construction expression (*note Date - Construction::). If a 4-digit year is specified for the epoch, - then 2-digit years are interpreted starting from that year, known - as the epoch. If `AUTOMATIC` (the default) is specified, then the - epoch begins 69 years before the current date. + Specifies the range of years used when a 2-digit year is read from a + data file or used in a [date construction + expression](../../language/expressions/functions/time-and-date.md#constructing-dates). + If a 4-digit year is specified for the epoch, then 2-digit years are + interpreted starting from that year, known as the epoch. If + `AUTOMATIC` (the default) is specified, then the epoch begins 69 + years before the current date. * `RIB` PSPP extension to set the byte ordering (endianness) used for @@ -149,14 +150,14 @@ execute. The syntax execution subcommands are United States) and `ja_JP.EUC-JP` (EUC-JP encoded Japanese as spoken in Japan). -* `MXLOOPS` +* `MXLOOPS` The maximum number of iterations for an uncontrolled [`LOOP`](../../commands/control/loop.md), and for any [loop in the matrix language](../../commands/matrix/matrix.md#the-loop-and-break-commands). The default `MXLOOPS` is 40. -* `SEED` +* `SEED` The initial pseudo-random number seed. Set it to a real number or to `RANDOM`, to obtain an initial seed from the current time of day. @@ -212,7 +213,7 @@ subcommands are with `SET LEADZERO=ON`, it is shown as .5. This setting affects only the `F`, `COMMA`, and `DOT` formats. -* `MDISPLAY` +* `MDISPLAY` Controls how the [`PRINT`](../../commands/matrix/matrix.md#the-print-command) command within [`MATRIX`...`END MATRIX`](../../commands/matrix/matrix.md) @@ -296,7 +297,7 @@ These subcommands are with both their label (if any) and their literal value in parentheses. -* `TVARS` +* `TVARS` The `TVARS` option sets the way in which variables are displayed in output tables. The valid settings are `NAMES`, `LABELS` and `BOTH`. If `TVARS` is set to `NAMES`, then all variables are displayed using @@ -332,14 +333,14 @@ files. These subcommands are System file subcommands affect the default format of system files produced by PSPP. These subcommands are -* `SCOMPRESSION` +* `SCOMPRESSION` Whether system files created by `SAVE` or `XSAVE` are compressed by default. The default is `ON`. Security subcommands affect the operations that commands are allowed to perform. The security subcommands are -* `SAFER` +* `SAFER` Setting this option disables the following operations: - The `ERASE` command. @@ -352,7 +353,7 @@ to perform. The security subcommands are When set, this setting cannot be reset during the same session, for obvious security reasons. -* `LOCALE` +* `LOCALE` This item is used to set the default character encoding. The encoding may be specified either as an [IANA encoding name or alias](http://www.iana.org/assignments/character-sets), or as a diff --git a/rust/doc/src/commands/utilities/show.md b/rust/doc/src/commands/utilities/show.md index e7c390c7d0..c74c39ce89 100644 --- a/rust/doc/src/commands/utilities/show.md +++ b/rust/doc/src/commands/utilities/show.md @@ -62,7 +62,7 @@ additional subcommands: * `WARRANTY` Show details of the lack of warranty for PSPP. * `COPYING` or `LICENSE` - Display the terms of PSPP's copyright licence (*note License::). + Display the terms of [PSPP's copyright licence](../../license.md). Specifying `SHOW` without any subcommands is equivalent to `SHOW ALL`. diff --git a/rust/doc/src/commands/variables/display.md b/rust/doc/src/commands/variables/display.md index 78b5e42ebb..1b376dc3d1 100644 --- a/rust/doc/src/commands/variables/display.md +++ b/rust/doc/src/commands/variables/display.md @@ -43,14 +43,13 @@ keyword causes output to be sorted alphabetically by variable name. variable labels, and value labels are displayed. * `SCRATCH` - Variablenames are displayed, for scratch variables only (*note - Scratch Variables::). + Displays Variablen ames, for [scratch + variables](../../language/datasets/scratch-variables.md) only. * `ATTRIBUTES` Datafile and variable attributes are displayed, except attributes whose names begin with `@` or `$@`. - * `@ATTRIBUTES` All datafile and variable attributes, even those whose names begin with `@` or `$@`. @@ -60,6 +59,7 @@ vectors. If the `SORTED` keyword is given, the vectors are listed in alphabetical order; otherwise, they are listed in textual order of definition within the PSPP syntax file. -For related commands, see *note DISPLAY DOCUMENTS:: and *note DISPLAY -FILE LABEL::. +For related commands, see [`DISPLAY +DOCUMENTS`](../utilities/display-documents.md) and [`DISPLAY FILE +LABEL`](../utilities/display-file-label.md). diff --git a/rust/doc/src/commands/variables/rename-variables.md b/rust/doc/src/commands/variables/rename-variables.md index 01bed431d4..cc0dfc9438 100644 --- a/rust/doc/src/commands/variables/rename-variables.md +++ b/rust/doc/src/commands/variables/rename-variables.md @@ -17,6 +17,6 @@ parentheses are optional. `RENAME VARIABLES` takes effect immediately. It does not cause the data to be read. -`RENAME VARIABLES` may not be specified following `TEMPORARY` (*note -TEMPORARY::). +`RENAME VARIABLES` may not be specified following +[`TEMPORARY`](../selection/temporary.md). diff --git a/rust/doc/src/data/aggregate.md b/rust/doc/src/data/aggregate.md index d8e1363d3d..f2a9a54f95 100644 --- a/rust/doc/src/data/aggregate.md +++ b/rust/doc/src/data/aggregate.md @@ -50,10 +50,10 @@ If the active dataset is already sorted or grouped by the break variables, specify `PRESORTED` to save time. With `MODE=ADDVARIABLES`, the data must be pre-sorted. -Specify `DOCUMENT` (*note DOCUMENT::) to copy the documents from the -active dataset into the aggregate file. Otherwise, the aggregate file -does not contain any documents, even if the aggregate file replaces -the active dataset. +Specify `DOCUMENT` to copy the [documents](../utilities/document.md) +from the active dataset into the aggregate file. Otherwise, the +aggregate file does not contain any documents, even if the aggregate +file replaces the active dataset. Normally, `AGGREGATE` produces a non-missing value whenever there is enough non-missing data for the aggregation function in use, that is, @@ -145,7 +145,7 @@ variables: `NMISS(VAR_NAME...)` Total weight of non-missing or missing values, respectively. The default format is `F7.0` if weighting is not enabled, `F8.2` if it is - (*note WEIGHT::). + (see [`WEIGHT`](../selection/weight.md)). * `NU(VAR_NAME...)` `NUMISS(VAR_NAME...)` @@ -164,8 +164,8 @@ These aggregation functions do not accept source variables: * `N` Total weight of cases aggregated to form this group. The default - format is `F7.0` if weighting is not enabled, `F8.2` if it is (*note - WEIGHT::). + format is `F7.0` if weighting is not enabled, `F8.2` if it is (see + [`WEIGHT`](../selection/weight.md)). * `NU` Count of cases aggregated to form this group, ignoring case @@ -180,8 +180,8 @@ from calculations. To include user-missing values, insert a period specifying such a function as the last token on a line causes the period to be interpreted as the end of the command.) -`AGGREGATE` both ignores and cancels the current `SPLIT FILE` settings -(*note SPLIT FILE::). +`AGGREGATE` both ignores and cancels the current [`SPLIT +FILE`](../selection/split-file.md) settings. ## Aggregate Example diff --git a/rust/doc/src/language/datasets/formats/basic.md b/rust/doc/src/language/datasets/formats/basic.md index 10d4d316ee..332a46ee5d 100644 --- a/rust/doc/src/language/datasets/formats/basic.md +++ b/rust/doc/src/language/datasets/formats/basic.md @@ -20,8 +20,8 @@ output some variation on this style: - Numbers in `COMMA` format are additionally grouped every three digits by inserting a grouping character. The grouping character is - ordinarily a comma, but it can be changed to a period (*note SET - DECIMAL::). + ordinarily a comma, but it can be changed to a period (with [`SET + DECIMAL`](../../../commands/utilities/set.md#decimal)). - `DOT` format is like `COMMA` format, but it interchanges the role of the decimal point and grouping characters. That is, the current