DESL


DESL Home | Website Outline | Commands | Examples | Download | Contacts

( BP) Details concerning the DESL print command.


(See example(s) of the use of the print command.)
[Jump to the list of available options.]
General description of the print command :

The DESL "print" function allows the user to display, for each SIF file specified, a report of the desired variable names and data.

The display can be in either one of two styles.

The first style might be more applicable for quick data review. This style is characterized by having to specify, in addition to the "files" option and argument list, only the "names" option and argument list.

The second style is more applicable to the production of a publishable report and is characterized by having to specify, in addition to the "files" option and argument list, the "nameset" and "page" options and argument lists. This second style can be produced in a PostScript format instead of a line-printer image format.

The default "page" size is that which is currently in effect as a result of the "page" command or in effect as the default (22 lines, 80 columns).


The list of currently available options for the print command is the following.

Any blinking names enclosed in brackets are required or are in a set of options, one of which must be specified. Any non-blinking names enclosed in brackets are optional or are in a set of options, only one of which can be specified.

In cases where the option name is one of a set each different set number is indicated by a red numeric set number superscript trailing the respectiveright bracket :

[all] [altvars] [at] [backward] [blankval] [cntld] [cols] [cset] [dformat] [elsek] [endifk] [eqtol] [files] [font] [format] [ifk] [integer] [justify] [labfile] [land] [landscape] [lines] [names]1 [nameset]1 [nformat] [nocc] [noop] [output] [page] [pathfile] [paths] [pressure] [pscale] [psl] [psw] [scale] [subsfile] [tabs] [textfiles] [title] [translate] [type]

[Top][Bottom][Option list]

( BPall) (Command :print) Details for the all option.

[General syntax rules for this keyword.]

Indicates that all names records are to be reported when no variable names are also specified by the "names" or "nameset" options. The default situation is to report only the FIRST names record per file.

[Top][Bottom][Option list]

( BPaltvars) (Command :print) Details for the altvars option.

[General syntax rules for this keyword.]

The presence of this option indicates that IF there is an active composite alternate SIF variable name file (as established via the "variables" DESL command) then this composite file will be used to attempt to assign an alternate SIF variable name if a SIF variable would otherwise not be found on the file(s) being processed.

[Top][Bottom][Option list]

( BPat) (Command :print) Details for the at option.

[General syntax rules for this keyword.]

The syntax for the "at" option/argument list :

