home *** CD-ROM | disk | FTP | other *** search
/ OS/2 Shareware BBS: 18 REXX / 18-REXX.zip / BDSOM1.ZIP / BUILDSOM.DOC < prev    next >
Text File  |  1992-10-27  |  5KB  |  150 lines
  1.  
  2.  
  3.          BuildSOM v1.0
  4.  
  5.  
  6.          INTRODUCTION
  7.          ------------
  8.  
  9.  
  10.          BuildSOM is a REXX program that will create OS/2 WPS objects.
  11.          Currently, the program supports only program and folder objects.
  12.          To build your WPS objects, create a file that contains the
  13.          definitions for the objects and run BuildSOM against that file.
  14.          The syntax is:
  15.  
  16.                      BuildSOM <defnfile>
  17.  
  18.          BuildSOM provides four primary value-added facilities over an
  19.          equivalent REXX program.
  20.  
  21.          1)!!!!!!BuildSOM will automatically handle the nesting of objects
  22.          within folders.  (For you SysCreateObject programmers, the location
  23.          is derived).
  24.  
  25.          2)!!!!!!The code will verify the existence of program executables
  26.          and the working directory for program objects before creating
  27.          the WPS objects.  Additionally, those executables in the path
  28.          do not have to be fully qualified.  BuildSOM will search the path
  29.          to find the full pathname of the program.
  30.  
  31.          3)!!!!!!Since BuildSOM is a two-pass program, ALL folder and
  32.          program objects are verified before any objects are created.  This
  33.          makes cleanup a lot easier than debugging a series of REXX
  34.          SysCreateObject calls.
  35.  
  36.          4)!!!!!!The defintions file is syntactically easier than a REXX
  37.          program with the equivalent statements.
  38.  
  39.  
  40.  
  41.          DEFINTIONS FILE
  42.          ---------------
  43.  
  44.  
  45.          The defintions file is a series of statements that create a
  46.          program or folder object.  The syntax is:
  47.  
  48.                CREATE { FOLDER | PROGRAM } ["Title"] [objectid]
  49.                   BEGIN
  50.                   [setup1]
  51.                   [setup2]
  52.                      .
  53.                      .
  54.                      .
  55.                   END
  56.  
  57.  
  58.          Note that the title must be enclosed in double quotes and connot
  59.          contain any quotes.  The object ID is optional.  The setup is
  60.          additional statements that define the executable file, the working
  61.          directory, the icon, etc associated with the WPS object that is
  62.          being created.  A list of those follow:
  63.  
  64.                ICON
  65.                EXE
  66.                PARM
  67.                DIR
  68.                SESSION
  69.  
  70.                  .
  71.                  .
  72.                  .
  73.  
  74.          Note that the BEGIN/END pair is required, even if there are no
  75.          setup values.  I will improve the parser in subsequent versions
  76.          to remove this restriction.
  77.  
  78.          The nesting of objects within a folder is handled by enclosing
  79.          the defintions for contained objects in curly braces, much like
  80.          a C program.  The following example creates a folder with a
  81.          full screen OS/2 command session and a windowed OS/2 command
  82.          session in it.
  83.  
  84.             CREATE FOLDER "Quick Command Lines"
  85.                BEGIN
  86.                END
  87.                {
  88.                CREATE PROGRAM "Windowed OS/2 Session"
  89.                   BEGIN
  90.                   EXE    *
  91.                   DIR    C:\
  92.                   SESS   OS2WINDOW
  93.                   END
  94.                CREATE PROGRAM "Full Screen OS/2 Session"
  95.                   BEGIN
  96.                   EXE    *
  97.                   DIR    C:\
  98.                   SESS   OS2FULLSCREEN
  99.                   END
  100.                }
  101.  
  102.  
  103.  
  104.          QUIRKS, THOUGHTS, ETC
  105.          ---------------------
  106.  
  107.          The program assumes that the objects created are on the desktop
  108.          or nested under the desktop.  There is no support in this
  109.          release of starting the hierarchy in another folder.
  110.  
  111.          I have noticed that if the executable is specified as '*', you
  112.          MUST have a SESS qualifier to make the object create complete.
  113.  
  114.          If you create an environment variable called 'ICONS' that contains
  115.          a list of directories that contain icon files, then this code will
  116.          search those directories to fully qualify the icon name.
  117.  
  118.  
  119.          REGISTRATION
  120.          ------------
  121.  
  122.          This is shareware, not freeware.   If you use this program in a
  123.          "production" environment, please register it with us.  The
  124.          registration is $25.  Feel free to upload this code and
  125.          documentation whereever you like,  but DO NOT upload any modified
  126.          code.  Please send any correspondence to:
  127.  
  128.  
  129.                Hilbert Computing
  130.                1022 N. Cooper
  131.                Olathe, KS  66061
  132.                Attn: Gary Murphy
  133.  
  134.                BBS:  (913) 829-2450  8N1 9600
  135.                Voice:(913) 780-5051
  136.  
  137.  
  138.  
  139.          FUTURE ENHANCEMENTS
  140.          -------------------
  141.  
  142.          Better documentation
  143.  
  144.          Add support for more object types (e.g. shadows and printers)
  145.  
  146.          Add UPDATE to the CREATE statements
  147.  
  148.          Add OPTIONS to turn on and off program name resolution
  149.  
  150.