INTERNAL SYSTEM DOCUMENTATION FOR VAX/VMS FINANCIAL SYSTEMS GROUP ----------------------------------------------------------------- SUBJECT: Customized EVEPLUS Editor Description of Defined Keys, Keypad Diagram AUTHOR: Allen Watson LAST REVISION DATE: September 10, 1986 ----------------------------------------------------------------- Customized EVEPLUS Editor Page 1 Revised as of 10 September 1986 10:27 ___ _______ ____ __ ___ __________ _______ ______ THE DEFINED KEYS OF THE CUSTOMIZED EVEPLUS EDITOR The newly customized version of the EVE text editor is finally available. This document will briefly describe it, including a keypad diagram. I hope to be able to complete a full document describing all its features in the near future. 1 HIGHLIGHTS OF THE NEW EDITOR ________ ______ ______ ___ ___ _________ 1. EDT-like keypad layout for all terminals The new editor defines the auxiliary keypad very much like the old EDT editor, for compatibility and ease of use for people moving from EDT to EVE. A few seldom-used EDT keys have been redefined to take advantage of more useful commands available in EVE. The keypad layout is the same whether you are using a VT100 or VT200 terminal. The VT200 users have the advantage of the "gray keys" on their keyboard. Many of these are defined as well, if you have a VT200 terminal. ____ _________ ________ _______ _____ __ ________ ___ __ ___ 2. Many functions included besides those in standard EVE or EDT Most of the editing procedures defined in the EVEplus editor from DECUS have been included, as well as several dozen written by me. Only those most frequently useful have been tied to specific keys. The full document on our EVEPLUS will describe each of these procedures and how to use them, as well as how to define single keys to access them. 2 HOW TO ACCESS EVEPLUS To make this new editor your editor, you can choose one of two simple techniques. Both involve adding a single line to the LOGIN.COM file that is in your login directory. Without adding one of these lines to your LOGIN.COM file, you will continue to access the copy of EVE that you are now using. The standard EVE editor file, EVESECINI.GBL, has not been altered in any way. 2.1 Method One In your LOGIN.COM file, add the following line: Customized EVEPLUS Editor Page 2 HOW TO ACCESS EVEPLUS $ DEFINE TPUSECINI COMMONDISK:[SYSLIB]EVEPLUS When you wish to access the new editor after logging in, all you need to do is enter the command: $ EDIT/TPU file-name This part is optional: To make it even simpler, you can add a second line to your LOGIN.COM like this: $ TPU :== EDIT/TPU Now you will be able to enter the editor with the command: $ TPU file-name 2.2 Method Two Instead of Method One, you can use this, which combines both of the above into a single line in your LOGIN.COM: $ TPU :== EDIT/TPU/SECTION=COMMONDISK:[SYSLIB]EVEPLUS Now, to access the editor, just use the command: $ TPU file-name This method gives you the option, if you wish, of accessing the standard EVE editor via a simple "EDIT/TPU" command, or of having a personal copy of EVE that you access in that way. Users sophisticated enough to create their own version of the editor will know what this means and how to do it. 2.3 Method Three -- Spawning If you wish, you can set up to use EVE in a spawned subprocess. This allows you to keep your copy of EVE active while you exit out to your standard parent process at the DCL level, and to use the ATTACH command to switch back and forth between EVE and the DCL level. A command procedure has been written to do this for you simply. It defines the F20 key on your VT200 type terminal as the Attach command; when in your parent process at DCL level, F20 will attach to the EVE subprocess; when you are in EVE, F20 will attach to the parent process. To set up for keeping a spawned copy of EVE in a subprocess, use the following definition: $ EVE :== @SYS$COM:SPAWNEVE Customized EVEPLUS Editor Page 3 PROCEDURES AVAILABLE THROUGH DEFINED KEYS 3 PROCEDURES AVAILABLE THROUGH DEFINED KEYS The following section briefly describes each of the functions that are defined on keys in EVEPLUS. Users familiar with EDT will recognize most of them. Where the EVEPLUS function differs in some way from the older EDT function, I will explain the differences. First I will describe the functions available through the auxiliary keypad. Then I will discuss functions that are available on other keys using the CTRL and GOLD keys. 3.1 Arrow Keys All four arrow keys function as in EDT, moving the cursor on the screen up, down, left or right. The cursor will "wrap" when reaching end of line to the next line below or above, depending on the direction of movement. This is the way EDT functions; it differs from the behavior in the standard EVE editor. 3.2 GOLD Key The key labelled PF1 is the EVEPLUS "Gold" key, a kind of special shift key that allows two functions to be placed on every other keypad key. When a function is said to be accessed by "Gold KP7", for example, it means that you must strike the Gold Key (PF1), and then the "7" key on the keypad. You press the keys one after the other, not simultaneously. 3.3 HELP Key The PF2 key will call up a keypad diagram similar to the one at the end of this document, showing the functions of the various keys. If you want help on particular EVE commands, use the Do Key (or Gold KP7) and type "help". 3.4 FIND And FNDNXT Like EDT, the FIND command is accessed via Gold PF3. It prompts for the string to search for, and then locates the first occurance. FIND uses the EVE Find Command, not the EDT version. It will search first in whatever the current direction is for the buffer (shown as the last word in the status line at the bottom of the window on the screen). If the word is not found in that Customized EVEPLUS Editor Page 4 PROCEDURES AVAILABLE THROUGH DEFINED KEYS __ direction but is found in the opposite direction, it will ask if you wish to change direction and go to that location. The FNDNXT command (Find Next) is accessed via PF3. After a Find Command has been executed, FNDNXT will find the next occurance of the same string. It also uses the EVE Find. The Find command can also be executed on VT200 terminals with the gray key labelled "Find"; striking the key twice will perform the equivalent of Find Next. 3.5 Delete Line And Undelete Line The PF4 key performs a Delete Line function. (The TPU code for this is a version written by me.) Actually it deletes from the current location of the cursor up to the end of line. If you hit Delete Line when the cursor is on a blank line, it will delete the blank line. Thus, to entirely delete one line, you should position the cursor at the left end of the line (CTRL/A, CTRL/H, or Backspace will do _____ this) and press Delete Line (PF4) twice, once to delete the text on the line, and once to delete the remaining blank line. Gold PF4 performs Undelete Line, inserting the text last deleted by Delete Line. Undelete Line has a peculiarity; sometimes you will find that it inserts an extra blank line after the text being inserted. You can easily delete this extra line; sorry I haven't had time to fix up this function better. 3.6 PAGE Command The KP7 key will perform a "page" function, searching ahead in the buffer for the next occurance of a Form Feed character. This is useful only in editing files output by Runoff or listing files generated by a computer program. 3.7 EVE COMMAND To execute an EVE command directly, you can use GOLD KP7. You will be prompted for the EVE command you wish to execute. ______ ____ ____ ____ ____ __ _ ____ _________ _____ ____ ___ ___ Please take note that this is a very different thing than the EDT _________ _________ "Command" function! This key is equivalent to the "DO" key on a VT200, or in normal EVE. You can use it as you do in EDT to "quit" or to "exit". You can also use it to access any of the commands listed by HELP when you access help via this key and the "HELP" command. Customized EVEPLUS Editor Page 5 PROCEDURES AVAILABLE THROUGH DEFINED KEYS ___ ____ _________ _______ On the topic of exit, one very important warning. The CTRL/Z ____ ____ ___ key, which in EDT entered EDT command mode, will exit from the _______ ______ EVEPLUS editor. You will not lose any files; anything modified will be written out (at your option -- you will be asked if you want to write all but the current buffer, which will be written automatically). But you could lose your place. CTRL/Z is the simplest way to exit EVEPLUS, and the one I recommend using. 3.8 Section Command You access the Section Command via the KP8 key. Like EDT, Section is defined to move your cursor sixteen lines in the direction of current movement. At the start, the direction of movement is "forward" from the top of the file to the bottom. You can alter the direction of movement with the Advance or Backup commands. Direction of movement can also be changed by the Find Command if your search requires a change of direction. There is no way to alter the definition of the number of lines moved by Section. If you have a VT200, you still have use of the Prev Screen and Next Screen keys, which perform a function similar to Section but move in a predefined direction. On any terminal, including VT100's, you can also access Prev Screen with CTRL/P, and Next Screen with CTRL/N. 3.9 Fill Command The Fill Command is accessed via Gold-KP8. ___ _________ Fill performs a "fill paragraph" function, and is not identical __ ___ ___ ____ _______ to the EDT Fill command, which filled a region defined with the Select key. It recognizes the following paragraph delimiters: a blank line, a line beginning with one or more spaces (not tabs), or a Runoff command in column 1 (a line beginning with a period). Fill repaints the paragraph on the screen, adjusting the words on each line to fit as many words as possible per line. Fill can be executed with the cursor anywhere within the confines of the paragraph; when it completes, the cursor will be at the end of the paragraph. The first line of the paragraph will always be indented one space by Fill. (This version of Fill Paragraph was written by me.) Customized EVEPLUS Editor Page 6 PROCEDURES AVAILABLE THROUGH DEFINED KEYS 3.10 Append Command You access the Append Command via the KP9 key. Append works in conjunction with the Cut and Paste commands (called Remove and Insert Here in standard EVE). To use Append, you first use the Select key to mark one end of a region, and move the cursor to the other end of the region of text. The region will be defined in reverse video. If you press Append at this point, the region you have defined will be removed from the ________ screen and appended to the current contents of the Paste Buffer. The primary difference between Append and the Cut Command (Remove) is that Cut clears the Paste Buffer and moves the defined text into it, while Append does not clear the buffer, but appends the new section of text to that which is already in the Paste Buffer. Functionally it is identical to Append in EDT. 3.11 Replace Command You access the Replace Command via the Gold-KP9 key. The Replace function executed by this key is the EVE version of Replace; it is not identical to EDT's Replace, but better. In EDT, finding one string of text and replacing it with another required a complicated sequence of commands involving Select, Replace, and Substitute. In EVEPLUS, Replace is a self-contained function. Replace will prompt you for the "old string" and the "new string". It uses Find to locate the first occurance of "old string" and asks if you wish to replace it. You have the option, each time Replace stops at a new occurance of "old string", to _ _ reply with Yes, No, All, Last, or Quit. The meaning of Yes and __ ___ No are obvious. All instructs Replace to find and replace all ____ remaining occurances. Last says to do this replacement, and then ____ stop here. Quit says simply to stop here without replacing any more. Use of this version of Replace has eliminated the need for the Substitute command, so that key is used for another purpose. 3.12 Delete Word And Undelete Word You access Delete Word via the keypad Comma key, and Undelete Word via Gold-Comma. Again, there is a slight difference between EVE's Delete Word and EDT's. EVE's version will delete the entire word the cursor is sitting on. EDT's version required that you place the cursor on Customized EVEPLUS Editor Page 7 PROCEDURES AVAILABLE THROUGH DEFINED KEYS the first character of the word to delete it all; otherwise it deleted from the cursor location to the end of the word -- or the start of the word if the current direction was reverse. The behavior in EVE is much more consistent. The word deleted is kept in a special memory location (not an EVE buffer), and can be recalled with Undelete Word. You can recall the word and insert it anywhere in the buffer; it does not have to go back to the same place, and can be inserted more than once. _______ Warning: in EDT, the storage areas for Delete Word and Delete Line were separate areas. In the current EVEPLUS they are the ____ same. Thus, if you use Delete Word followed by Undelete Line, you will recall the word, not the last line deleted. (Delete Character has its own single character storage area.) 3.13 The Advance And Backup Commands You access Advance via KP4, and Backup via KP5. These two commands set the direction of movement within the current buffer. The change is reflected in the status line at the bottom of the buffer; Advance sets the status line to "Forward", and Backup sets it to "Reverse". Commands that are affected by the direction of movement include the Line and Word movement keys, Find, and Replace. 3.14 The Bottom And Top Commands You access Bottom via the Gold-KP4 key, and Top via the Gold-KP5 key. As in EDT or standard EVE, Bottom takes your cursor to the bottom of the current editing buffer. Top takes you to the top, or beginning of the buffer. 3.15 Cut And Paste Commands You access the Cut Command with KP6, and the Paste Command with Gold-KP6. ___ These commands function exactly as in EDT. To cut or remove an area of text from the screen, you first define one end of it using the Select key (Keypad Period or the gray key marked "Select" on VT200's), and then move the cursor to the other end of the area. The defined region is highlighted in reverse video. Pressing Cut (KP6) removes the defined text from your current Customized EVEPLUS Editor Page 8 PROCEDURES AVAILABLE THROUGH DEFINED KEYS buffer and copies it into the Paste Buffer. The Paste Command will insert the current contents of the Paste Buffer at the current location of the cursor. You can move the cursor anywhere before inserting, even into other buffers. You can insert the text as often as you wish. Thus, you can use Cut and Paste to move text from one part of a document to another, or even to move it between documents. See also the Append Command, described above, and the Copy Text Command, described below. These commands also use the Paste Buffer. On VT200 terminals, the Cut Command can be executed using the gray key labelled "Remove"; the Paste Command can be executed using the key labelled "Insert Here". 3.16 Delete Character And Undelete Character You access Delete Character via the keypad Comma key, and Undelete Character via Gold-Comma. __ _____ ___ ______ __ Delete Character will delete the character on which the cursor is _________ _______ currently resting. This differs from the Delete key, which deletes the character to the left of the cursor (the last character typed, usually). You can think of it this way: the Delete Key will delete characters to the left of the cursor; repeated taps on this key will delete toward the beginning of the line. The Delete Character key, by contrast, deletes to the right of the cursor; repeated taps will delete toward the end of the line. Also, the characters deleted by the Delete Key are not saved. The Delete Character key always saves the last character deleted so it can be restored if you wish. Undelete Character will restore the last character deleted with Delete Character. Sometimes this can be useful as a means of copying non-printing characters such as Form Feeds or Escape characters. 3.17 Word Command The Word Command can be accessed via KP1. The Word Command moves the cursor forward or backward in the buffer (depending on the direction of movement currently set) by one word at a time. It is a useful way to move quickly to the middle of a line, for example. It always moves to the first character of a word. To change the direction of movement, use the Advance or Backup command before using Word. Customized EVEPLUS Editor Page 9 PROCEDURES AVAILABLE THROUGH DEFINED KEYS 3.18 Change Case You access Change Case via the Gold-KP1 key. Change case will invert the case (upper or lower) of all the text in any region defined by the Select key. Lowercase letters will __ __ ______ __ ____ ___ ____ become uppercase, and vice versa. If no region of text has been ________ selected Change Case will change the case of the single character at the current cursor location. Several other case-changing commands are also available as extensions. Gold-C will capitalize a word, making the initial letter uppercase and all other letters lowercase. Gold-U will make a word all uppercase; Gold-L will make a word all lowercase. 3.19 End Of Line (EOL) You access End of Line via the KP2 key. End Of Line moves the cursor to the end (right end) of the current line. This function can also be executed in EVEPLUS with the CTRL/E key. 3.20 Delete To End Of Line (D EOL) You access Delete to End of Line via Gold KP2. In EVEPLUS this is the same function that is executed by the PF4 (Delete Line) key. 3.21 Change Mode You access Change Mode via the KP3 key. In EDT, KP3 performs a "character" function, moving the cursor one character in the current direction. Since this is so easily accomplished with the arrow keys, I have chosen to use this key for a function not available in EDT -- Change Mode. Change Mode alters the way editing is performed in the current buffer. Normally, you are in Insert Mode, similar to EDT. Characters you type on the keyboard are inserted at the current location. If there are other characters on the line they are moved over to make room for the new characters being inserted. The alternate mode is Overstrike Mode. In this mode, if you place the cursor on an existing character and type new characters, the new characters replace those already in the Customized EVEPLUS Editor Page 10 PROCEDURES AVAILABLE THROUGH DEFINED KEYS buffer. Overstrike Mode is very useful when editing fixed format documents such as tables and lists, where you do not want to disturb the relationship of the columns of numbers, for example. The Change Mode key will alternate between modes. The current mode is displayed in the status line of the buffer. 3.22 Buffer You access the Buffer Command via Gold-KP3. In EDT, this key executed the SpecIns command, which is not needed in EVE. The equivalent function (to insert characters such as control characters) can be performed with CTRL/V in EVEPLUS. The Buffer Command allows you to change to another buffer, by name. Press this key, type the name of the buffer you want (which is usually the same as the name of the file you are editing in that buffer), and your screen or window will clear and be replaced by the contents of the buffer you have named. To assist you in working with several buffers, a List Buffers command has been created and defined on Gold-B. When the buffer list is displayed, you can move the cursor up or down to the name of the buffer you want, and press Select (or keypad Period) to select that buffer for editing. You can create a new buffer using the Buffer Command. Simply type the name of a buffer that does not yet exist, and EVEPLUS will create it for you. The Get File Command (see below) also creates a new buffer for each file you read in. One nice convenience of the Buffer Command: you do not need to type the entire name of the buffer you are looking for. For instance, if you have a buffer called "EVEPLUS_BERGEN.RNO", and no other buffer begins with the letters "EVE", then using the Buffer Command key and typing "EVE" for the buffer name will move you to the EVEPLUS_BERGEN.RNO buffer. If the fragment of a buffer name you type is ambiguous (more than one buffer matches the string) EVEPLUS will tell you so. 3.23 Get File You access Get File via the keypad Enter key. In EDT the Enter key was used mainly as a command terminator; its use in this way in unneeded in EVEPLUS, so I have assigned some useful commands to it. Customized EVEPLUS Editor Page 11 PROCEDURES AVAILABLE THROUGH DEFINED KEYS Get File allows you to read in files in addition to the one called up when you first invoke the editor. These files are read into newly created buffers. Each file has its own buffer, and all are available for editing. You can use the Buffer or List Buffers command to move from one buffer to another. EVEPLUS remembers which buffers have been modified, and when you exit the editor it will always ask you if you want to write out the modified buffers. Get File will prompt you for the name of the file to be read in. It will always default to searching the device and directory that were your default when EVEPLUS was started up. If you want a file from a different directory you must include the directory name as part of the file specification you type. Sometimes when you are editing for a long time and using many files, you may forget that you have read in a file and use Get File to read it again. Get File always looks first to see if you have the file you requested in a buffer already; if you do, it simply changes to that buffer and does not read the file a second time. 3.24 Write File You access Write File via the Gold-Enter key. Write File will write out the contents of the current buffer into the file associated with that buffer. It will write the buffer regardless of whether or not it has been modified. Writing a buffer out changes the status of that buffer to "Not Modified". (You can see the status of a buffer by using the Do Key or EVE Command Key (Gold-PF7), and then typing "SHOW".) If no file name has yet been associated with the buffer (say you created it with the Buffer Command and just typed new text in it), Write File will prompt for the file name to use in writing. ___ ____ If you want to write a file out under a new name you can do so. For example, you read in a file A.TXT, alter it, and wish to create a new file called B.TXT, rather than a new version of A.TXT. To do this, use the Do command, and type "WRITE FILE new-file-name". The buffer will be written out using the new ___ ____ ____ __________ ____ ___ ______ ____ __ name. Also, the file name associated with the buffer will be _______ __ ___ ___ ____ changed to the new name; the name of the buffer itself, however, will not change. In the example, the buffer would still be called A.TXT, but the file associated with it would be B.TXT. 3.25 Line Command You access the Line Command via the KP0 key. Customized EVEPLUS Editor Page 12 PROCEDURES AVAILABLE THROUGH DEFINED KEYS This functions just like Line in EDT. It moves the cursor to the first character of the next line in the direction of current movement. 3.26 Open Line Command You access Open Line with Gold-KP0. This functions very much like the EDT Open Line command. There is a significant difference, however. Open Line cannot be used to split an existing line in two, as can be done in EDT. With the cursor anywhere in a line, Open Line will always insert a _____ new, blank line above that line, and move the cursor onto the left end of the new line. To split a line in two, just use the Return key. 3.27 Select Command You access the Select Command via the keypad Period key. This functions just like Select in EDT or standard EVE. It marks the current location as the beginning of a range. When you move the cursor, the characters between the selected point and the cursor become highlighted in reverse video. The region selected can then be operated on with commands such as Cut, Append, or Change Case. You can cancel a selected range by striking the Select key a second time. The gray Select key on VT200's performs the identical function. 3.28 DCL Command And Window Commands You access the DCL Command via Gold-Period. In EDT this key executed the Reset command, which is not needed in EVEPLUS. This command opens up a whole new world which was not available to EDT users. By this commmand you can execute any DCL command that does not do special screen control -- for example, you should not use it to execute a program that displays menus and changes terminal characteristics. Most DCL commands do not do this. Customized EVEPLUS Editor Page 13 PROCEDURES AVAILABLE THROUGH DEFINED KEYS For instance, if you type Gold-Period and then "DIR" at the prompt, EVEPLUS will split the screen into two windows and execute a DCL Directory command. The output of the command, the directory listing, will appear in the second window. You must use Gold-Period to enter each new DCL command; the output of additional commands will be appended to the DCL buffer in the window. The first time you do this you will probably start wondering how to move your cursor from one window to another, or how to get rid of the DCL window when you are done with it. There are several ways. I will present the most basic one (part of standard EVE) here, leaving detailed discussion of windows for the document on EVEPLUS Enhancements. All of the following commands must be accessed by using the Do Key and typing the command name. (On VT100's, use Gold-7 instead of Do.) To move between the two windows, use the command "Other Window". The word "other" is enough to allow EVE to recognize the command. To get rid of the DCL window, put the cursor in the window you wish to keep on screen and use the "One Window" command. The word "one" is enough. The window containing the cursor will become the only window on the screen. The DCL buffer is not destroyed, and you can return to it using the Buffer Command and the buffer name "DCL". If you perform another DCL Command later, the output from it will be appended to the same DCL buffer. You can edit the DCL buffer if you desire. For instance, you can Cut parts of the output from a DCL command and then Paste it into your text buffer as part of a document. Typing into the DCL ____ ___ buffer will not cause what you type to be executed by DCL; you must use the Gold-Period key to do that. To complete the mini-set of window commands, if you want to have two editing windows, the command "Two Windows" will split the screen into two windows. The word "two" will suffice. You can use the two windows to view and edit different parts of the same buffer (this is the default when you first create the second window), or you can use the Buffer or Get File commands to read a different file into the second window. END OF KEYPAD FUNCTIONS This is the end of the functions available on the auxiliary keypad. The remaining functions are accessed through use of the CTRL or GOLD keys plus keys on the normal keyboard. Customized EVEPLUS Editor Page 14 PROCEDURES AVAILABLE THROUGH DEFINED KEYS 3.29 Start Of Line The Start of Line command moves the cursor to the beginning (left end) of the current line. It is available on the Backspace key of VT100's, the F12 key of VT200's in VT100 mode, and the CTRL/A and CTRL/H keys of both types of terminals. 3.30 Delete The Delete Command deletes the character to the left of the cursor. It is accessed via the Delete Key (on VT200's the key legend is like this: