Editor

This document covers the following topics:

• Editor Overview

• Starting the Editor

• Special Features

• Editor Commands

• Invoke the Online Help Facility

• Main Commands

• Line Commands

Editor Overview

The Natural ISPF Editor, Software AG's editing facility for Natural ISPF, is a variant of the Software AG Editor, specially adapted to the Natural ISPF environment.

This section provides an overview of Editor commands available in the Natural ISPF environment. For a detailed description of the Editor, see the Software AG Editor documentation.

The Editor provides ISPF-like functionality to display and/or edit Natural ISPF objects such as:

• Natural programs and error messages;

• PDS members and sequential files;

• z/VSE members and files;

• CA Panvalet members;

• CA Librarian members;

• BS2000 files;

• LMS library elements;

• Job SYSOUTs (browse mode only);

• Output in the user workpool;

• Lists of system objects (browse mode only).

Starting the Editor

The Natural ISPF screen from which you enter the Editor will depend on the type of object you wish to edit or display. For example, if you wish to edit a Natural member, you might enter the Editor from the Natural Object Entry Panel. The possibilities for entering the Editor are described under the appropriate section headings in this documentation.

If you specify a new object name for editing, you will see an edit screen similar to the following:

  EDIT-NAT:NATLIB1(JOB1JCL)-Program->Struct-Free-30K------------- columns 001 072
   COMMAND===>                                                    SCROLL===> CSR
  ****** ****************************** top of data *****************************
  ''''''
  ''''''
  ''''''
  ''''''
  ''''''
  ''''''
  ''''''
  ''''''
  ''''''
  ''''''
  ''''''
  ''''''
  ''''''
  ''''''
  ''''''
  ''''''
  ''''''
  ****** **************************** bottom of data ****************************
  Enter-PF1---PF2---PF3---PF4---PF5---PF6---PF7---PF8---PF9---PF10--PF11--PF12---
        Help  Split End   Suspe Rfind Rchan Up    Down  Swap  Left  Right Curso

The first line on the screen identifies the object to be edited according to the environment from which the Editor is called.

In the above example, JOB1JCL is the new member name and NATLIB1 identifies the object library which is a Natural library.

The edit screen contains four input fields:

• You can enter Editor main commands in the field labelled COMMAND in the second screen line;

• You can specify default scrolling amounts in the field labelled SCROLL in the second screen line;

• You enter Editor line commands by overtyping the line numbers on the left of the screen;

• You can enter data in the data area to the right of the apostrophes.

  You may now start your edit session by entering data into the edit screen and using the edit commands described in the subsection Editor Commands. When you press ENTER, the apostrophes on the left of the screen will be replaced by line numbers on used lines. Unused lines are automatically deleted.

Special Features

The Natural ISPF Editor provides some special features to make use of commands more comfortable. These features are described in the following subsections.

Cursor-Sensitive Command Selection

The Editor provides a feature that makes Editor command parameter input more comfortable. In any Editor session (LIST, EDIT or BROWSE a Natural ISPF object), Editor command input can consist of documentation command keyword input plus any word from the data displayed.

Any word can be selected by placing the cursor on it after typing :C in the command line. When you press ENTER, the :C directive is substituted by the selected string and the complete command is executed.

Example:

  EDIT0-NAT:NSPF101(JOB1JCL)-Program->Struct-Free-30K------------- columns 001 072
   COMMAND===> EDIT :C                                             SCROLL===> CSR
  ****** ******************************* top of data ****************************
  ...
  000010 MOVE A TO B
  000020 INCLUDE MYPROG
  ...

In the above edit screen, type the command:

EDIT :C

in the command line, move the cursor to the first character of the string MYPROG and press ENTER. The command executed is

EDIT MYPROG

Local Command Input

The Editor also allows you to enter object-specific commands from the Editor command line, for example the CHECK command when editing a Natural program. These commands are known as local commands and are described for each object type in the appropriate section of this documentation, as well as in the section Command Reference. If you enter an asterisk (*) in the command line and press ENTER, a window opens with a list of all local commands.

Command Redisplay

The Editor provides a command redisplay feature that retains the display of the Editor command last issued. Precede the command with an ampersand (&). After command execution, the command remains in the command line and remains in display every time you press ENTER until you clear the command line or overtype the displayed command.

The session command LAST is also available for Editor commands entered in the command line: the last ten commands consisting of more than one word and entered via the keyboard are displayed in a window and are selectable for editing and reexecution (see the subsection Session Commands - Description in the section Command Reference).

Editor Commands

The Editor provides two types of edit commands with which you can control your editing session:

