
COMPOSER(help)               Khoros                COMPOSER(help)

     PROGRAM SPECIFICATION EDITING:  OVERVIEW

     Composer is designed to help you edit program specification
     (PS) files that accompany a corresponding UIS pane file.
     The PS file is used along with a UIS file to specify 100% of
     a data processing routines accessed by cantata. Examples of
     the *.prog files can be found in
     KHOROS_HOME/src/vipl/*/*/*.prog.  A complete description of
     the Program Specification file can be found in Chapter 5 of
     Volume II of the Khoros manual.  Composer provides an
     interactive method of editing the rather cryptic format of
     PS files.

     The interactive editing of a PS file is just a little bit
     better than using your favorite text editor.  For first time
     users of the *.prog file, it removes the need to know all of
     the begin_keys and end_keys and provides examples of each of
     the PS file fields.  The editing of the PS or .prog file is
     accomplished by selecting each one of the fields of the file
     and editing the text to meet the needs of your program.

     Reading and Saving PS Files

     A PS file is immediately created as soon as you select any
     of the fields, such as the "AUTHORS" button, in the top
     third of the form.  To save this file to disk, you must type
     in the desired filename and then click on the "SAVE" button.
     (Remember, it is best to save your files in a work direc-
     tory.)  A PS file can be read in at anytime by filling in a
     *.prog file name and then by clicking on the "READ" button.
     It is best to read and save in the working directory that
     you are running composer from;  this reduces the chances of
     you over writing important files.

     Once a new *.prog file has been read in, it will immediately
     be ready to edit.

     The Edit Window

     After clicking on any of the fields of the prog file, an
     example will be displayed in the bottom on third of the com-
     poser form  and an edit window will pop up.  The edit window
     will contain the current text in the field selected.  See
     the section below on the full set of editing commands pro-
     vided by the edit window.

     You must complete the editing of the selected field before
     another field can be chosen.  If you wish to cancel the edit
     session, click on "Cancel", otherwise click on "Use".

     Manual Page (Section 1)

     Ghostwriter uses a PS file to complete the man 1 page for
     the routine that you are writing.  The following buttons can
     be selected to modify your program documentation:
     "AUTHORS", "SHORT DESCRIPTION", "LONG  DESCRIPTION", "COM-
     MAND EXAMPLES", "RESTRICTIONS", "MAN 1 SEE ALSO", or "PROMPT
     ADDITIONS".

     Code Segments for Driver (Main Code)

     Ghostwriter uses a PS file to complete the C driver file or
     main() code.  The driver does all reading and writing of
     files, error checking, all necessary command line process-
     ing, and calls the library code.  The following buttons can
     be selected to modify your program documentation:  "MAIN
     #INCLUDES", "MAIN #DEFINES", "MAIN MACROS", "MAIN VARI-
     ABLES", "INTRO CODE", "LIB CALL CODE", or "EXIT CODE".

     Manual Page (Section 3)

     Ghostwriter uses a PS file to complete the man 3 page for
     the routine that you are writing.  The following buttons can
     be selected to modify your program documentation:  "LIB
     SHORT DESCRP", "MAN 3 DESCRP", "MAN 3 SEE ALSO", "LIB RES-
     TRICTIONS", "LIB MODIFICATION", "INPUT ARGUMENTS", or "OUT-
     PUT ARGUMENTS".

     Code Segments for Library Code

     Ghostwriter uses a PS file to complete the C library file
     code.  The library contains all of the functionality of the
     program that you are writing.  It should be written so that
     other drivers can call it.  The following buttons can be
     selected to modify your program documentation:  "LIB FUNC-
     TION DEF", "LIB INCLUDES", or "LIBRARY CODE".

     Getting Started

     To create a new PS file, start by selecting "AUTHORS" and
     then typing in your name in the edit window.  Click on
     "Save" on the edit window to save the changes that you have
     made, and then continue with the other fields.  To save this
     PS file, type in the filename that you want and then click
     on the "SAVE" button.

     If you wish to begin by editing an existing PS file, copy an
     existing pane file into your working directory from
     KHOROS_HOME/src/vipl/arith_binary/vsub/vsub.prog.
     After you have done this, fill in the vsub.prog filename and
     click on the "READ" button.

     Copyright 1991, University of New Mexico. All rights
     reserved.

Version: 0                 Release: 1                           1