at name tol (val val ...) [tcode (tnum)]..[repeat

For non-"pressure" type output, if it is desired that one or more titles are to be printed when (1) the value of some SIF variable ("name", above), which is being printed or not, changes by more than the absolute magnitude of a specified tolerance value ("tol", above) from the value the same variable had in the preceding SIF record, or when (2) the value of some SIF variable ("name", above), being printed or not, matches, within plus/minus the specified tolerance value ("tol", above) at least one of the values ("val", above) also specified, then those titles, specified via a title code ("tcode", above) and optional title number ("tnum", above), are printed just ahead of (if "tol" < 0) or after (if "tol" > 0) the SIF record which triggered the print.

The permissible title codes are the same as for the title codes allowed to be used for the "page" option : "t", "l", "c", and "r". These codes imply, respectively, that the specified or implied (= 1) title number is to be printed "as is", left justified, centered, or right justified. A code of "s" without a following value indicates that the first occurrence of the pertinent at-triggered line(s) is to be SKIPPED.

If the special code of 's' is specified, which has no applicable following value, the FIRST "at"-triggering SIF record is ignored.

Also, a special code of "f", which has no applicable following value, can be specified. This special code implies a form-feed. Since this form-feed will be made AT THE POINT OF ENCOUNTER, relative to any other title(s) being printed, care must be taken to insure that sections of titles which are intended to be printed together are, indeed, printed together and not separated by a page boundary. It is suggested that the "f" code be included in "at" argument lists (1) at the BEGINNING of the set of title code which will be triggered to be printed BEFORE the triggering record and (2) at the END of the set of title codes which will be triggered to be printed AFTER the triggering record.

Up to 20 "at" option/argument lists can be specified. For each "at", up to 20 title code and associated title number sets can be specified. If the structure of the "at" argument list includes values to be checked for a match with a SIF variable value, up to 19 values can be included.

Example : at run -.5 c 1 t 6 s c 2

[Top][Bottom][Option list]

( BPbackward) (Command :print) Details for the backward option.

[General syntax rules for this keyword.]

Indicates that any searching for SIF variables will be done from back to front in the SIF records. The default condition is to search from front to back. If neither "names" nor "nameset" is specified, "backward" has the effect of reversing the order of printing for the lists of SIF file(s) names.

[Top][Bottom][Option list]

( BPblankval) (Command :print) Details for the blankval option.

[General syntax rules for this keyword.]

If the type of output is PostScript, then the value(s) following this option establishes (a) the value (1 value) or (b) value range (2 values) which, if a match is found in the tabulation, will trigger the substitution of a blank string for qualifying values. The tabulation values used for the match are already according to the desired format(s) implied or specified. The NAMEs of the associated variable(s) being substituted for is NOT important. The default condition is to NOT substitute.

Example : blankval -99

[Top][Bottom][Option list]

( BPcntld) (Command :print) Details for the cntld option.

[General syntax rules for this keyword.]

If specified, a cntl-D character will be inserted as the top line in the PostScript file being produced. Some PostScript printers can be left, by the previous job, in a state in which the next job is erroneously handled. The cntl-D will reset these printers. However, the cntl-D will sometimes be unacceptable to a screen previewer.

[Top][Bottom][Option list]

( BPcset) (Command :print) Details for the cset option.

[General syntax rules for this keyword.]

This option is used to specify "file-specific" conditions which, IN ADDITION to any other GLOBAL conditions which ALSO may have been specified, are to be applied to each SIF record processed from the respective SIF file. Just like global conditions, file-specific conditions act to limit the applicability of the DESL function being executed by requiring that ALL applicable "and" conditions be TRUE simultaneously or that at least ONE "or" condition be TRUE.

The item immediately following "cset" is the file sequence number in the "files" list for which the following up-to-20 conditions will be applicable.

Each file-specific 3-item condition, like its global 3-item condition counterpart, is made up of (1) a SIF variable name, (2) a 2-character logical conjunction, and (3) a second SIF variable name or a constant.

Example : cset 3 alpha gt phi mach lt 1.2

Here, the user has indicated that, along with whatever other GLOBAL conditions may have been specified, the pertinent DESL function, for the THIRD file specified or implied by the "files" list, will have its application ALSO limited to records which satisfy BOTH of the two conditions :

"ALPHA gt PHI" "MACH lt 1.2".

All file-specific conditions are implicitly joined by an "and" conjunction; ie, by default, all file-specific conditions would have to be true SIMULTANEOUSLY for the applicable record to be retained.

If one or more file-specific conditions following the file sequence number is to be connected to other file-specific conditions for the same file number by an "or" conjunction, then the 2-character item "or" must immediately follow the file number.

Example : cset 2 or alpha lt 0 alpha gt 4

Here, the user has indicated that, along with whatever other GLOBAL conditions may have been specified, the pertinent DESL function, for the SECOND file specified or implied by the "files" list, will have its application ALSO limited to records in which the value of the SIF variable "alpha" satisfies at least ONE of the conditions :

"ALPHA lt 0" "ALPHA gt 4".

Additionally, if the file number following the "cset" option is negative, the absolute value of this negative file number is used for the actual file number and the associated "and" or "or" condition(s) are NOT used in the traditional sense of filtering the records read but are ONLY used to indicate when READING of the associated file is to STOP. This ability is useful in preventing the reading of a long file when it is known that the data required is relatively near the beginning of the file.

Example : cset -1 or run eq 3 alpha gt 24

Here, the user has indicated that when a record is encountered for which either or both of the two conditions

"RUN = 3" "ALPHA gt 24"

is/are TRUE, reading of the current SIF file should end.

[Top][Bottom][Option list]

( BPcols) (Command :print) Details for the cols option.

[General syntax rules for this keyword.]

If other than the current default number of columns which can be contained in one "page" of output is desired, then this default can be overridden for the current execution of the "print" function by including the desired number of columns after the "cols" option. If "type" is "postscript", however, the set/default number of columns per "page" may be reduced if it would mean the loss of any of the PostScript image. (See "page" command.)

Example : cols 110

[Top][Bottom][Option list]

( BPdformat) (Command :print) Details for the dformat option.

[General syntax rules for this keyword.]

Normally, the DESL "print" function determines the actual Fortran format structure which will be used to print the desired variable values. This constructed format string can be overridden entirely by the specification of a string after "dformat". The specified data format string can be up to 64 characters long.

Example : dformat ?(20(3x,f12.

[Top][Bottom][Option list]

( BPeqtol) (Command :print) Details for the eqtol option.

[General syntax rules for this keyword.]

Indicates the tolerance to be applied to any global or file-specific "eq" condition(s) which may have been specified. If the tolerance value specified is positive the value is in the units of the variable being used in the respective condition(s). If the tolerance value is negative the absolute value of the value is a PERCENT difference. The default value of tolerance is 0.

Example : eqtol .5

[Top][Bottom][Option list]

( BPfiles) (Command :print) Details for the files option.

[General syntax rules for this keyword.]

Indicates the names of the SIF file(s) to print.

This list of files can be implicitly extended via use of the <list argument which can appear among the specified file names. If one or more of the <list-type arguments are specified, where "list" is a currently defined file name list, the file names contained in the indicated file name list(s) will be included, at their respective point(s) of encounter, in the current file list. The referenced list(s) must have been produced by the "newfiles" and/or "newfilex" argument lists associated with one or more previously executed DESL commands. Each "list" name can be up to 15 characters long. File names can also include the {...} construct. This type specification within a file name implies that the list name given between the curly brackets ( {} ), is to be used to have each of its elements substituted in turn for the { ... }, inclusively, such that an implicit lengthening of the file list is accomplished, up to the maximum number of files allowed. Any time such a {...} usage occurs, all lists mentioned must exist; i.e., must have been previously defined in the current DESL session. Only one {...} construct can be included in a file name. Including more than one such construct will result in unpredictable results.

An example of this type of file name specification is the following :

t43r{runs}.sif

Here, the list "runs" will have its elements used, in turn, in place of the {runs} substring.

.

(Begin modifications on 052102)

Each file name, whether it includes the {...} or not, can be a maximum of 256 characters long. If a file name is more than 16 characters long it must be enclosed in question marks (?) .

(End modifications on 052102)

Up to 200 files can be explicitly or implicitly specified.

Example : files run16 [Top][Bottom][Option list]

( BPfont) (Command :print) Details for the font option.

[General syntax rules for this keyword.]

If specified, the following value is the default font number to use. The legitimate values for the 2-digit font numbers are the following, where XY is a 2-digit font code, in which X = font, Y = style :



X :
1 ... Times-Roman
2 ... Helvetica
3 ... Helvetica-Narrow
4 ... Symbol  (Style code = 1 ONLY!)
5 ... Courier ("Monaco")  (characters "equally" spaced)
6 ... AvantGarde
7 ... Bookman
8 ... Palatino
9 ... NewCenturySchlbk

Y : 1 ... Normal 2 ... Oblique / Italic 3 ... Bold 4 ... Bold-Oblique / Bold-Italic

The default font = Times-Roman (11). After any string is drawn, the current font ALWAYS reverts back to the default font.

Example : font 63

[Top][Bottom][Option list]

( BPformat) (Command :print) Details for the format option.

[General syntax rules for this keyword.]

If other than the current default format specification, G10.3, for value printing is desired then a new default format can be set via the "format" option and associated argument. The format must be a real format specification of type E, G, or F. This new default format specification is, however, only valid for the current execution of the "print" function. (See "integer" for special F#.0 case.)

Example : format g12.5

[Top][Bottom][Option list]

( BPinteger) (Command :print) Details for the integer option.

[General syntax rules for this keyword.]

Toggles the ability to convert from real format without decimal places to an equivalent integer format for "type" of "postscript". Following "integer", "on" or "off" must appear. If the "integer" state is "on", it is desired that all values, in columns and in title lines, be displayed as integers if their associated formats had NO decimal places specified. For example, a value which would have been printed in "f6.0" format, if "integer" has been specified, will be printed, effectively, with an "i6" format.

Example : integer on

[Top][Bottom][Option list]

( BPjustify) (Command :print) Details for the justify option.

[General syntax rules for this keyword.]

Indicates, via a following value, the desired justification of name-type column headings with respect to the respective columns of data values. A justification value of 0 implies centering of the column heading names. The default justification is centered for both "page" and non-page style output. A negative justification value implies left justified column headings whereas a positive justification value implies right justified column headings.

Example : justify -1

[Top][Bottom][Option list]

( BPlabfile) (Command :print) Details for the labfile option.

[General syntax rules for this keyword.]

If type is "postscript" then the file-name argument associated with the "labfile" option represents the name of the desired "label file" to examine to check for matches with explicit or implicit names set via "nameset". The translations can contain any of the legitimate font, tabbing, and/or subscript/supers notations which are valid for any label and which are discussed in the "type" option help text with respect to a "type" of "postscript". The rules for the syntax of a label file are the following :

  1. all lines are ASCII
  2. any line beginning with "* " is a comment and is ignored (asterisk + one or more blanks)
  3. blank lines are ignored
  4. only 2 items per line per translation : the first up to 16 characters and the second up to 30 characters. Any string longer than 16 characters MUST be enclosed in question-mark (?) delimiters.
  5. free-field interpretation, therefore embedded blanks require the "?" delimiters
  6. first item is name to be translated; must match VERBATIM with name specified or implied via "nameset" argument list
  7. second item is the corresponding name translation


An example of such a file is the following :

* * Example label file for test xxx * * item 1 = name to be translated : MUST * match VERBATIM with name given * specified/implied via "nameset" * * item 2 = resulting name translation * cl C$DL beta ?$41b$11, deg? clalfsq C$DL$L$41a$31$U2

Explanations for the use of the $-type font selectors and subscript/superscript selectors can be found in the "Fonts" section of this document.

Example : labfile labf1

[Top][Bottom][Option list]

( BPland) (Command :print) Details for the land option.

[General syntax rules for this keyword.]

If type is "postscript" then inclusion of the "land" option will cause the output "page" image to be rotated 90 degrees before it is printed; ie, the image will be printed on a page that is wider than tall as opposed to being printed on the default taller-than-wide page. Both "land" and "pscale" impact the maximum number of lines and columns which a PostScript "page" should contain.

[Top][Bottom][Option list]

( BPlandscape) (Command :print) Details for the landscape option.

[General syntax rules for this keyword.]

If type is "postscript" then inclusion of the "landscape" option, followed by "on" or "off", will cause setting or unsetting of the flag to cause the output page image to be rotated 90 degrees; ie, the image will be printed on a page that is wider-than-tall as opposed to being printed on a page that is taller-than-wide ("portrait" mode). Both "land" and "pscale" impact the maximum number of lines and columns which a PostScript "page" should contain.

Example : landscape off

[Top][Bottom][Option list]

( BPlines) (Command :print) Details for the lines option.

[General syntax rules for this keyword.]

If other than the current default number of lines which can be contained in one "page" of output is desired, then this default can be overridden for the current execution of the "print" function by including the desired number of lines after the "lines" option. If "type" is "postscript", however, the set/default number of lines per "page" may be reduced if it would mean the loss of any of the PostScript image. (See "page" command.)

Example : lines 44

[Top][Bottom][Option list]

( BPnames) (Command :print) Details for the names option.

[General syntax rules for this keyword.]

Indicates the SIF variables whose names and values to display to the output device/file. If "page" also specified, "names" is ignored and "nameset" must be specified. Up to 200 names can be specified. A real format specification may follow a name. If so included in the argument list, this format will override the default format in effect for the applicable variable. If neither "names" nor "nameset" is specified, only the SIF variable names will be printed for each file specified.
.

(Begin modifications on 032506)

If it is desired that a variable name be specified that would look to DESL as if it was a format specification, then a substitution of a semicolon for a period can be made in the specified name. The switch back to a period will be made by DESL before the printing occurs.

Example Use F6;3 to have the variable F6.3 printed.

(End modifications on 032506)

To display alternate names for specified SIF variables, the



" new_name = old_name " ,
" new_name1 thru new_name2 = old_name " , or
" new_name = old_name1 thru old_name2 "


type argument list construct can be used. All names on the left of the equal (=) sign will be displayed "as is" (ie, no case conversion) in place of the corresponding specified or implied SIF variable on the right side of the equal sign. Additionally, to force a blank name to be displayed in place of a SIF variable, name(s) on the left side of the equal sign can be blank; ie, the construct " ... ? ? = alpha ..." will force a blank to be displayed in place of the SIF variable name "ALPHA". If "type" is "postscript", then the names on the left side of the equal sign can contain any legal PostScript character(s). See "type" below.

Example : names Alpha = alpha

[Top][Bottom][Option list]

( BPnameset) (Command :print) Details for the nameset option.

[General syntax rules for this keyword.]

Indicates the SIF variables whose names and values to display to the output device/file per "page" of output as per the page layout specified via the "page" option/argument list or per SIF record if the option "pressure" is also given. The option "page" must also be given. Up to 10 different "nameset" page id's ("pgid") can be specified, each containing "one output line"s" worth of variables and associated optional real format specifications, or, if "pressure" is also specified, up to 500 variable names and associated real format specifications. In the case of having included the "pressure" option, only one qualifying SIF record is printed per "page" of output. If neither "names" or "nameset" is specified, only the SIF variable names will be printed for each file specified.
.

(Begin modifications on 032506)

If it is desired that a variable name be specified that would look to DESL as if it was a format specification, then a substitution of a semicolon for a period can be made in the specified name. The switch back to a period will be made by DESL before the printing occurs.

Example Use F6;3 to have the variable F6.3 printed.

(End modifications on 032506)

To display alternate names for specified SIF variables, the



" new_name = old_name " ,
" new_name1 thru new_name2 = old_name " , or
" new_name = old_name1 thru old_name2 "


type argument list construct can be used. All names on the left of the equal (=) sign will be displayed "as is" (ie, no case conversion) in place of the corresponding specified or implied SIF variable on the right side of the equal sign. Additionally, to force a blank name to be displayed in place of a SIF variable, name(s) on the left side of the equal sign can be blank; ie, the construct " ... ? ? = alpha ..." will force a blank to be displayed in place of the SIF variable name "ALPHA". If "type" is "postscript", then the names on the left side of the equal sign can contain any legal PostScript character(s). See "type" below.

If the type of output is PostScript, then tabbing can be achieved by inclusion, in the expressed or implied new_name, of the "$^c", "$Tc", or "$Cc"

strings, where "c" represents an upper-case letter, A to Z, implying tab settings 1 to 26, respectively. Once set, a tab remains set and referenceable. Tabs can be set implicitly by tab-setting strings in "titles", "nameset" lists, or explicitly via the "tabs" option.

The "^" character indicates a tab to set. A "T" or "C" indicates a tab to use, either left-justified or centered, respectively. If a tab was set EXPLICITLY, the location which was set is the location of the left edge or center of the tab when a "T" or "C" tab-use construct is encountered. If a tab was set implicitly via the "^" tab-setting construct in either a "title" or list of names after "nameset", the left edge or center, respectively, of the associated string is used when the "T" or "C" tab-use construct is encountered.

A substring which is used to establish a tab position for a centered ("C") type tab extends to the next tab definition ("T" or "C") or to the end of the string, whichever is encountered first.

Example : nameset 3 $T2Alpha = alpha CL = cl

[Top][Bottom][Option list]

( BPnformat) (Command :print) Details for the nformat option.

[General syntax rules for this keyword.]

Normally, the DESL "print" function determines the actual Fortran format structure which will be used to print the desired variable names. This constructed format string can be overridden entirely by the specification of a string after "nformat". The specified names format string can be up to 64 characters long.

Example : nformat ?(20(1x ,a),3x, a8)?

[Top][Bottom][Option list]

( BPnocc) (Command :print) Details for the nocc option.

[General syntax rules for this keyword.]

Specification of this option will force the omission of all carriage control (cntrl-L) characters.

Example : nocc

[Top][Bottom][Option list]

( BPnoop) (Command :print) Details for the noop option.

[General syntax rules for this keyword.]

A dummy option which allows one or more GLOBAL conditions to follow. This option has NO OTHER FUNCTION.

[Top][Bottom][Option list]

( BPoutput) (Command :print) Details for the output option.

[General syntax rules for this keyword.]

By default, the standard output device will be the recipient of the report issued by the "print" function. If an alternate file is named via the "output" option all report type output will, instead, be written to the named file. If the named file already exists, the current system "overstore" state governs whether the output file can overstore the existing file. If NO overstore is allowed output will revert back to the standard device.

Example : output out1

[Top][Bottom][Option list]

( BPpage) (Command :print) Details for the page option.

[General syntax rules for this keyword.]

This option and its associated argument list allows the user to produce a "custom" report of variable names and or data. The order of this type of printing is that for each file each of the applicable pages will be printed in its entirety; ie, for file (k), page (i+1) will be started after page (i) has been completed for the entire file (k). The organization of this custom report is specified by the inclusion in the "page" argument list of a desired sequence of line "types", each indicated by a type "code" and, in some cases, an optional sub-argument. Each "page" option can have up to 20 type codes specified for it. Up to 10 different "page" specifications can be given.

The item immediately after "page" is the page number. The order in which the pages are specified is not important. However, the total number of occurrences of "page" IS the total number of pages defined. The page numbers associated with these "page" occurrences must be no more than the total number of pages defined or 10, whichever is less. Also, ALL pages, up to the total number of pages specified, MUST be defined.

Following the page number, file sequence numbers - values from 1 to the number of files to print - can be specified; are optional. Normally, if no values are specified, the page in question is printed for EVERY file specified. However, if file sequence numbers are specified, the page in question will ONLY be printed for files whose sequence number has been specified. Example : ... page 3 1 2 5 ... will cause the third page to be printed ONLY for the first, second, and fifth file specified.

The fields following the page number or following the optional file sequence numbers are the codes representing the types of lines to be displayed on the page being defined as well as other page attributes.

Any of the following "types" of lines can be included in such a report : "titl", allowing arbitrary text, date and time strings, or variable values to be displayed in an "as-is" justification; "ctitl", like "titl" except justification of title is centered; "lftitl", like "titl" except the applicable title is left-justified; "rtitl", like "titl" except the applicable title is right-justified; "blank", allowing the insertion of one or more blank lines; "pgno", allowing the page number to be printed at some specified horizontal position; "gap", forcing other than default spacing between columns of variable names/data; "space", indicating "data" horizontal line spacing; "name", indicating the page's names from the associated "nameset" argument list; "e", indicating which "textfiles" text file to read in; and "data", indicating the data values.

All line types which can be included in a report except the "data" type line imply that only one line of text or names will be inserted in the report. The number of "data" type lines which will be printed is a function of the current page length and the total lines required for printing all other types of lines on the current page, including those implied by the optional "at" option; "data" lines can take whatever space is left on a page after everything else has been accounted for.

The particular forms of the "type" codes and their optional sub-arguments are as follows. Parenthetical type code suffixes and following sub-argument values (#) are optional.



.       type   sub
.       code   arg   discussion

. (1) t(itl) (#) "#" is a title id number. (default = 1) . (2) c(titl) (#) "#" is a title id number. (default = 1) . (3) r(titl) (#) "#" is a title id number. (default = 1) . (4) l(ftitl) (#) "#" is a title id number. (default = 1) . (5) b(lank) (#) "#" is number blank lines. (default = 1) . (6) e # "#" is a "textfiles" file sequence no.

. (7) p(gno) (#) , where "#" is a positive or negative . number of columns. If positive, . # = offset from left margin. If . negative, # = offset from right . margin. ( default = 1) . (8) g(ap) (#) , where "#" is the minimum spacing . between adjacent columns of values . being displayed . (min = 1, default = 5 ) . (9) s(pace) (#), where "#" is the desired spacing . between successive "data" lines. . 2 = double, etc. ( default = 1 )

. (10) n(ame) , indicates "nameset" names for this page . are to be inserted. . (11) d(ata) , indicates that as many lines as possible . of the variables" values are to be . printed at the respective relative . position on the page. . (12) x forces the CURRENT page to CONTINUE at . the end of the PREVIOUS page, if space . remains on the PHYSICAL page. Normally . a different page causes a new physical . page.

Example : page 1 p -3 c 4 b n b d g 2

[Top][Bottom][Option list]

( BPpathfile) (Command :print) Details for the pathfile option.

[General syntax rules for this keyword.]

If specified, any up-to-16-charact string specified via the "paths" option and argument list can be translated to an up-to-64-charact string. If a specified "paths" string matches a string in the left column in the path file, then the (potentially longer) string in the right column in the same line in the path file is substituted for the original string. The rules for the syntax of a path file are the following :

  1. all lines are ASCII
  2. any line beginning with "* " is a comment and is ignored (asterisk + one or more blanks)
  3. blank lines are ignored
  4. only 2 items per line per translation : the first up to 16 characters and the second up to 64 characters. Any string longer than 16 characters MUST be enclosed in question-mark (?) delimiters.
  5. free-field interpretation, therefore embedded blanks require the "?" delimiters
  6. first item is name to be translated; must match VERBATIM with path name specified or implied via "paths" argument list
  7. second item is the corresponding path name translation

An example of such a file is the following :



*
*  Example path file for test xxx
*
*  item  1 = path to be translated : MUST
*             match VERBATIM with name given
*             specified/implied via "paths"
*
*  item  2 = resulting name translation
*
data56    ? \usr\home2\ people\test56\ ?
up  ?..\?
way-up  ? ..\..\..\ Temp46\?


Example : pathfile pathA

[Top][Bottom][Option list]

( BPpaths) (Command :print) Details for the paths option.

[General syntax rules for this keyword.]

Indicates, in a 1:1 correspondence with the list of files specified, directory locations for the specified files. These locations supersede the current directory. If a file location thus specified is not empty ("null...") a search for the respective file will be made at the indicated location before a search is made at any other alternate locations which have been made effective via a previous execution of the "path" command. By default, all path names are blank. Up to 200 path names can be specified.

Example : paths ..\ ..\Main\ sub1\

[Top][Bottom][Option list]

( BPpressure) (Command :print) Details for the pressure option.

[General syntax rules for this keyword.]

This option indicates that the printing for each page will be per record as opposed to per group of records as is normally the case. Up to 500 "nameset" variables associated with each nameset "page id" will be printed in one or more lines. (The normal "page" type output restriction of only being able to print one "line"'s worth of variable names and/or values is waived.) Only one record will be printed per physical page. Therefore, the output style caused by inclusion of this option is most suited to printing large amounts of information per SIF record.

[Top][Bottom][Option list]

( BPpscale) (Command :print) Details for the pscale option.

[General syntax rules for this keyword.]

If type is "postscript" then inclusion of the "pscale" option and argument will cause the resulting output file to increase (pscale argument > 1.0) or decrease (pscale argument < 1.0) in size on the page. Both "land" and "pscale" impact the maximum number of lines and columns which a PostScript "page" should/can contain. Same meaning as "scale".

Example : pscale .75

[Top][Bottom][Option list]

( BPpsl) (Command :print) Details for the psl option.

[General syntax rules for this keyword.]

If specified, the following value is a number of lines which will be used to establish an OVERRIDING maximum lines per page for PostScript output. Normally, if the current allowable maximum number of lines per page will cause PostScript printing to occur very near to the bottom margin or off the page, the program will temporarily reduce the maximum number of lines per page to force all printing to be positioned on the page with the proper margins.

Example : psl 90

[Top][Bottom][Option list]

( BPpsw) (Command :print) Details for the psw option.

[General syntax rules for this keyword.]

If specified, the following value is a number of columns which will be used to establish an OVERRIDING maximum columns per page for PostScript output. Normally, if the current allowable maximum number of columns per page will cause PostScript printing to occur very near to the right margin or off the page, the program will temporarily reduce the maximum number of columns per page to force all printing to be positioned on the page with the proper margins.

Example : psw 160

[Top][Bottom][Option list]

( BPscale) (Command :print) Details for the scale option.

[General syntax rules for this keyword.]

If type is "postscript" then inclusion of the "scale" option and argument will cause the resulting output file to increase (scale argument > 1.0) or decrease (scale argument < 1.0) in size on the page. Both "land" and "scale" impact the maximum number of lines and columns which a PostScript "page" should/can contain. Same meaning as "pscale".

Example : scale .5

[Top][Bottom][Option list]

( BPsubsfile) (Command :print) Details for the subsfile option.

[General syntax rules for this keyword.]

If the option "subsfile" is specified, then the name following "subsfile" represents the name of the desired "substitution file" to examine to check for matches of the value of any asterisk-delimit SIF variables which can appear in a "title" to be printed versus a specified (1) value +- tolerance or (2) value range. For an exclamation point-delimited SIF variable in a title, a substitution file WILL NOT be searched EVEN if one is specified.

The rules governing structure of a substitution file are the following :

  1. all lines are ASCII
  2. any line beginning with "* " is a comment and is ignored (asterisk + one or more blanks)
  3. blank lines are ignored
  4. free-field interpretation, therefore embedded blanks require the "?" delimiters
  5. Each line containing valid substitution specs MUST contain : in item 1, a SIF variable name to match an asterisk-delimit "title" (SIF) value; in item 2, a value which represents, if item 3 is also a value, the lower bound of a RANGE of values or, if item 3 is a name, the value to match EXACTLY; in item 3, a value which represents the upper bound of a RANGE of of values OR the (beginning of the) string to substitute for the value in question; in item 4, if there are more than 3 items specified, the (remainder of the) string to substitute for the value in question. Long strings (>16 characters) can be achieved by enclosing up to 64 characters with the standard question mark delimiters. As usual, if a string appears to be a number; ie, 3.0, then the question mark delimiters would have to be used to force interpretation as a string : ?3.0?.

    The strings to be substituted for values can contain any valid PostScript forms, including font changes, subscripting/sup and tabbing.

  6. The SIF variable name specified in item 1 WILL be translated to upper case UNLESS the "namecase" status is NOT in "force upper". (See the "namecase" and "status" commands.)

An example of a substitution file is the following :



*
*  Example substitution file for test ###
*
*  item  1 = name to be match for substitution
*  item  2 = either exact-match value OR
*             LOWER bound of value range
*  item  3 = either the UPPER bound of value range
*             OR the (beginning of the) substitution
*             string
*  item  4 = If value range was specified, the
*             (beginning of the) substitution string
*             If exact match was specified, this item
*             is optional and is a string continuation
*  flds 5-> = Optional string continuation
*
run  2.  ?Blunt body with vertical tail off?
run  3. 7.  ?Blunt body, vertical tails A thru E?
CONFIG  1 ?Config 1 : Ogive with lex ?


Example : subsfile subf1

[Top][Bottom][Option list]

( BPtabs) (Command :print) Details for the tabs option.

[General syntax rules for this keyword.]

This option provides the means whereby up to 26 horizontal tab locations can be explicitly set. The items following the "tabs" option MUST be in pairs, each pair containing (1) 1-char-tab-name, (2) location from left edge of page in inches. The tab names can ONLY be one of the upper case characters A-Z. There are no default tab locations. Tab locations stay set until explicitly or implicitly changed. Tabs can also be set implicitly by "namecase" or "title".

Example : tabs A 2.3 T 1.1 R 5.444

[Top][Bottom][Option list]

( BPtextfiles) (Command :print) Details for the textfiles option.

[General syntax rules for this keyword.]

If specified, names a up to 50 files whose contents can be pulled into a print "page"-style output file via the "e #" page code structure. (See "title" documentation.)

Example : textfiles unitrec1 unitrec3

[Top][Bottom][Option list]

( BPtitle) (Command :print) Details for the title option.

[General syntax rules for this keyword.]

A title is a line of arbitrary text, possibly including SIF variable names and data. The exact content of a "title" is indicated via the "title" option and argument list. Each "title" option is followed by a title id value and title body. Up to 50 titles can be defined and title id's can range from 1 to 50. The title body is a string of up to 150 characters enclosed, if there are any embedded blanks in the title, by the standard "free-field" question mark (?) delimiters. If "type" is "postscript" (see the "type" option) then any legal PostScript constructs can be contained in a title. If the title body is the string "blank" the title will be all blanks.

Also included in this string of characters can be up to 10 asterisk- or exclamation point-delimited constructs of the type :

  1. *file*, where "file" serves as an option implying that the current file name is to be substituted in that position

  2. *datetag*, where "datetag" serves as an option implying that the current date and time are to be substituted in that position,

  3. * name (fmt) * or ! name (fmt) !, where "name" is a SIF variable and "(fmt)" is an optional real format specification, or

  4. * value *, where value is a supplied number.

In the second case, when the title is printed on the appropriate "page" of output, this type of asterisk- or exclamation point-delimited string is replaced by a value, which is the value of the variable named within the string. The value of each variable indicated is set according to the position of the corresponding title on the output page with respect to the current record position in the SIF file being printed or, for "pressure" type output, is set each time the title is printed; ie, possibly once per SIF record.

If the delimiter used is an asterisk (*) and a substitution file has been specified via "subsfile", then for each such expressed or implied value to be printed a search through the substitution file is made to check for exact matches or range matches for the value of THE SIF VARIABLE IN QUESTION or, if a specific value was given, FOR ANY VARIABLE. If such a match is found the corresponding string in the substitution file is made in the title in place of the value in question. If, instead of the asterisk (*), the exclamation point (!) is used as a delimiter no search will be made for a string to substitute for the value in the applicable title EVEN IF A SUBSTITUTION FILE HAS BEEN SPECIFIED.

Only one variable is allowed per asterisk- or exclamation point-delimited string. If that variable is not found in the SIF file being printed, that delimited string is effectively eliminated from the title. The values displayed in a title are either in the current default format or can be printed in an optionally-speci other real format. Since the asterisk and/or exclamation point is used in the above-mentioned context for the "title" option/argument list, it should NOT be used for any other purpose in a title.

Since the characters "*" and "!" are used to imply a substitution, they MUST be specified via a backslash and three-digit octal number if they are included in normal text. (See the "text" option.)

If a title is being printed having been TRIGGERED BY AN "at", then this title can contain, as its body, the word "header" or "headers" to imply that the LATEST line of SIF names, or headers, (via "n" at "page") should be repeated as this title. Example : "....title 3 headers ..." If the title contains "header(s)" as its body and is being printed NOT having been triggered by an "at" then there is NO SUBSTITUTION for the word "header" or "headers".

Example : title 1 ?This is a title. ?

[Top][Bottom][Option list]

( BPtranslate) (Command :print) Details for the translate option.

[General syntax rules for this keyword.]

If type is "postscript" then inclusion of the "translate" option followed by one or two values will cause the x or x and y origin(s), respectively, of the output "page" image to be shifted by the number of INCHES specified. Any translation done is done with any "pscale" scale factor already applied; therefore, inches translated are scaled FIRST.

Example : translate 2 2

[Top][Bottom][Option list]

( BPtype) (Command :print) Details for the type option.

[General syntax rules for this keyword.]

If printed output is to be in one of a set of installed special formats, then that format's id must follow the "type" option. Also, printed output -must- be directed to an alternate output file via "output". Currently the set of installed special format ids is(are) :



(1) postscript ...


Indicates that, if a "page" style output is to be produced AND that the output is going to be written to an ALTERNATE file, then it will be generated to be compatible with a PostScript printer. Titles and alternate names (via "nameset") can contain characters which are meaningful to the DESL PostScript processor and can effect both output character sizes and styles. The case of ALL characters are "as entered".

There are 9 fonts which can be accessed. (See "font".) The default font is no. 11, Times-Roman. As a name or title string is processed from left to right any one of these fonts can be activated by including the font number preceded by a dollar sign ($).

All subsequent characters in the same name or title will also be displayed in this font until it is changed again.

An example of the use of the font changing characters is :



...title 1 ?The word $12wind$11 has 2 meanings.? ...


Here, the word "wind" will be printed in Times-RomanItali font. Since the font is changed back to the default of 11 again, though, from the word "has" to the end of the title all characters will be in Times-Roman font.

Some characters in each of the fonts cannot be implied by entering their character in a name or title; ie, some characters which a PostScript printer can print are NOT on a keyboard. To print a character which is not on a keyboard, a 3-digit octal number corresponding to that character in the desired font can be entered, PRECEDED BY AN ESCAPING BACKSLASH, \\ .

(See the P Fonts section of this document.)

The capability to print characters at 1 superscript level and 3 subscript levels also exists. If a character is preceded by either $N (default), $U, $D, $L, or $B then the size and position of that character, as well as remaining characters in the string in question until changed, will be affected. If a character is preceded by either $H or $P then the position only of that character, as well as remaining characters in the string in question until changed, will be affected.

The following explains the effect of each of these "$" prefixes :



$N ... default base level, standard size
$U ... superscript level, smaller size 1
$D ... subscript level 1, smaller size 1
$L ... subscript level 2, smaller size 2
$B ... subscript level 3, smaller size 3
$H ... higher than $U   , standard size
$P ... higher than $H   , standard size


An example of a title with the above type changes follows :



...title 1 ?C$DL$L $41a$11 $U12$N as a function of $41a?


Again, the "$" prefixes remain in effect until the name/title string ends or until explicitly changed again.



(2) checkpoint(s)


A format wherein, for the record(s) satisfying any global and/or file-specific conditions in effect, a report is issued in which EACH NAME-VALUE pair is printed. If "checkpoint" then ONLY the FIRST satisfying record is printed from each file. If "checkpoints" then ALL satisfying records are printed from each file. The current number of columns per page, whether in effect by default, from a "page" command execution, or temporarily as a result of having included the "cols" print option, determines the width of a locigal page. The width of a logical page, in turn, determines how many name/value columns of checkpoint listings can appear per physical page of output. Each name/data column pair requires 29 physical page columns. A minimum of 1 name/data column pair and a maximum of 4 name/data column pairs will be printed.

All titles defined will be printed AT THE TOP of each checkpoint report page. Blank lines can be forces by defining a title's body to be "blank".

Example : type checkpoint

[Top][Bottom][Option list]


DESL Home | Website Outline | Commands | Examples | Download | Contacts




ViGYAN, Inc.


DESL Manager at ViGYAN, Inc.

30 Research Drive
Hampton, VA 23666
Voice: (757) 865-1400
Toll Free: (800) 288-3998
FAX: (757) 865-8177

© 1998 ViGYAN, Inc.