• Main Commands
  entered in the command field on the second line of your screen. You can enter several commands in the same input operation, separated by a semi-colon ;n. For a full description of command syntax, see the Software AG Editor documentation.

• Line Commands
  entered in the command field of any line by overtyping the line number on the left of your screen. Line commands refer to the line on which they are entered or to a block of data delineated by line commands. You can also enter line commands in the main command line if you precede them with a colon (:). The cursor then marks the line to be addressed. Alternatively, you can enter line commands from the first column in the data area of any line if you precede it with the escape character (See your edit profile. For more information see the subsection Editor Profile in the section Profile Maintenance).

Your Edit Profile

Each user has edit profiles containing default settings of his edit environment. To see the current settings of your edit profile, use the Editor command PROFILE.

You can modify single settings in your edit profile using appropriate Editor commands. The new settings are valid for the remainder of the edit session or until you change them again using the appropriate Editor commands.

To modify multiple profile settings for the current session in one input operation

• Use the SET main command.

  You can maintain the default settings of your edit profile using the PROFILE option on the Natural ISPF Main Menu or by using the EDITPROF session command from any system screen.

Below is an example of an edit profile, followed by an explanation of profile parameters.

  EDITNAT:NSPF101(JOB1JCL)-Program->Struct-Free-30K-------------- columns 001 072
   COMMAND===>                                                    SCROLL===> CSR
  ****** ****************************** top of data *****************************
  =prof> date: 05/06/89 10:24:02 user: MBE      init size:00000 size:00000
  =prof> var   - 088,..recovery on  (0004 0000)...autosave off... empty line off
  =prof> mask off.caps off.hex off      nulls off.autoren off 10..auto order off
  =prof> log on  0001.mso on .fix off   .escape off + . ..tabs off    ...
  =prof> advance off.protect off.limit on
  =tabs>        *     *                       *                               *
  =cols> ----+----1----+----2----+----3----+----4----+----5----+----6----+----7--
  ****** **************************** bottom of data ****************************

Meaning of profile parameters:

Invoke the Online Help Facility

The Editor provides a comprehensive online help facility.

To invoke the online help

• Press PF1 from the edit screen, or

  Or:
  Issue the HELP main command.

  The online help Main Menu appears and you can select the topic on which you wish to display help text (options 1 to 6 allow you to enter the main command help texts at different places in the help structure).

  HELP---------------------- The NATURAL ISPF Editor ---------------------------- COMMAND ==> EDITOR The Editor allows you to create or change source data. The following topics are presented only if selected by number. Editor main commands are presented in alphabetical order, select a start value: 1 - ADVANCE 2 - COLS 3 - FILE 4 - INCLUDE 5 - ORDER 6 - SET 7 - Editor line commands 8 - Scrolling data 9 - NATURAL commands A - Sysout browsing commands Enter-PF13--PF14--PF15--PF16--PF17--PF18--PF19--PF20--PF21--PF22--PF23--PF24--- Help e :c Save; Suspe Rfind Rchan Up Down Swap Left Right Curso

  Some help texts are longer than one help screen. In this case, the help text will notify you with the message Continued and you can scroll the help using scroll commands.

Editor PF Key Assignments

Some Editor main commands are assigned to PF keys by default. You can modify these settings:

The PF12 and PF24 keys move the cursor to the command field in the second line of the edit screen. See also the subsection PF Key Assignments in the section Command Logic.

Main Commands

ADVANCE

Specifies whether the cursor will move to the next line automatically after a line update.

AORDER

Specifies whether ordering of data within the set boundaries is to take place automatically after a line update or when terminating insert mode. If an unqualified AORDER command is issued, it is interpreted as an AORDER ON command. Default setting is AORDER OFF.

AUTOREN

Specifies whether the lines are renumbered automatically after modification. If an unqualified AUTOREN command is issued, it is interpreted as AUTOREN ON. Default is AUTOREN OFF.

AUTOSAVE

Specifies whether the Editor will execute an automatic SAVE command when you issue the END command.

If an unqualified AUTOSAVE/ASAVE command is issued, it is interpreted as an AUTOSAVE ON command. Default setting is AUTOSAVE ON. Note that the setting of this command also affects the LOGOFF session command.

BNDS

Sets boundaries at specified columns between which text can be formatted. An unqualified BNDS command sets boundaries at the first and last column of the edit screen (default).

BOTTOM

Scrolls data until last screen of data is displayed.

CANCEL

Backs out all changes to data made during the current editing session and leaves the Editor.

CAPS

Specifies upper case translator of entered data. If you issue the CAPS command without a parameter, ON is the default.

CENTER

Centers specified data within set boundaries.

CHANGE

