NOTEBOOK MANAGEMENT Using the NOTEBOOK PACKAGE from VMTOOLS Release 7.01

19 November 1991

Geoff Brain

IBM Australia
Coonara Avenue
West Pennant Hills N.S.W.
BRAIN at SYDVM1
NOTEBOOK MANAGEMENT
Using the NOTEBOOK PACKAGE from VMTOOLS
Release 7.01

Table of Contents

Overview

  • Features
  • Important changes compared to previous versions

    Installation

  • NOTEBOOK Management Installation and Configuration
  • Installation
  • Removing NOTEBOOK
  • Tailoring the NOTEBOOK environment

  • By changing the NOTEBOOK XEDIT macro
  • By creating a NOTEBEXT XEDIT macro
  • Using the NOTEBOOK command 'SETUP'
  • Using NOTEBOOK

  • For NOTEBOOK Management
  • Using the NOTEBOOK EXEC
  • Using the NOTEBOOK XEDIT macro
  • For general editing
  • For NOTEs
  • For PEEKing
  • For FILELIST
  • For RDRLIST
  • Using TODO

  • Description of the TODO facility
  • Using of the TODO facility
  • Commands

  • Commands in Summary
  • Commands in Detail
  • Usage Notes/Hints/Credits

    Maintenance

    Release Changes


    Overview

    The NOTEBOOK PACKAGE allows you to better manage your notebooks under CMS. You can also use the NOTEBOOK PACKAGE to enhance the functions of NOTE, FILELIST, RDRLIST and PEEK. Throughout the rest of this document the NOTEBOOK PACKAGE is referred to as 'NOTEBOOK'. An overview of the NOTEBOOK functions are provided below.

    A TODO facility is also provided. This facility allows you to better manage reminders and todo lists.

    A brief description of the Notebook commands is provided in "Commands in Summary". A detailed description of the commands is provided in "Commands").

    Installation details are found in "NOTEBOOK Management Installation and Configuration".


    Features

    The NOTEBOOK management facilities made available to you include the ability to perform the following functions on notes within CMS notebooks.

    If you use the NOTEBOOK XEDIT macro as your PROFILE XEDIT then the added functions you get include:

    If you use the NOTEBOOK XEDIT macro as your PROFILE for PEEK, RDRLIST, FILELIST or NOTE then you will obtain the following benefits:

    The SETUP command allows you to customize your NOTEBOOK environment and to customize your XEDIT environment. There are approximately 20 customizable functions, for example, you can tell NOTEBOOK:

    Finally you can use NOTEBOOK to view FORUMS and script file that contain foils (ie. APAFOILS or FOILS5). As mentioned previously, in NOTEBOOKs individual notes can be displayed and manipulated. These function can be also be used for forum entries in FORUM files and for foils in a SCRIPT or FOILS files. That is in FORUMs individual forum entries can be displayed and manipulated. That is in FOILs files individual foil entries can be displayed and manipulated.


    Important changes compared to previous versions

    There are 2 significant changes to this version (6) of NOTEBOOK compared to previous versions that should be understood.

    1. PROFS compatibility

      Through the NOTEBOOK SETUP function you can configure NOTEBOOK to send NOTEs in PROFS compatible format. In the previous version of NOTEBOOK this simply sent CMS NOTES using SENDFILE with the OLD option (this PUNCHed notes instead of sending them in NETDATA format as would normally occur by default).

      In this version if you select PROFS compatibility then notes will actually be formatted into PROFS notes and sent in real PROFS format. In addition you can send CMS NOTES in PROFS MESSAGE mode but leave the notes formatted as CMS NOTES.

      The LONG/SHORT, ACK/NOACK, LOG/NOLOG, and NOTEBOOK options are all still implemented as if the NOTE were a CMS NOTE.

      In addition, in PROFS compatibility mode the ".at" tag is also recognized. If the ".at" tag is found starting in column one in the note being prepared then the note when sent has all the address information suppressed and the "To:" tag has the text following the ".at" tag included in the sent note.

    2. The reminder/todo facility

      This function has been completely re-written and is incompatible with the previous versions of NOTEBOOK. I have done this to make the reminder facility a todo list management facility. This facility is modeled along the lines of the TODO PACKAGE on VMTOOLS - that is the TODO files are compatible. In the NOTEBOOK implementation there are several additions:

      To migrate to this facility will require you to re-enter the reminder data from the old NOTEBOOK facility. If you have a large reminder file from the old version of NOTEBOOK you could re-organize it using XEDIT to the new todo format. See "Using TODO" to understand the file structured so you can (attempt) do this.

      This change was made to standardize on a TODO format as already widely accepted and to allow reminders and todo items to be found and used by the CALWEEK3 PACKAGE.


    Installation

    The installation of the NOTEBOOK functions and the use of the NOTEBOOK macro as the profile for editing using XEDIT, FILELIST, RDRLIST, PEEK and NOTE are described below.

    The NOTEBOOK facility requires that you have at least a three megabyte CMS virtual machine. A four megabyte machine is preferable.


    NOTEBOOK Management Installation and Configuration

    To install NOTEBOOK perform the following steps. If you have problems then you can perform the steps listed in "Removing NOTEBOOK" to un-install NOTEBOOK.

    Installation

    1. Ensure the following files are on one of your accessed minidisks:

    2. You can access NOTEBOOK in either of two ways.

      1. Using the NOTEBOOK EXEC (see "Using the NOTEBOOK EXEC")

      2. Using NOTEBOOK when ever you edit any file using CMS, it can sense files that are of type NOTEBOOK, SCRIPT, etc. (see "Using the NOTEBOOK XEDIT macro")

      If you only plan to use NOTEBOOK via the use of the NOTEBOOK EXEC then skip this step. If you have a PROFILE XEDIT and you wish NOTEBOOK to be used whenever you edit a notebook file then you will need to do the following.

      Save your PROFILE XEDIT by renaming it to PROFILE XEDITOLD.

      Edit NOTEBOOK SAMPPROF. Following the instruction in the header records make the required change. The instructions ask you to go the end of the file and to insert after the comments that are there the contents of your old PROFILE XEDIT (ie. GET PROFILE XEDITOLD).

      Now file the altered NOTEBOOK SAMPPROF as PROFILE XEDIT (ie. FILE PROFILE XEDIT A).

    3. The following need only be performed if you wish to used the additional features of NOTEBOOK for RDRLIST, FILELIST, NOTE and PEEK. If you wish to be able to FORWARD notes and to receive and display notes from your reader then this step must be performed. Issue the following commands from CMS:

    4. You are now set to go. To try out the facility XEDIT a notebook and look at the changes.

      If you are going to use the NOTEBOOK EXEC command then enter the command NOTEBOOK from CMS and edit any NOTEBOOK file by pressing PF key 11.

      If you setup a PROFILE XEDIT as your main interface then either enter FILELIST and XEDIT any notebook file or XEDIT any notebook file directly by using the XEDIT command.

      You need only use the PF keys until you are familiar with the more enhanced functions. I find that all I ever need to use are the PF keys.

    5. To customize your environment enter the command SETUP from the XEDIT command line. Now alter the SETUP fields to reflect your customization requirements. A "?" in any field will provide you will brief help. See the SETUP command ("SETUP") for additional details about the SETUP command.

    Removing NOTEBOOK

    To remove NOTEBOOK from your CMS environment perform the following:

    1. Restore the RDRLIST, FILELIST, NOTE and PEEK profiles to the CMS defaults. To do this issue the following commands from CMS.

    2. Erase the PROFILE XEDIT if you had created it from NOTEBOOK SAMPPROF. Before you erase your PROFILE XEDIT ensure you have a copy of your old profile, PROFILE XEDITOLD, otherwise skip this step. Then rename you old profile from PROFILE XEDITOLD to PROFILE XEDIT.

    3. NOTEBOOK has now been un-installed.

    Tailoring the NOTEBOOK environment

    You can tailor the NOTEBOOK environment using one or a combination of three approaches.


    By changing the NOTEBOOK XEDIT macro

    This method requires that you have skills in REXX and XEDIT. If you have these skills then you can edit the NOTEBOOK XEDIT macro and change PFKEY setting, synonyms, etc as you wish. Avoid making changes that affect the logic of the program. If the NOTEBOOK XEDIT macro is on a shared or common disk then this approach may not be appropriate as the changes you make will affect all users who use the macro.

    The NOTEBOOK XEDIT supplied is in oneline format thus cannot be readily changed. Get a copy of NOTEBOOK REXX and make you changes to it then rename it to NOTEBOOK XEDIT.

    The functions/feature of NOTEBOOK you might like to alter are:

    Synonyms
    Go the the label "synonyms:" and alter the synonyms accordingly. You should not delete synonyms as they bare used by NOTEBOOK. Just add additional ones you may require.

    Reserved lines color and hi-lighting
    Go the the label "reserved:" and alter the "SET COLOR ...." line according to your taste.

    PF key settings
    Go the the labels as indicated below an alter the settings as required.

    NOTEBOOK MENU
    Locate the label "pfmenu:"

    NOTEBOOK MENU
    Locate the label "pfdisplay:"

    General editing
    Locate the label "pgeneral:"

    Script editing
    Locate the label "pfdoc:"

    Note
    Locate the label "pfnote:"

    Peek
    Locate the label "pfpeek:"

    Filelist
    Locate the label "pffilelist:"

    Rdrelist
    Locate the label "pfrdrlist:"

    Viewing note being replied to
    Locate the label "pfview:"

    To change the settings simply change the REXX variable "keycmd.x" to the XEDIT command or synonym name that is to be assigned to the PF key and executed. The "keydesc.x" REXX variable should be changed to reflect the PF key label that will be displayed on the PF key reserved line. "x" is the PF key number. PF keys 13 through 24 are set to the same values as PF keys 1 through 12.


    By creating a NOTEBEXT XEDIT macro

    Create a file with a filename of NOTEBEXT and a filetype of XEDIT. By placing any valid REXX or XEDIT commands in this file you can add synonyms or do some work as defined by the code you have in the file. The only requirement is that the code in the file is valid XEDIT macro programming. Beware of adding code that may affect the logic of the NOTEBOOK XEDIT macro.

    An example of a user created macro if presented in below:

    /*--------------------------------------------------------*/
    /* A Sample XEDIT macro as used by NOTEBOOK XEDIT.        */
    /* Filename must be NOTEBEXT                              */
    /* Filetype must be XEDIT                                 */
    /*--------------------------------------------------------*/
    trace 'o'                             /* trace off        */
    parse upper arg input .               /* get parms        */
    address XEDIT                         /* commds to XEDIT  */
    'command set shadow off'              /* no shadows       */
    /*--------------------------------------------------------*/
    /* if file not notebook then prefix on and screen 1 72    */
    /*--------------------------------------------------------*/
    'command extract /ftype/'             /* get the filetype */
    if ftype.1 ^= 'NOTEBOOK' then do      /* if not notebook  */
        'command set prefix on left'      /* set prefix on    */
        'command set verify 1 72'         /* show cols 1-72   */
    end
    /*--------------------------------------------------------*/
    /* add synonym add to add 20 lines to end of file         */
    /*--------------------------------------------------------*/
    'command set synonym add macro NOTEBEXT ADD'
                                          /* set new synonym  */
    if input = 'ADD' then do              /* if parm=ADD      */
        'command extract /line/'          /* get line number  */
        'command bottom'                  /* goto bottom      */
        'command add 20'                  /* add 20 blank line*/
        'command :'line.1                 /* goback to origin */
    end
    /*--------------------------------------------------------*/
    /* add prefix synonym that gathers text uses GATHER Package */
    /*--------------------------------------------------------*/
    'command set prefix synonym tf gatpr'
                                          /* set tf synonym   */
    exit 0                                /* and exit         */
    

    A sample user exit is provided with the package called NOTEBEXT SAMPLE. To use it rename it to NOTEBEXT XEDIT. In reality it is included as a sample only and demonstrates a few techniques on how you might use or write code in a user exit.


    Using the NOTEBOOK command 'SETUP'

    When in the NOTEBOOK Management environment you can enter the command SETUP. This will display two data entry screens which presents various XEDIT options and other options that can be changed. This tailoring is limited but is useful for some simple changes that may be required. See the section "SETUP" for more information.

    There are some field you should check/change, these include:

    PROOF program name
    The name of your spelling checking program.

    SCRIPT command
    The name of your installations script program.

    GML library
    The name of your location GML library

    Printing exec
    The name of the print procedure your want called for all printing operations

    Print parameters
    The name of any print parameters that may be required by your printing procedure/program.

    Using NOTEBOOK


    For NOTEBOOK Management

    NOTEBOOK can be implemented by using either either the NOTEBOOK EXEC or by use of the NOTEBOOK XEDIT macro.

    Using the NOTEBOOK EXEC

    The NOTEBOOK EXEC performs a FILELIST that lists only files with a filetype that contains the character string "NOTE". This character string is customizable using the SETUP command. See the section "SETUP" for more information. In doing this it uses the NOTEBOOK XEDIT macro as the profile for the FILELIST and sets the PFKEYS up in a slightly different manner to the standard FILELIST format. Additionally, when a file is XEDITED, whether through PF11/23 of by entering the XEDIT command the file is XEDITED using NOTEBOOK XEDIT as the profile. The NOTEBOOK command can be entered with the filename, filetype and filemode parameters in the same manners as you might do for FILELIST. For example

    NOTEBOOK F* * F
    
    would list all file on the F disk where the filename starts with F and where the filetype contains the character string NOTE.

    If the FILELIST performed by the NOTEBOOK EXEC results in only one file being found that meets the file specifications then the NOTEBOOK environment is immediately entered, i.e. the file is immediately edited using NOTEBOOK.

    PF10/22 is changed to NOTEBOOKS. This toggles the display between displaying only files whose filetype contains the character string NOTE and all files.

    PF12/24 is changed to sort the FILELIST by filename.

    If you XEDIT a file by either pressing PF11/23 or by entering the XEDIT command on a file line then the file will be displayed in a predefined format. This display format is a result of the XEDIT session being established using the profile NOTEBOOK (i.e. The file NOTEBOOK XEDIT). The implementation from this point on is the same as for the NOTEBOOK XEDIT macro implementation.

    Using the NOTEBOOK XEDIT macro

    The NOTEBOOK XEDIT macro implementation requires that you XEDIT a notebook file using the profile NOTEBOOK XEDIT or the your profile PROFILE XEDIT where you have included within it a call to NOTEBOOK XEDIT. A sample PROFILE XEDIT (supplied as NOTEBOOK SAMPPROF) is provided to which you can add you own PROFILE XEDIT. This is the preferred method as it requires less skill in XEDIT and REXX.

    For example

    XEDIT fn ft fm (PROFILE NOTEBOOK
    

    or

    XEDIT fn ft fm

    where in the latter case PROFILE XEDIT is used which calls NOTEBOOK XEDIT.

    NOTEBOOK MENU PF key settings

    PF keys for NOTEBOOK are set up with functions as presented below. Full command details are described in the section "Commands".

    The PFKEY functions for the Notebook Menu are:

    PF1/13
    Set to TODO (See "TODO")

    PF2/14
    Set to DISCARD (See "DISCARD")

    PF3/15
    Set to END (See "END")

    PF4/16
    Set to PRINT (See "PRINT")

    PF5/17
    Set to DISPLAY (See "DISPLAY")

    PF6/18
    Set to FORWARD (See "FORWARD")

    PF7/19
    Set to UP

    PF8/20
    Set to DOWN

    PF9/21
    Set to COPY (See "COPY")

    PF10/22
    Set to FIRST (See "FIRST")

    PF11/23
    Set to LAST (See "LAST")

    PF12/24
    Set to REPLY (See "REPLY")

    NOTEBOOK DISPLAY PF key settings

    The PFKEY functions for the Notebook Display are:

    PF1/13
    Set to TODO (See "TODO")

    PF2/14
    Set to DISCARD (See "DISCARD")

    PF3/15
    Set to END (See "END")

    PF4/16
    Set to PRINT (See "PRINT")

    PF5/17
    Set to MENU (See "MENU")

    PF6/18
    Set to FORWARD (See "FORWARD")

    PF7/19
    Set to UP

    PF8/20
    Set to DOWN

    PF9/21
    Set to COPY (See "COPY")

    PF10/22
    Set to PREVIOUS (See "PREVIOUS")

    PF11/23
    Set to NEXT (See "NEXT")

    PF12/24
    Set to REPLY (See "REPLY")

    For general editing

    If the filetype is SCRIPT then the PFKEYS will be set up with functions suited to documents management. The functions are described in the section "Commands". The PFKEY functions are similar to the default XEDIT setting.

    PF1/13
    Set to TODO (See "TODO")

    PF2/14
    Set to Line add (LADD) (See "LADD")

    PF3/15
    Set to END (See "END")

    PF4/16
    Set to DRAFT (See "DRAFT")

    PF5/17
    Set to repeat find

    PF6/18
    Set to recall last command

    PF7/19
    Set to UP

    PF8/20
    Set to DOWN

    PF9/21
    Set to PROOF (See "PROOF")

    PF10/22
    Set to RGTLEFT (See "RGTLEFT")

    PF11/23
    Set to SPLTJOIN (See "SPLITJOIN")

    PF12/24
    Set to TOPBOT (See "TOPBOT")
    The third last line on the screen will indicate that you are in Document Composition mode.

    If the file type of the file being edited is not SCRIPT then the PFKEYS will be set up with functions suited to general editing. The functions are described in the section "Commands". The PFKEY functions are similar to the default XEDIT setting with the exception noted below.

    PF1/13
    Set to TODO (See "TODO")

    PF2/14
    Set to Line add (LADD) (See "LADD")

    PF3/15
    Set to END (See "END")

    PF4/16
    Set to CURSOR HOME

    PF5/17
    Set to repeat find

    PF6/18
    Set to recall last command

    PF7/19
    Set to UP

    PF8/20
    Set to DOWN

    PF9/21
    Set to TOP

    PF10/22
    Set to RGTLEFT (See "RGTLEFT")

    PF11/23
    Set to SPLTJOIN (See "SPLITJOIN")

    PF12/24
    Set to TOPBOT (See "TOPBOT")
    The third last line on the screen will indicate that you are in General Editing mode.

    Additional prefix command synonyms are also created. These are are listed below and help XEDIT mimic the ISPF editor prefix commands. You can disable these prefix commands through the use of the SETUP command.

    A (after)
    Is a synonym of F (following)

    B (before)
    Is a synonym of P (preceding)

    R (repeat)
    Is a synonym of " (repeat)

    I (insert)
    Is a synonym of A (add a blank line)

    For NOTEs

    In this case you must use the CMS DEFAULTS command to set the default profile for NOTE to either NOTEBOOK or PROFILE depending upon the installation technique you have used.

    Using the NOTEBOOK XEDIT macro as your NOTE profile will result in the following occurring when you use the CMS NOTE command.

    The screen format and general operation of NOTE are essentially the same as for the default NOTE environment.


    For PEEKing

    In this case you must use the CMS DEFAULTS command to set the default profile for PEEK to either NOTEBOOK or PROFILE depending upon the installation technique you have used.

    Using the NOTEBOOK XEDIT macro as your PEEK profile will result in the following occurring when you use the CMS PEEK command.

    The screen format and general operation of PEEK are essentially the same as for the default PEEK environment.


    For FILELIST

    In this case you must use the CMS DEFAULTS command to set the default profile for FILELIST to either NOTEBOOK or PROFILE depending upon the installation technique you have used.

    Using the NOTEBOOK XEDIT macro as your FILELIST profile will result in the following occurring when you use the CMS FILELIST command.

    The screen format and general operation of FILELIST are essentially the same as for the default FILELIST environment.


    For RDRLIST

    In this case you must use the CMS DEFAULTS command to set the default profile for RDRLIST to either NOTEBOOK or PROFILE depending upon the installation technique you have used.

    Using the NOTEBOOK XEDIT macro as your RDRLIST profile will result in the following occurring when you use the CMS RDRLIST command.

    The screen format and general operation of RDRLIST are essentially the same as for the default RDRLIST environment.


    Using TODO


    Description of the TODO facility

    The TODO facility is provided to allow you to manage TODO lists. The todo list is simply a list of TODO items in an XEDIT file where the file is treated as a table. Each record in the table has the following structure:


    Record Length Description No
    1 4 1 - 100 System calculated priority (based upon user priority, due date and time required) 2 4 1 - 100 User provided priority 3 8 Due date (YYYYMMDD) 4 8 Date entered (YYYYMMDD) 5 8 Date completed (YYYYMMDD) 6 5 .1 - 999.9 Estimated hours of effort required 7 5 .1 - 999.9 Actual hours of effort required 8 11 A keyword 9 144 A description of the TODO item 10 8 The filename of a details/reference file (if used it is suggested you use the first 8 characters of the keyword) 11 8 The filetype of a details/reference file (defaults to TODO ITEM)

    As the file is a simple XEDIT file you can edit it with XEDIT and/or apply other programs (EXECs or XEDIT macros) to it.


    Using of the TODO facility

    From within NOTEBOOK you can reach this facility by entering the command TODO or STATUS from the XEDIT command line or by pressing PF key 1/13. From within NOTEBOOK you can only manage the TODO file that is named in the first panel of the SETUP procedure.

    You can use NOTEBOOK from outside NOTEBOOK by entering the command NOTETODO. This command has the following format:

           NOTETODO  < desc >  < ( FILE name >
     
           Where: desc - is a description that will be used in a todo item,
                         if provided a todo item data entry (add) screen
                         will be provided.  If it is not provided then the
                         list of all todo items will be displayed.
                  name - is the filename of the TODO file.  The filetype
                         will always be TODO.  If the filename is not
                         provided then the filename will default to your
                         userid.
    

    Once in the TODO facility it is driven by PF keys. This should be self explanatory. PF key 4 will lead you to additional menus of functions which can be used if required. For example various reports can be printed and these are accessed from secondary menus.

    In the data entry screen help can be obtained by entering a "?" in any data entry field and pressing enter.

    This file structure of the TODO file is compatible with the TODO PACKAGE that exists on VMTOOLS. See "Usage Notes/Hints/Credits".


    Commands

    The commands made available to you through the NOTEBOOK XEDIT macro are presented in summary and in detail below. You should find that using the PF keys as provided will allow you to perform 90 percent of the function you need.


    Commands in Summary

    The commands are summarizes below:

    BOTTOM
    Move screen to the bottom of the file such that the last line in the file is at the bottom of the screen.

    BOTTOP
    Toggles the screen to the bottom of the file or top of the file.

    CANCEL
    Cancel a note with verification of the cancellation request (i.e. confirm the request)

    CLEAN < n >
    Clean a NOTEBOOK of all obsolete notes, optionally "n' days into the future

    COPY
    Copy the note specified by the cursor position to a CMS file

    DISCARD
    Discard (i.e. erase, purge) the note specified by the cursor position from the notebook

    DISPLAY
    Display the note specified by the cursor position in the notebook, in NOTEBOOK DISPLAY format

    DRAFT
    Script the CMS file being edited and display the resultant file

    END
    End an XEDIT session. If no changes made to the file then quit. If changes are made then verify the file request.

    FIRST
    Display the first note in the notebook

    FOILS
    Treat a foils file as a notebook file but use the tag ".*======" as the separator

    FORUM
    Treat a forum file as a notebook file but use the tag "-----" as the separator

    FORWARD
    Forward the note specified by the cursor position to other people.

    MENU
    Reformat the notebook being display into NOTEBOOK MENU format

    LADD
    Add a line at the cursor position

    LAST
    Display the last note in the notebook

    NEXT
    Display the next note in the notebook

    NOTEBOOK
    From FILELIST toggle between displaying only those files that contain the character string NOTE in the filetype and a display of all files.

    NNULLS
    Toggle between the XEDIT modes NULLS ON and NULLS OFF

    PFA
    Set the PFKEYS for the XEDIT session to the format as specified by PFA, this is for Document Composition

    PFB
    Set the PFKEYS for the XEDIT session to the format as specified by PFB, this is for General Editing

    PPREFIX
    Toggle between the XEDIT modes PREFIX ON and PREFIX OFF. If the prefix is on then verify is set to columns 1 through 73 else verify is set to column 1 through 80.

    PREVIOUS
    Display the previous note in the notebook

    PRINT
    Print the note as specified by the cursor position from the notebook

    PRINTALL
    Print all the notes in a notebook.

    PROOF
    Proof the CMS file being edited or created through the CMS NOTE command

    QDISK
    Display the virtual reader, printer and punch status,

    QFILE
    Display the virtual reader, printer and punch status, the CPU utilization, the number of users and the remaining A disk space.

    REMIND
    Add a todo item to the todo file if the cursor resides in a note else displays the status of all todo items and allows their maintenance.

    REPLY
    Reply to a CMS note or PROFS note from within a NOTEBOOK, a CMS file or a PEEKED file.

    RETAIN < n | Forever >
    Add a retention tag to a note, optionally for "n" days of forever

    RGTLEFT
    Move the screen right over the file until at the right margin where upon move back to the origin (i.e. column 0)

    SSCALE
    Toggle between the XEDIT modes SCALE ON and SCALE OFF

    SETUP
    Displays the SETUP data entry screens that allows you to alter NOTEBOOK

    STAMP <I|C|R>
    Stamp the file being edited with a classification line

    STATUS
    Display the status of all todo items and allow for their maintenance.

    TODO
    Add a todo item to the todo file if the cursor resides in a note else displays the status of all todo items and allows their maintenance.

    TOPBOT
    This command toggles (scrolls) the screen from the top to the bottom of the file and visa versa.

    TRANSMIT
    This is the command used to send the note being prepared.

    VVERIFY
    Toggle between the XEDIT modes PREFIX ON and PREFIX OFF. If the prefix on on then verify is set to columns 1 through 72 else verify is set to column 1 through 80.

    VIEW
    Toggle between displaying the NOTE being prepared and between displaying both the NOTE being prepared and the NOTE being replied to.

    WASH
    Removes all notes in a NOTEBOOK that contain the string "===> Body of note kept in XXXXXX NOTEBOOK X.". These notes are put in a file with the same filename and with a filetype of NOTEWASH.


    Commands in Detail

    The commands are described in detail below. The presentation is the same in each case. The information provided includes: the command name, the PFKEY settings, aliases and a description of its use. The command is presented in mixed case, the upper case portion being the shortest abbreviation that is allowed for the command.

    BOTTOM

    Command
    BOTtom

    Alias
    None

    Pfkeys
    PF12/24 from XEDIT of a file where the filetype is not SCRIPT

    Function
    The BOTTOM command when issues will place the screen at the end of the file such that the last file line is at the bottom of the screen.

    The standard XEDIT BOTTOM command would place the screen such that the last file line is placed at the position of the current line.

    CANCEL

    Command
    CANcel

    Alias
    None

    Pfkeys
    PF3/15 from NOTE

    Function
    The CANCEL command is used during the editing of a CMS NOTE and is set to PF3/15. When PF3/15 is pressed you will will be requested to verify that you in fact want to cancel the NOTE. This is to safe guard against accidentally erasing a NOTE that you have just created.

    The standard PF3/15 setting while editing a NOTE is set to the XEDIT subcommand QUIT. It pressed you will immediately quit the XEDIT session an loose the NOTE you were creating.

    CLEAN

    Command
    CLEan < n >

    Alias
    None

    Pfkeys
    None

    Function
    The CLEAN command is used to clean a NOTEBOOK of all obsolete notes.

    This can be manually or automatically. To manually clean a notebook issue the command CLEAN. Automatic cleaning will occur if the SETUP command has be used to specify that Notebook retaining/cleaning is to be automatic.

    The CLEAN command can also have a whole number as a parameter. This number will force the cleanup action to be performed as if the command was execute in "n" days time. For example, if the command CLEAN 20 was issued then all notes that would be obsoleted in 20 days would be discarded from the NOTEBOOK today. The option of using a parameter to the clean command should be used with care.

    For the technically inclined this is how the retain and clean commands work. The two command are described together since they operate very much in unison. The retain command simple places immediately after the note separator in the NOTEBOOK a tag of the form:

    Retain: 32013 Stamped on 86/08/25 Obsolete in 365 days

    This information actually used by the RETAIN and CLEAN commands include the "Retain:" tag which is used to locate the retain information and the number "32013" which is the day number this century when the note becomes obsolete.

    Thus if the command RETAIN 100 is issued the note will be tagged with a tag as specified above and the obsolete day this century will be the sum of 100 plus todays day this century. If the CLEAN command is then issued then todays day this century is compared to the tagged retain day this century. If the difference is less than zero then the note is discarded. If a parameter is supplied with the CLEAN command then the whole number supplied is added to todays day this century and the comparison made to the retain tag. This enable you to clean a NOTEBOOK as if toady was some day in the future.

    Finally, if a note is discarded it can be recovered. All discarded notes are put in a file whose filename equals that of the NOTEBOOK that was cleaned and whose filetype is NOTEBDEL. If you are happy with the clean operation you can erase this file else recover the notes and add them back to the actual NOTEBOOK. Remember to also delete the retain tags. It is also worth note that the RETAIN command can be issued against a note as many times as you like. The last RETAIN issued is the one that is remembered.

    COPY

    Command
    COpy

    Alias
    NCopy

    Pfkeys
    PF9/21 from NOTEBOOK DISPLAY and NOTEBOOK MENU

    Function
    The COPY command is used to COPY the note where the cursor resides to another file. The command is used by NOTEBOOK and is used through PF9/21.

    The destination filename will be requested of you. The filetype, if omitted will default to NOTEBOOK. The filemode if omitted will default to your A mini-disk. If your A mini-disk is not in read/write mode then the first read/write mini-disk mode will be used.

    DISCARD

    Command
    DIScard

    Alias
    NDISCard

    Pfkeys
    PF2/14 from PEEK, NOTEBOOK DISPLAY and NOTEBOOK MENU

    Function
    The DISCARD command is used from the NOTEBOOK environment to discard individual notes from a notebook. It is normally used through PF2/14. From PEEK the discard command allows you to discard the reader file your are peeking. For PEEK discard is normally used through PF2/14.

    The action of the discard command is the same as for the CMS DISCARD command.

    When discarding notes using PF2 (PF14) and you are in Notebook Display mode then rather than returning to Notebook Menu, the next note is displayed. This makes cleaning up of notebooks much easier.

    DISPLAY

    Command
    DIsplay

    Alias
    NDisplay

    Pfkeys
    PF5/17 from NOTEBOOK MENU

    Function
    The DISPLAY command is used from the NOTEBOOK environment to display all of a specific note. It is usable from the NOTEBOOK MENU screen and is set to PF5/17.

    DRAFT

    Command
    DRaft

    Alias
    None

    Pfkeys
    PF12/24 from xediting of files with a filetype of SCRIPT

    Function
    The DRAFT command allows you to script the file you are editing and to then browse the scripted file using XEDIT. DRAFT is set to PF12/24 when editing file with a filetype of script.

    Once you have browsed the scripted file you can return to your editing session by pressing PF3/15.

    END

    Command
    END

    Alias
    SAFEFILE

    Pfkeys
    PF3/15 from XEDIT, NOTEBOOK MENU and NOTEBOOK DISPLAY

    Function
    The END command is used to exit, from any XEDIT session that uses the NOTEBOOK programs. The one exception is the NOTE environment where the CANCEL command is used (see "CANCEL"). The END command will save the file and exit the editing session if the file is a new file. If the file was not altered then the END command will QUIT the editing session. Finally, if the file is not a new file and changes have been made to the file, then the END command will require that you confirm the END request. If confirmed the file will be first saved before the editing session is ended.

    If you do not wish to have the changes saved then enter the XEDIT subcommand QQUIT from the command line. Additionally, you can enter the XEDIT subcommand FILE from the command line to immediately save the file and end the editing session.

    FIRST

    Command
    FIrst

    Alias
    NFIrst

    Pfkeys
    n/a

    Function
    The FIRST command is used from the NOTEBOOK environment to position you at the first note in a notebook. It will display the entire note whether entered as a command from NOTEBOOK MENU or NOTEBOOK DISPLAY.

    FOILS

    Command
    FOIls

    Alias
    n/a

    Pfkeys
    n/a

    Function
    The FOILS command initiates the notebook environment for any file you may be editing. It treats the foils file as a notebook file but uses the tag ":foil" as the separator string. All standard notebook PF KEY functions and commands may be used.

    FORUM

    Command
    FORum

    Alias
    n/a

    Pfkeys
    n/a

    Function

    Function
    The FORUM command initiates the notebook environment for any file you may be editing. It treats the forum file as a notebook file but uses the tag "-----" as the separator string. All standard notebook PF KEY functions and commands may be used.

    FORWARD

    Command
    FOrward

    Alias
    NForward

    Pfkeys
    PF6/18 from NOTEBOOK DISPLAY and NOTEBOOK MENU

    Function
    The FORWARD command is used from the NOTEBOOK environment to forward a note to other people. The position of the cursor in a notebook points to the note that is to be forwarded. The destination of the forwarded note is then requested. Using this information a CMS NOTE session is entered where you can add some details as you would in any normal note session. The major difference is the appending to the note file of the note to be forwarded. The XEDIT subcommand FORWARD is not available from Notebook Management as it is used for the above function. Instead you can use the XEDIT subcommands DOWN or +n, where "n" is a whole number representing the number of lines down that you wish to move.

    LADD

    Command
    LADd

    Alias
    None

    Pfkeys
    PF2/14 from NOTE and XEDIT of file (any filetype)

    Function
    LADD will add a blank line to the file at the cursor position.

    LAST

    Command
    LASt

    Alias
    NLast

    Pfkeys
    PF10/22 from NOTEBOOK MENU

    Function
    The LAST command is used from the NOTEBOOK environment to position you at the last note in a notebook. It will display the entire note whether entered as a command from NOTEBOOK MENU or NOTEBOOK DISPLAY.

    MENU

    Command
    MEnu

    Alias
    None

    Pfkeys
    PF11/23 from NOTEBOOK MENU

    Function
    The MENU command is used from the NOTEBOOK environment to format (re-format) a notebook into NOTEBOOK MENU format. This may be required after the use of the XEDIT subcommand ALL. The function is used from the NOTEBOOK MENU screen and is set to PF11/23.

    NEXT

    Command
    NExt

    Alias
    NNExt

    Pfkeys
    PF11/23 from NOTEBOOK DISPLAY

    Function
    The NEXT command is used from the NOTEBOOK environment to display the next note if full. It is used from NOTEBOOK DISPLAY as a "next note" function.

    NOTEBOOK

    Command
    NOTEBook

    Alias
    None

    Pfkeys
    PF10/22 from FILELIST

    Function
    The NOTEBOOK command allows you to toggle between displaying only files with a filetype that contains the characters string NOTE and all files.

    For example, if issued from a FILELIST of all your A mini-disk files, it will result in the display of all file on your A mini-disk that contain the character string NOTE in the filetype. If you issue the command again all files will be listed (re-displayed).

    NNULLS

    Command
    NNUlls

    Alias
    None

    Pfkeys
    None

    Function
    The NNULLS command allows you to toggle between the XEDIT condition NULLS ON and NULLS OFF.

    PFA

    Command
    PFA

    Alias
    None

    Pfkeys
    PF1/13 from XEDIT of files where the filetype is not SCRIPT

    Function
    The PFA command is used to change the PFKEY setting to the format tailored for use during Document Composition. It can be issued from any XEDIT session but is best issued from a General Editing session where you require access to the command DRAFT (See "DRAFT") or the command PROOF (See "PROOF") from PFKEYS.

    PFB

    Command
    PFB

    Alias
    None

    Pfkeys
    PF1/13 from XEDIT of files with a filetype of SCRIPT

    Function
    The PFB command is used to change the PFKEY setting to the format tailored for use during General Editing. It can be issued from any XEDIT session but is best issued from a Document Composition session where you require the PF9/21 and PF12/24 to be set to TOP and BOTTOM respectively.

    PPREFIX

    Command
    PPrefix

    Alias
    VVERIFY

    Pfkeys
    PF11/23 of PEEK

    Function
    See the description under "VVERIFY".

    PREVIOUS

    Command
    PREVious

    Alias
    NPREVious

    Pfkeys
    PF10/22 from NOTEBOOK DISPLAY

    Function
    The PREVIOUS command is used in the NOTEBOOK environment to display the previous note if full. It is used from NOTEBOOK DISPLAY as a "previous note" function.

    PRINT

    Command
    PRINt

    Alias
    NPRInt

    Pfkeys
    PF4/16 from PEEK, NOTEBOOK MENU and NOTEBOOK DISPLAY

    Function
    The PRINT command is used in the NOTEBOOK environment to print a note in full to the default CMS printer. It can be issued from any XEDIT session, such as PEEK, to print the file being edited.

    The print operation by default uses the CMS PRINT command. Using the SETUP command you may change this so that the PRINT operation uses either the SCRIPT command or a print EXEC of your own choosing.

    When printing a note using PF4 (PF16) then the print operations is controlled by the EXEC or MODULE name provided in the "Notebook printing" field of the second setup panel. If the eight character name provided contains the string "SCRIPT" then the script control string ".fo off" will be placed on the first line of the note just prior to being printed by the EXEC or MODULE name provided.

    PRINTALL

    Command
    PRINTALL

    Alias
    None

    Pfkeys
    None

    Function
    The PRINTALL command is used in the NOTEBOOK environment to print all notes in the notebook.

    The print operation by default uses the CMS PRINT command. Using the SETUP command you may change this so that the PRINT operation uses either the SCRIPT command or a print EXEC of your own choosing. See the PRINT command for more details concerning setting up your own print procedure.

    PROOF

    Command
    PROof

    Alias
    None

    Pfkeys
    PF9/21 from XEDIT of file with filetype SCRIPT and from NOTE

    Function
    The PROOF command is used to temporarily leave XEDIT and PROOF the file you are editing. You can thus check for spelling error during an XEDIT session.

    The PROOF command first saves the file you are editing, then PROOFS the file, then gets the version of the file that the spelling has been check within back for further editing

    QDISK

    Command
    QDisk

    Alias
    None

    Pfkeys
    None

    Function
    The QDISK command is used to display on the third last (reserve line) of the FILELIST screen or RDRLIST screen the status of various CMS systems items. The information displayed includes: the A minidisk space, the number of users logged on, the CPU utilization, and the number of READER, PRINT and PUNCH files.

    This command can be issued from any XEDIT session and will display the information as mentioned above on a reserve line.

    QFILE

    Command
    QFile

    Alias
    None

    Pfkeys
    None

    Function
    The QFILE command is used to display on the third last (reserve line) of the FILELIST screen or RDRLIST screen the status of various CMS systems items. The information displayed includes: the A minidisk space, the number of users logged on, the CPU utilization, and the number of READER, PRINT and PUNCH files.

    This command can be issued from any XEDIT session and will display the information as mentioned above on a reserve line.

    REMIND

    Command
    REMind

    Alias
    NREMind

    Pfkeys
    PF1/13 from NOTEBOOK MENU, NOTEBOOK DISPLAY, FILELIST, RDRLIST, NOTE and PEEK

    Function
    Use to log a todo item.

    The todo facility is tailorable. You can use the internal todo facility as described below and in "STATUS" or you can use an external todo program. By default NOTEBOOK will use the internal todo facility. If you wish to change the todo program used then use the SETUP command, see "SETUP".

    If the cursor is in the file area (i.e in a note) then a data entry screen for adding a todo item to the todo item file is presented. The contents of the line in the file area is picked up for use as the todo item description.

    If the cursor is on a non file area (i.e. the command line) then all todo items are displayed. You can then maintain todo items by performing function such as: adding new todo items, printing the list of todo items, discarding todo items, etc.

    From a FILELIST or RDRLIST the status of all todo items are displayed irrespective of the cursors position.

    REPLY

    Command
    REply

    Alias
    NREPly

    Pfkeys
    PF12/24 from NOTEBOOK MENU, NOTEBOOK DISPLAY and PEEK

    Function
    Use to reply to CMS NOTES or PROFS NOTES. The REPLY command is used in the NOTEBOOK environment to reply to the CMS NOTE or PROFS NOTE on which the cursor resides or that is being displayed. Additionally, you can now reply to files that are not CMS NOTE or PROFS NOTE files that are being PEEK from your reader.

    This command can also be used effectively from the PEEK environment to reply to the note being peeked.

    The REPLY command can be issued from any XEDIT session but you will only get a note generated if the file being edited is in CMS NOTE or PROFS NOTE format.

    RETAIN

    Command
    RETain < nnn | Forever >

    Alias
    NRETain

    Pfkeys
    None

    Function
    Use to tag a note for retention

    The commands RETAIN allows you to tag a note from retention. The retain age is set by default to 365 days unless changed by customizing the Notebook environment using the SETUP command. The default can be overridden by supplying an parameter to the RETAIN command. Valid parameters include any whole number or the character string FOREVER where it can be abbreviated to F. Thus RETAIN F will tag a note for retention forever. RETAIN 100 would tag a note for retention for 100 days.

    The RETAIN function can be automated. Using the SETUP command you can ask for Notebooks to have notes automatically retain and cleaned. This will result in all notes in the notebook being tagged for retention for the default period of time (as again defined using the SETUP command) providing they do not already have a retain tag, each time the NOTEBOOK is edited.

    The clean option is described in section "CLEAN", and provides more information about the retaining and cleaning of notes.

    RGTLEFT

    Command
    RGTleft

    Alias
    LR, RL, LEftright, RGTleft

    Pfkeys
    PF10 from XEDIT, PEEK and NOTE

    Function
    The RGTLEFT command is used to move the screen from left to right across the file. It does this in increments of 60 columns until the right boundary of the file (as defined by the logical record width of the file) is reached. It then moves the screen back to column zero. The command is best used from the PFKEY settings. For more details see the description in the XEDIT HELP screen for RGTLEFT (i.e. enter the command HELP XEDIT RGTLEFT).

    SSCALE

    Command
    SScale

    Alias
    None

    Pfkeys
    None

    Function
    The SSCALE command is used to toggle the scale line from SCALE ON to SCALE OFF. The scale line will be placed at the first free (un-reserved) line from the top of the screen.

    SETUP

    Command
    SETUP

    Alias
    None

    Pfkeys
    None

    Function
    The SETUP command can be used to alter some of the XEDIT environment attributes and other values used by the NOTEBOOK programs. That is, it allows you to profile some of your XEDIT subcommand settings and other settings as used by the NOTEBOOK XEDIT macro.

    SETUP will display two data entry screens. The first screen allows you to customize your XEDIT editing environment. The second screen allows you to customize your NOTEBOOK environment. Pressing the enter key results in the changes taking effect. Pressing PF3 cancels the changes. The attributes that can be changed are presented below in the order that they are presented on the two screen that will be displayed:

    PREFIX AREA
    The prefix area can be profiled as OFF, at the LEFT margin or at the RIGHT margin. The value selected will result in the PREFIX area being placed at that positioned for all XEDIT sessions. See the help information for the XEDIT subcommand SET PREFIX for more information (enter HELP SET PREFIX from any XEDIT session).

    COMMAND LINE
    The command line can be profiled as OFF (not advisable), ON, TOP or BOTTOM. The value used will result in the XEDIT command line being placed at that position for all XEDIT sessions. See the help information for the XEDIT subcommand SET CMDLINE for more information (enter HELP SET CMDLINE from any XEDIT session).

    SCALE
    The SCALE can be set ON or OFF. The value selected will result in the SCALE being set ON or OFF for all XEDIT sessions. See the help information for the XEDIT subcommand SET SCALE for more information (enter HELP SET SCALE from any XEDIT session).

    WRAP
    WRAP can be set ON or OFF. The value selected will result in WRAP being set ON or OFF for all XEDIT sessions. See the help information for the XEDIT subcommand SET WRAP for more information (enter HELP SET WRAP from any XEDIT session).

    STAY
    STAY can be set ON or OFF. The value selected will result in STAY being set ON or OFF for all XEDIT sessions. See the help information for the XEDIT subcommand SET STAY for more information (enter HELP SET STAY from any XEDIT session).

    NULLS
    NULLS can be set ON or OFF. The value selected will result in NULLS being set ON or OFF for all XEDIT sessions. See the help information for the XEDIT subcommand SET NULLS for more information (enter HELP SET NULLS from any XEDIT session).

    AUTOSAVE
    AUTOSAVE can be set OFF or to a whole number. The value selected will result in AUTOSAVE being set OFF or an AUTOSAVE operation being initiated every "n" alterations to the file, where "n" is a whole number. See the help information for the XEDIT subcommand SET AUTOSAVE for more information (enter HELP SET AUTOSAVE from any XEDIT session).

    HEX
    HEX can be set ON or OFF. The value selected will result in HEX being set ON or OFF for all XEDIT sessions. See the help information for the XEDIT subcommand SET HEX for more information (enter HELP SET HEX from any XEDIT session).

    POSITIONING
    Positioning can be OFF or ON. If OFF then each time you edit a file the cursor is placed in one of two positions. For files where the filetype contains the character string NOTE the cursor will be places on the first line of the last note displayed on the screen. For all other files, RDRLIST, FILELIST, and PEEK the cursor is is positioned on the command line. NOTE is a an exception, the cursor is placed after the tag "Subject:".

    If positioning is ON then the cursor will be positioned at the location in the file where it was located when the file was last exited after an edit session. If the file is new or has not been edited by you before the cursor is positioned as described above when positioning is OFF.

    PROOF PROGRAM NAME
    This option allows you to specify the PROOF program name. This name may be an EXEC or a module. By defaults the PROOF program name is PROOF.

    ISPF PREFIX COMPARABILITY
    This option allows you to specify whether the XEDIT prefix commands are to be compatible with ISPF or not. If YES then the prefix commands are changed so that: I = add, A = after, B = before and R = Repeat. The synonymous XEDIT prefix commands are: A = add, F = following, P = Proceeding and " = repeat. Note that the prefix commands F, P and " still function correctly even if ISPF compatibility is on. The A prefix commands is the only one that behaves differently.

    PREFIX NUMBERS
    The prefix numbers can be profiled as OFF or ON. OFF will result in the prefix area being a string of 5 dashes, i.e. "=====" while ON will result in the prefix area being the line number of the record in the file.

    PROMPT DISCARDS
    When in PEEK the PF2 key will normally discard the file or note being peeked. You can through this prompt have the discard request validated. If you put a NO in this field then all discards via the PF2 key will be validated. If you put a NO in this field then all discards issued by the PF2 key will be immediate.

    TODO FACILITY
    The todo facility is tailorable. This facility is available through the STATUS and TODO commands or via PF1. See these command for more details.

    You can now enter the name of the TODO facility you wish to use. This is done by entering the EXEC name in the data entry field of the "TODO facility". If you wish to use the internal TODO facility provided, which is quite advanced, then enter the character string NOTEBOOK.

    To use an external TODO facility simply enter the EXEC name that starts the external TODO facility.

    TODO FILENAME
    The filename of the file to be used for todo items can be trailered to your own requirements. By default the TODO facility uses a filename of "userid" and a filetype of TODO. You can change this to any filename and filetype you like. If you are using an external TODO facility then the TODO filename will be passed as argument to the external TODO facility. Thus is could be used to direct an external TODO facility if it can except command parameters.

    NOTE FORMAT (SEND)
    This option allows you to request that notes be sent in PROFS compatibility mode. If you answer 'CMS' the notes are sent in CMS NOTE format using SENDFILE (ie NETDATA format). If you answer 'PROFS' the notes are sent in PROFS NOTE format using PUNCH (ie MESSAGE format). If you answer 'PROFN' the notes are sent in CMS NOTE format using PUNCH (ie MESSAGE format), this ensure PROFS can handle the notes but leaves them in CMS NOTE format.

    The LONG / SHORT, ACK / NOACK, LOG / NOLOG, and NOTEBOOK options are all still implemented as if the NOTE were a CMS NOTE.

    In addition, in PROFS compatibility mode (ie if your selected PROFS or PROFN) then the ".at" tag is also recognized. If the ".at" tag is found starting in column one in the note being prepared then the note when sent has all the address information suppressed and the "To:" tag has the text following the ".at" tag included in the sent note.

    SEPARATOR CHARACTER
    This option allows you to specify what the separator character should be for separating notes in a NOTEBOOK. The "=" is the default separator character.

    SEPARATOR LENGTH
    This option allows you to specify the number of time the separator character should be replicated. By default the separator character is repeated 73 times. Thus the default separator character becomes 73 dashes.

    MENU TAGS DISPLAYED
    This option allows you to specify what menu tags will be displayed by the Notebook Menu. By default the tags displayed include: "Date: To: From: Forward: Re: Foil: Subject: Reference:"

    You c/an enter your own character strings to be used as menu tags. If your string requires a space then enter the space as a tilde (~). Notebook will automatically convert the tilde back to as space. For example if you want to review a FORUM file then add a string "FORUM~APPENDED~AT". Then when you XEDIT a FORUM, enter the command MENU and you will see all lines with the string FORUM APPENDED AT displayed as the NOTEBOOK MENU. You can then select PF KEY 5 to review each entry in the FORUM file.

    SCRIPT COMMAND NAME
    This option allows you to tailor NOTEBOOK to use the release of script that is installed at your location. The name supplied here should reflect the name of the SCRIPT MODULE installed on your locations VM system. By default the script name is SCRIPT.

    SCRIPT GML PROFILE
    This option allows you to tailor NOTEBOOK to use the correct GML profile for the script release that is installed at you location or that is specified in the entry field above. By default the script name is DSMPROF3 which is the standard name of the GML profile for script release 3.

    SCRIPT GML MACLIB
    This option allows you to tailor NOTEBOOK to use the correct GML macro library for the script release that is installed at you location or that is specified in the entry field above. By default the script name is DSMGML3 which is the standard name of the GML macro library for script release 3.

    RETAIN AGE DEFAULT
    This option allows you to set the default retain age. By default it is set to 365 days. More details can be obtained by reading the sections that describe the commands "RETAIN" ("RETAIN") and "CLEAN" ("CLEAN").

    REPLY PACKAGE USAGE
    This option allows you to define how replies to notes should be handled. The default is (NO) to use the reply procedures of the NOTEBOOK package. The REPLY PACKAGE can be used as an alternative. It has many enhancement in addition to the reply provided with in the NOTEBOOK package but they are more complex to use.

    PRINTER OUTPUT
    The Printer Output option allow you to have your printer spooled continuously. This will bundle all print request into one print file. This saves both system resources and operations resources. It also makes collecting your printed output much easier.

    To spool you printer continuously while in the Notebook Management environment set the PRINT option to CONT. Otherwise set the PRINT option to NOCONT.

    PRINTING EXEC
    You can specify to have notes printed by using the CMS PRINT command or EXEC of your own choice.

    The default is to use the CMS PRINT command for printed output.

    When printing a note using PF4 (PF16) then the print operation is controlled by the EXEC or MODULE name provided in this field.

    PRINT PARAMETERS
    You can specify the print argument in this field. Each time you issue the PRINT command or press PF4 then the printing exec is called as specified above. The arguments passed will be the filename, filetype, filemode of the temporary file to be printed (a copy of the note) and the parameters entered in this field. If a opening parenthesis is required then is should be included in this field.

    eg. If the PRINTING EXEC is "EZPRINT EXEC" and the PRINT PARAMETERS are "( QUALITY SECURITY(I)" then the command issued by NOTEBOOK will be: "PRT fn ft fm ( QUALITY SECURITY(I)" where the fn ft and fm are provided by NOTEBOOK.

    Note that using this method you could down load file to a PC for printing or perform any other function you might desire as the exec you call need not print a file. It can perform any function of your choosing. You can pick up the temporary filename by the following REXX command in the start of your exec "parse arg fn ft fm options".

    NOTEBOOK FILETYPE
    You can specify which files are to be treated as NOTEBOOKS. That is which files are to be displayed using the Notebook Menu and Notebook Display formats. The character string you provide will be matched against the filetype of the CMS file that is to be edited. If the character string is found in their filetype then the NOTEBOOK environment will be used. By default the character string is "*NOTE*" which means all CMS files that have in the filetype the string NOTE will be edited using} NOTEBOOK.

    Note that the CMS wildcard '*' and '+' are allowed in the specification of the default filetype character string.

    AUTO CLEAN/RETAIN
    This option allows you to specify whether NOTEBOOKS are to be automatically retained and cleaned after each editing session. The default is NO. If YES is selected then each time an edit session finishes for a NOTEBOOK then all notes that have no retain tag will be retain for retention using the default retention days (as discussed above) and all notes with retain tags that are obsolete will be deleted. More details can be obtained by reading the sections that describe the commands "RETAIN" ("RETAIN") and "CLEAN" ("CLEAN").

    NOTE BLANK LINES
    When a note is started, whether a simple note, a reply note or a forwarded note a default (one screen less 12 lines) number of blank lines is added to the end of the note. This option allows you to alter this number to a choice of your own choosing. If a note is forwarding another note or a epilog is being used the blank lines are added before the forwarded note or epilog.

    The notes when sent have excess blank lines automatically removed.

    REPLY TO WHOM
    This option allow you to control how the built in REPLY function will work. If you specify YES then all "from" and "to" addressees will be replied to else if you specify NO then only the "from" addressee will be replied to.

    NOTE SECURITY
    The SETUP procedure now contains the option to have a IBM security classification put automatically in all notes sent. The option is presented on the second setup screen and is the last data entry field. Allowable options are "U" (the default) for unclassified notes, "I" for Internal Use Only notes and "C" for Confidential notes. If "U" is specified no security stamp is put in the note.

    REMOVE "BODY" NOTES
    The WASH action can be set up to occur automatically each time a NOTEBOOK is exited after an XEDIT session when using NOTEBOOK management. To enable this option enter YES in this field.

    The WASH command removes all the information only notes and puts them in a file with a filename the same as the NOTEBOOK filename and a filetype of NOTEWASH. Information notes are those that contain the string "===> Body of note kept in XXXXXX NOTEBOOK XX." For a description of this option see the WASH command "WASH"

    The SETUP command allows the changes through a data entry screen. To change a value simply over type the value and press enter. PF3/15 will cancel the change request.

    SPLITJOIN

    Command
    SPLitjoin

    Alias
    SPLTJOIN, SJ

    Pfkeys
    PF11/23 for editing of files, from NOTE and PEEK

    Function
    This command is used to split and join lines and is implemented exactly as for the standard XEDIT subcommand SPLTJOIN. See the description in the XEDIT reference manual or enter the command HELP SPLTJOIN from any XEDIT session.

    STAMP

    Command
    STamp

    Alias
    None

    Pfkeys
    None

    Function
    The STAMP command allows you to place a line in the file with a security classification. The command format is:

    STAMP
    value

    Where
    value can be blank, I, C or R.

    Blank and I will stamp the file with the string "Internal" Use Only

    C will stamp the file with the string "Confidential"

    R will stamp the file with the string "Confidential Restricted"

    STATUS

    Command
    STAtus

    Alias
    NSTatus

    Pfkeys
    None

    Function
    Use to display todo items and maintain their status.

    The todo facility is tailorable. You can use the internal todo facility as described below and in "TODO" or you can use an external todo program. By default NOTEBOOK will use the internal todo facility. If you wish to change the todo program used then use the SETUP command, see "SETUP".

    You can then maintain todo items by performing function such as: adding new todo items, printing the list of todo items, discarding todo items, etc.

    TODO

    Command
    TODO

    Alias
    NTODO

    Pfkeys
    PF1/13 from NOTEBOOK MENU, NOTEBOOK DISPLAY, FILELIST, RDRLIST, NOTE and PEEK

    Function
    Use to log a todo item.

    The todo facility is tailorable. You can use the internal todo facility as described below and in "STATUS" or you can use an external todo program. By default NOTEBOOK will use the internal todo facility. If you wish to change the todo program used then use the SETUP command, see "SETUP".

    If the cursor is in the file area (i.e in a note) then a data entry screen for adding a todo item to the todo item file is presented. The contents of the line in the file area is picked up for use as the todo item description.

    If the cursor is on a non file area (i.e. the command line) then all todo items are displayed. You can then maintain todo items by performing function such as: adding new todo items, printing the list of todo items, discarding todo items, etc.

    From a FILELIST or RDRLIST the status of all todo items are displayed irrespective of the cursors position.

    TOPBOT

    Command
    TOPBot

    Alias
    None

    Pfkeys
    PF12/24 of NOTE, FILELIST, RDRLIST, PEEK, and XEDIT

    Function
    This command is used to toggle the screen between the top and the bottom of the file being xedited.

    TRANSMIT

    Command
    TRANSmit

    Alias
    None

    Pfkeys
    PF5/17 of NOTE

    Function
    This command is used to send a note that has been prepared. If the note is to be sent in PROFS format then TRANSMIT calls the appropriate procedures in NOTEBOOK to do this other wise the NOTE is send in CMS NOTE format using the CMS SENDFILE command with the NEW option.

    VVERIFY

    Command
    VVerify

    Alias
    PPREFIX

    Pfkeys
    PF11/23 of PEEK

    Function
    The VVERIFY command allow you to toggle between the XEDIT modes PREFIX OFF and PREFIX ON. In addition, if the prefix is OFF then verify is set to 1 80, if the prefix is on then verify is set to 1 72.

    For more information see the XEDIT help information for the SET PREFIX and SET VERIFY XEDIT subcommands. This can be viewed during any XEDIT session by entering the commands HELP SET PREFIX or HELP SET VERIFY.

    VIEW

    Command
    VIEW

    Alias
    VIEW

    Pfkeys
    None

    Function
    The VIEW command allow you when replying to a note in a NOTEBOOK to toggle between viewing:

    WASH

    Command
    WASH

    Alias
    n/a

    Pfkeys
    n/a

    Function
    The command WASH when issued from a NOTEBOOK will remove all notes that are notes containing references to the original note containing the real contents of the note sent. That is when a note is sent to numerous people the actual note contents is only kept in the first "to:" NOTEBOOK, all the remaining "to:" NOTEBOOKs only contain the line " ===> Body of note kept in XXXXXX NOTEBOOK XX.", the WASH command removes all the information only notes and puts them in a file with a filename the same as the NOTEBOOK filename and a filetype of NOTEWASH.

    Additionally, the WASH action can be set up to occur automatically each time a NOTEBOOK is exited after an XEDIT session when using NOTEBOOK management. To enable this option enter the SETUP command, go to the second SETUP data entry screen and change field "Remove 'body' notes" to YES.


    Usage Notes/Hints/Credits

    The following information may be of assistance to you in using either the NOTEBOOK package in managing notes in the CMS environment. These tools I have found particularly useful.

    1. The environment you are in is XEDIT. Thus you have the full range of XEDIT subcommands available for your use. This is a reminder as it is easy to forget that you are in an XEDIT session and thus have the full power of XEDIT available for your use.

    2. The following packages are valuable if used in conjunction or separately from this package:

      SP2EXTND
      An enhanced NOTE facility.

      Available from VM TOOLS or the author Bob Coleman (RRC at CLTVMSE).

      NAMELIST
      A enhanced NAMES facility.

      Available from VM TOOLS or the author Don Iverson (IVERSON at KGNVM8).

      SRTNAME
      A tool to sort your NAMES file by any tag.

      Available from VM TOOLS or the author Art Gardner (GARDNER at KGNVMC).

      NOTACKED
      An tool to maintain your NETLOG file

      Available from VM TOOLS or the author Bob Coleman (RRC at CLTVMSE).

      REPLY
      An enhanced reply facility

      Available from VM TOOLS or the author Larry Mangolis (MARGOL at YKTVMT).

      GATHER
      A paragraph formatting package for XEDIT

      Available from VM TOOLS or the author Maurice Batey (BATEY at WINVMB).

      ADDCAL
      Allows you to add entries to the PROFS calendar from the CMS command line.

      Available from VM TOOLS or the author John Pfunter (PFUNTNR at KGNVMC).

      CALWEEK3
      Provides a comprehensive facility to print a diary (many forms there of) including support for todo lists and calendar entires from PROFS

      Available from VM TOOLS or the author Jim Vincent (VINCENT at DALHQIC1).

      TODO
      A todo list manager.

      Available from VM TOOLS or the author Les Koehler (LESK at SPPVM1).

      LEXXNOTE
      A notebook and PROFS log manager with function similar to NOTEBOOK, some better, some different, but with the advantage of the full power of LEXX. I use it on occasions but due to my nodes high CPU utilization response time is too slow for daily use. Still a highly recommended package.

      Available from VM TOOLS or the authors Dave Hayslett (HAYSLETT at GDLSX) and Andrew Armstrong.

      COL
      A XEDIT column manipulator. ie. copy, move, ect column data in the same manner as prefix command move row data.

      Available from VM TOOLS or the author Gary Vair (VAIR at BLDVM1).

    3. The XEDIT ALL subcommand (macro)

      The ALL subcommand of XEDIT is a very powerful macro. It can provide functions that will save you much time. For more details about this command enter HELP ALL from any XEDIT session.

      The ALL subcommand can be put to good use in the NOTEBOOK. For example, let us presume that you have a 2000 plus line notebook and you want to find a note that was from Fred Brown. To retrieve that note:

      1. Edit the note using the NOTEBOOK

      2. Enter the command "ALL /Fred Brown/" on the command line. This will display all occurrences of Fred Brown and exclude all other lines from being displayed.

      3. Place the cursor on the first line that has Fred Brown and press PF5/17. This will display that individual note for you. If it is not the note you wanted then press PF5/17 again and move the cursor to the next line and repeat the operation above.

      4. To get back to the NOTEBOOK MENU simply enter the command MENU from the XEDIT command line.

      This will assist you in retrieving information very quickly. This function is particularly useful when reviewing forums.


    Maintenance

    The NOTEBOOK package is maintained by Geoff Brain (BRAIN at SYDVM1). All suggestions and problems are welcome and will be answered but not necessarily resolved or implemented.

    The files that come with the package include:

    Happy notebooking...


    Release Changes

    Release 2.0

    This was the first public available release.

    Release 3.0

    This release contains the following changes. All files in the package were changed with the addition of the NOTEBSET XEDIT file

    1. Addition of RETAIN and CLEAN commands.

      This was a suggestion of John Lussmyer (LUSSMYER at KGNVMC) and the approach adopted was borrowed from Fred Leriche's (LERICHE at TORVMNSS) notebook procedures with modifications. It is not compatible with his approach.

    2. Addition of the REMIND and STATUS functions

      This is a simple reminder facility.

    3. Addition of the VIEW command

      This allows viewing of the note being prepared and the note being replied to.

    4. Improvements to the SETUP customization options

      This has many new customization options added.

    5. Addition of optional support of the REPLY PACKAGE, thanks for this suggestion to John Lussmyer.

    6. Addition of the ability to remove blank lines from notes that contain epilog data or a forwarded file when they are sent.

    Release 3.2

    This release contains the following changes.

    1. The SETUP command now allows you to specify an EXEC that is to be used for printing. The default CMS PRINT command or SCRIPT can still be used.

    2. The PEEK profile PFKEY setting were changed to more closely reflect those of the NOTEBOOK package.

    3. The VIEW command has been improved and a few errors fixed.

    4. The documentation has had minor changes.

    5. The suggested requirement for a 4mb CMS virtual machine was added.

    6. The NOTEBOOK command had be modified slightly to display all all NOTEBOOKs, if only one found then go directly into editing it.

    Release 3.4

    This release contains the following changes.

    1. The SETUP command now allows you to specify an EXEC that is to be used for spell checking a file. The default is PROOF.

    2. The SETUP command now allows you to have prefix commands in either ISPF compatibility mode or in native XEDIT mode.

    3. The VIEW command had an error on note sending fixed.

    4. The file NOTEBOOK SAMPROF was added to the package. It can be rename to PROFILE XEDIT if you wish to use NOTEBOOK XEDIT as your PROFILE XEDIT. This saves having two copies of NOTEBOOK XEDIT on your disks. This was a suggestion of Barry Ballard (BALLARD at SYDVM3)

    5. The reply function (the internal implementation) was modified to allow you to reply to any reader files that are not NOTE or PROFS files. This was a suggestion of Jim Monaco (MONACO at OWGVM1)

    6. The documentation has had minor changes.

    Release 3.5

    This release contains the following changes.

    1. The documentation has been revised.

    2. An option has been added to SETUP to control how the build in REPLY function creates address lists.

    3. In replying to notes is was possible to build a address list greater than 255 characters. This would result in an error condition. This restriction is now removed.

    Release 3.6

    This release contains the following changes.

    1. The COPY command did not always ensure a separator line was copied to the destination file, especially if the copy was performed from the PEEK operation. Problem fixed.

    2. If you use the NOTEBOOK SAMPPROF as your PROFILE XEDIT then you will not be able to initiate XEDIT without a filetype. If you use NOTEBOOK XEDIT as your PROFILE XEDIT then you can leave out the filetype and the profile will attempt to find a file that starts with the filename provided. i.e. XEDIT FRED would look for a file with a filetype of SCRIPT, or EXEC, or XEDIT, or NOTE, etc. If no file exits then you will be given and error message and asked to provide a specific filetype.

    3. When printing a note using PF4 (PF16) then the print operations is controlled by the EXEC or MODULE name provided in the "Notebook printing" field of the second setup panel. If the eight character name provided contains the string "SCRIPT" then the script control string ".fo off" will be placed on the first line of the note just prior to being printed by the EXEC or MODULE name provided.

    4. When discarding notes using PF2 (PF14) and you are in Notebook Display mode then rather than returning to Notebook Menu, the next note is displayed. This makes cleaning up of notebooks much easier.

    Release 3.7 and 3.8

    These releases contain minor bug fixes only. The main ones being removal of extraneous autosave files and the correct working a file load time.

    Release 4.0

    These releases contain minor bug fixes only. The main ones being removal of extraneous "load" error being received by some people when loading files at load time.

    Release 4.1

    These releases contain the following changes:

    Release 4.2

    These releases contain the following changes:

    Release 4.3

    These releases contain the following changes:

    Release 4.5

    These releases contain the following changes:

    Release 5.0

    These releases contain the following changes:

    Release 5.1

    These releases contain the following changes:

    Release 5.2

    These releases contain the following changes:

    Release 5.3

    These releases contain the following changes:

    Release 5.4

    These releases contain the following changes:

    Release 5.5

    These releases contain the following changes:

    Release 5.6

    These releases contain the following changes:

    Release 6.0

    This releases contain the following changes:

    Release 6.3

    This releases contain the following changes:

    Release 6.4

    This releases contain the following changes:

    Release 6.6

    This releases contain the following changes:

    Release 6.7

    This releases contain the following changes:

    1. If you sent the note in PROFS format the people being copied on the note if any were being copied twice. Bug fixed.

    2. Notes sent in PROFS or suedo-PROFS format had the date logged in the userid NETLOG in the format DD/MM/YY. This has been changed to MM/DD/YY which is the normal CMS convention.

    3. If you used NOTEBEXT XEDIT (i.e. NOTEBEXT SAMPLE renamed) the prefix synonym for input was changed to powerinput. This has been removed as it changes the way a standard command of XEDIT behaves and could cause confusion.

    4. If a note is peeked in the reader and it is then forwarded then the PROFS subject line (not the actual note subject line but the trailing PROFS subject line) is also forwarded. This bug has been fixed.

    5. The move function has been added to notebook. If you are viewing a note in a notebook (in menu or display mode) you can enter the command move (or nmove) on the XEDIT command line and the current note will be moved to a file whose name will be requested. This is effectively a copy and discard operation. You can assign this function to a PF key. To do this read the documentation under the heading 'Changing the NOTEBOOK XEDIT macro'.

    6. If you were sending any note that contained the CC: tag in columns 1 - 3 of the note outside of the address information and you were sending the note in PROFS or PROFN format then you would have been getting the note send to the additional people or some sort of error message. This was particularly a problem when forwarding notes that contained the CC: tag. The problem has been fixed.

    7. If you used the epilog capability then there was one instance where you would have had a problem. If you had no blank lines between the note text and the inserted epilog then you would have been loosing a line of your epilog. This problem has been fixed.

    Release 6.8

    This releases contain the following changes:

    1. The TODO function (contained) in NOTEBSET XEDIT has been changed so that the systems calculated priority is calculated at entry and exit of the TODO function in addition to when you add or update a TODO item.

    2. The TODO function now loads the todo function when ever a file with a filetype of TODO is XEDITED.

    3. Changes have been made to the REPLY function to correct errors in logging notes that have been sent. Some notes were being lost. This should not now occur.

      1. RDRLIST (that uses NOTEBOOK).

      2. F10 (receive & display). This action updates the userid NOTEBOOK file with the received note and then displays that note.

      3. I change the NOTEBOOK by either deleting notes (F2) or my changing notes.

      4. I position myself at the bottom to review the note just received.

      5. F12 (reply note) I compose my reply and press F5 (sendnote). The REPLY action updates the disk resident userid NOTEBOOK. NOTEBOOK repositions me at the note received.

      6. F3 to exit I get prompted with a file confirm.

      I now have to choose between loosing the REPLY (confirming the file WILL loose the REPLY), or loosing the discard. The above scenario would now result in notes sent being appended the the disk based and memory based notebook if requested.

    4. You can now change the default screen colours by editing the NOTEBOOK XEDIT file. To do this edit the file, go to the bottom and change the variables as indicated. Its easy.

    5. If you edit a file with a filetype of FORUM then PF12/PF24 are changed from the reply function to the command APPEND. You will have to read the append documentation to determine how to set the append default destination. In summary, to set the append defaults enter the following command: APPEND (SET TO XXXXXX where XXXXXX is the name of the default destination of the append (i.e. IBMPC, IBMVM, etc). If you PEEK an forum append then you simply enter append on the XEDIT command line and append will figure out where to send the append.

    6. Fixed a minor bug in FILELIST. If you pressed PF10 to get a list of NOTEBOOKs only it did not work unless you pressed it twice. You now only have to press PF10 once.

    7. There were some formatting problems in the reports produced by the TODO function of the NOTEBOOK package. These have been fixed.

    8. Fixed some interaction problems with the REPLY PACKAGE. You need to use the NOTEBOOK user exit, NOTEBEXT XEDIT to accomplish reasonable compatibility. See comments in NOTEBEXT SAMPPROF for more details.

    Release 6.9

    This releases contain the following changes:

    1. You can now via the setup command request NOTEBOOK to append a copy of the note being replied to to every reply. To do this enter the SETUP command, go to the second data entry screen then change the 'Append note to reply' field to YES.

    2. Alternatively you can get the note being replied to from a NOTE session by using the newly created command GETNOTE. This will only work if you are REPLYING to a note from NOTEBOOK.

    Release 7.0

    This releases contain the following changes:

    1. NOTEBOOK XEDIT now uses NOTEBOOK PROFILE to setup defaults.

      Notebook now functions as follows:

      1. It looks for defaults in NOTEBOOK PROFILE *, if NOTEBOOK PROFILE EXISTS the defaults within are used and are set as session global variable. These defaults will be used for the rest of that CMS session.

      2. If NOTEBOOK PROFILE * does not exist then the defaults are used as set by the command SETUP, these defaults are save as globalv lasting variables, i.e. across CMS sessions.

      3. If SETUP has not been used then the defaults used are those coded in NOTEBOOK XEDIT itself.

      To see what is tailorable review the contents of NOTEBOOK PROFILE.

    2. A new command has been added call RCVPROMPT. It is used instead of the RECEIVE command and will prompt you for the name of the NOTEBOOK to which you want the NOTE added. If the reader file is not a CMS NOTE of PROFS NOTE then you will still be prompted for a filename but this will be ignored. This simply press enter. Pressing ENTER for a NOTE will cause the note to go into the default NOTEBOOK.

    Release 7.01

    This releases contain the following changes:

    1. Changed NOTEBOOK PROFILE to NOTEBOOK UPROFILE to ensure the NOTEBOOK defaults remain as a user originally had them set. If a user wished to use the new configuration process then NOTEBOOK UPROFILE should be renamed to NOTEBOOK PROFILE. You can then edit NOTEBOOK PROFILE to set up your own defaults.

      Note: The only documentation on using NOTEBOOK PROFILE is contained within NOTEBOOK PROFILE itself. Please also note the comments in the release notes below for 7.0.

    2. Changed NOTEBOOK UPROFILE to match the build in NOTEBOOK defaults. My fault as I shipped my NOTEBOOK PROFILE instead of the tools version.

    Footnotes:

    (1) NOTEBOOK MENU: This is the condensed/summary display format of a NOTEBOOK file. This format has all lines in the file suppressed (excluded) from the display except those lines which meet the criteria given in the text above.

    (2) NOTEBOOK DISPLAY: This is the full display format of an individual NOTE in a NOTEBOOK file. No lines of the note in question are excluded from the display.