SPSYNTAX procedure

Puts details about the syntax of commands into a spreadsheet (R.W. Payne).

Option

Parameter

Description

SPSYNTAX forms a spreadsheet containing details about the syntax of commands into a spreadsheet. By default, the spreadsheet is a Genstat workbook, opened in the Genstat client. Alternatively, the OUTFILENAME can specify the name of a spreadsheet file where the details are to be saved. This can be a Genstat workbook (.gwb), or a Genstat spreadsheet (.gsh), or an Excel spreadsheet (.xls or .xlsx) If the name is specified without a suffix, ‘.gwb‘ is added (so that a Genstat workbook is saved).

The COMMAND parameter lists the names of the directives and procedures whose syntax is to be saved. If the output is to a Genstat workbook, or to an Excel file, the spreadsheet file is created with a page for each command. An ordinary Genstat spreadsheet (.gsh) can save details for only one command. This will be the last command in the list.

Each page is a vector sheet, with columns for each aspect of the syntax. (See parameters NAME, MODE, NVALUES, VALUES, DEFAULT, SET, DECLARED, TYPE, COMPATIBLE, PRESENT, LIST and INPUT of the SYNTAX directive.) The aspects that can have multiple settings (i.e. those that save pointers in SYNTAX) are represented by pointers in the spreadsheet so that they have several columns to save these multiple settings. The pointers have a zero element to specify the number of columns used by each option or parameter. The options and parameters that can have both string and number settings have two pointers, one containing texts for the strings, and another containing variates for the numbers.

Option: OUTFILENAME.
Parameter: COMMAND.

See also

Directives: COMMANDINFORMATION, OPTION, PROCEDURE, SYNTAX.
Commands for: Program control.

Example

CAPTION  'SPSYNTAX example','Syntax of analysis of variance directives';\
         STYLE=meta,plain
SPSYNTAX 'ANOVA','ADISPLAY','AKEEP','BLOCKSTRUCTURE','COVARIATE',\
         'TREATMENTSTRUCTURE'