Changes the first specified character string into the second. If the strings contain blanks, they must be delimited by quotation marks.

COLS

Displays a line at the top of the editing subsection showing column positions.

COPY object-type library(member)

Copies data as specified in the command parameters into the current member.

If the current member already has data in it, you must mark the place where you wish the data to be inserted with an A or B line command.

If you wish to copy a member from the current library, use the command

COPY member

CREATE object-type library(member)

Creates the block marked by two CC line commands as new member in the specified object library.

If you wish to create a member in the current library, use the command

CREATE member

CURSOR

Typed in the command line, returns the cursor to the command line when you next press the ENTER key. This command is usually assigned to PF12. If you press PF12, the cursor will be placed in the command line.

CWINDOW

Copies a data window according to the command parameters.

DELETE

Deletes specified line(s) or line(s) containing a given character string. An unqualified DELETE command deletes the current line.

DOWN

Scrolls data down (forward). If the cursor is in the edit area, the scrolling amount is given by the current setting of the SCROLL field.

If an operand is specified and the cursor is in the command line, the scrolling amount (number of lines) is giving by the operand.

DWINDOW

Deletes the last defined data window.

EMPTY

Specifies whether blank line is to be suppressed. If an unqualified EMPTY command is used, it is interpreted as EMPTY ON. The default setting is EMPTY OFF (no suppression).

END

Stores the data including all changes and leaves the Editor.

ESCAPE

Activates the specified escape character to precede line commands entered in the first column of the data area. If an unqualified ESCAPE command is used, it is interpreted as ESCAPE ON. The default setting is ESCAPE OFF.

EXCLUDE

Excludes specified line(s) or line(s) with the given character string from display. Use the INCLUDE command to redisplay excluded lines.

EXPORT

Transfers a Natural ISPF object (PDS member, Natural program, view, sequential dataset, SYSOUT file, workpool entry, library list) to Con-nect or a PC. For further information, see the subsection Natural Interface to External Environments in the section Useful Features.

FIND

Locates a given string. If the string contains blanks, it must be delimited by single quotation marks. The cursor will be placed on the beginning of the string. If the line containing the string was excluded from display, it will now be included.

FIX

Specifies number of columns starting with column 1 to remain in display when scrolling right. The default setting is FIX OFF 000.

HEX

Sets hexadecimal display mode on/off.

IMPORT

Transfers a Con-nect document or PC file into Natural ISPF. For further information, see the subsection Natural Interface to External Environments in the section Useful Features.

INCLUDE

Recalls specified line(s) or line(s) with the given character string removed from display using the EXCLUDE command.

An unqualified INCLUDE command recalls the first line of an excluded block.

JLEFT

Justifies the specified data within the set boundaries to the left.

JRIGHT

Justifies the specified data within the set boundaries to the right.

JUSTIFY

Specifies order mode for data marked by a TO line command or two TOO line commands.

LABEL

Marks the current line with a character or string.

LC

Changes specified line(s) or line(s) with the given character string to lower case. An unqualified LC command will change the current line to lower case.

LEFT

Scrolls data to the left. If no operand is given, the scrolling amount is given by the current setting of the SCROLL field.

LOCATE

Specifies line to become the current line. The line can be specified by its number, label, or search string.

Please note the following differences between the LOCATE and FIND commands:

• If you issue the LOCATE command with a character string (L 'ABC'), the string is only found if it starts in column 1; the FIND command searches the whole data area;

• With the LOCATE command, it is assumed that the data to be searched is sorted in ascending alphabetical order;

• When a line is located with the LOCATE command, the cursor is placed in the prefix area; with the FIND command, the cursor is placed on the found string and the line is not necessarily made the current line.

• There is no wildcard (*) notation for the LOCATE command. Executing 'LOCATE X*' means finding the string 'X*'.

• The command searches only in uppercase.

• The cursor is placed on the line which precedes the first line whose string is greater than the search string.

LIMIT

Specifies maximum number of lines to be searched when the FIND or RFIND command is issued.

LOG

Specifies whether the log file is enabled or disabled for the session. When the log is active (LOG ON), the UNDO command allows you to back out changes made since the previous ENTER.

MASK

Adds mask line in each insert line operation. You can define a mask line using the line command MASK.

MWINDOW

Moves a data window according to the command parameters. The original data window defined is deleted as a result of the MWINDOW command.

NULLS

Sets null characters at end of each line.

Default is NULLS ON.

ORDER

Orders the specified data within the set boundaries using the BNDS command.

POWER

Switches Editor to enter text mode (blank screen, entered data is automatically ordered between the set boundaries on ENTER).

PREFIX

Specifies whether the Editor prefix area (6-digit line numbers) is to be displayed (PREFIX ON) or not (PREFIX OFF). If OFF is specified, the data area on the screen is increased by 7 columns. If an unqualified PREFIX command is issued, it is interpreted as PREFIX ON.

PRINT

Prints the contents of the current member on the printer defined in your host environment.

PROFILE

Displays your edit profile at the top of the edit screen.

PROTECT

Protects the prefix area (line numbers). To enter line commands with the prefix area protected, type the line command in column 1 of the edit area preceded by the escape character.

RCHANGE

Repeats the last CHANGE command. Usually assigned to PF6.

RECOVER

Activates or deactivates the recovery feature for the current edit session. You can also specify the number of updates to be performed before a checkpoint is performed.

If you issue the RECOVER command without parameters, the default is ON.

RENUMBER

For PDS members and sequential datasets only. Specifies renumbering of the lines in the edit area according to the parameters. To deactivate line renumbering, use the UNREN command.

REPLACE object-type library(member)

Overwrites an existing member with the block marked by two CC line commands in the specified object library.

If the specified member does not exist, REPLACE works like CREATE, that is, a new member with the specified identifiers is created.

RESET

Resets all pending line commands and deletes all line labels. Also resets all definitions made during the edit session (for example, mask line, boundaries).

RFIND

Repeats the last FIND command. Usually assigned to PF5.

RIGHT

Scrolls data to the right. If no operand is given, the scrolling amount is given by the current setting of the SCROLL field.

SAVE 'text'

Stores the member in the current library, including any changes to data. The editing session continues. If you are editing an existing member and versioning is active, you can specify a reason for changing the member in the text parameter. The reason must be enclosed in quotation marks.

SET

The SET command opens a window with the current edit profile settings. You can modify any setting by overtyping the current value.

SORT

Sorts specified data in an edit session alphabetically in ascending or descending order. Entered without parameters, the data is sorted in alphabetical order starting in line 1, column 1.

TABS

Sets physical and logical tabulation.

If the TABS command is used without the character notation, physical tabulation is set. If the TABS command is used with the character notation, logical tabulation is referenced. The default setting is TABS OFF with a blank. For example, the command

TABS %

activates the tabulator and sets the logical tabulation character to the percent sign (%).

TOP

Scrolls data up (backwards) until first screen of data is displayed.

UC

Changes specified line(s) or line(s) with the given character string to upper case. An unqualified UC command will change the current line to upper case.

UNDO

If the log file is active (see the LOG command), the UNDO command backs out all changes made since the last time you pressed ENTER. If you then issue the UNDO command again, all changes made since the previous time you pressed ENTER are backed out. You can thus back out all changes one by one until you restore the member to the status at opening time.

UNREN

Deactivates the renumbering of lines.

UP

Scrolls data up (backward). If the cursor is in the edit area, the scrolling amount is given by the current setting of the SCROLL field.

If an operand is specified and the cursor is in the command line, the scrolling amount (number of lines) is giving by the operand.

WINDOW

Defines a data window to be copied or moved. The starting line and column and the end line and column of the window are specified in the command parameters.

XSWAP

Exchanges displayed with excluded lines.

Line Commands

This subsection lists the Editor line commands with a brief description in tabular form. You can enter a line command in the command field of any line by overtyping the line number on the left of your edit screen.

Alternatively, you can issue line commands from the first column of the data area if you precede them with the Editor escape character (see your edit profile). The line command affects the line on which it is entered.

You can also issue line commands from the main command line if you precede them with a colon (:) . The command addresses the line marked by the cursor.

Each of the line commands listed in the table below is available in EDIT sessions. For LIST and BROWSE sessions, only a subset of line commands is available. The List and Browse columns indicate which line commands are valid in these sessions: an X means "available", an asterisk (*) means the command is available for BROWSE sessions held in the Editor buffer pool, especially for the objects NATURAL, VIEW, Workpool OUTPUT, Predict descriptions, Con-nect documents and Container Files, but not for most other Natural ISPF objects that can be browsed. The numbers refer to footnotes at the end of the table.

¹ In a list of datasets, the A line command is interpreted as the function command ALLOCATE.

² In a list of objects that allow the function commands BROWSE, INFORMATION or DELETE, the line commands B, I and D are interpreted as function commands.

³ In a list of objects that allow the function command RENAME, the line command R is interpreted as a RENAME command.

⁴ In a list of objects that can be edited or browsed, the line command S selects an object for editing or browsing, depending on the default function defined for that object type.

⁵ Wherever the COLS line command is not available, you can use the Editor main command COLS instead.