home *** CD-ROM | disk | FTP | other *** search
/ Shareware Overload / ShartewareOverload.cdr / busi / smiiutil.zip / README.DOC < prev    next >
Text File  |  1990-01-11  |  20KB  |  361 lines

  1.                N U N L E Y 'S    S M A R T II    U T I L I T I E S
  2.      
  3.      
  4.      Welcome to Pierce Nunley's SmartII Utilities.  Enclosed are some util-
  5.      ities that are very useful for any SmartII user from the novice to the
  6.      advanced  user.   I  have written several project files to  streamline
  7.      SmartII, and, due to the prodding of my friends, I have decided to re-
  8.      lease a few of these as ShareWare.  Please Read the section at the end
  9.      of this document for registration.
  10.      
  11.      ----------------------------------------------------------------------
  12.                                 COPYRIGHT NOTICE
  13.      These project files are under copyright (c) 1989,  by Pierce D. Nunley
  14.      Consulting.    The  user is allowed a brief (less than 30 days) period
  15.      of  operation without fee of use.   If after this grace period all  or
  16.      any part of these project files are used,  the user must, by law, reg-
  17.      ister them and pay a nominal fee.   Please Read the section at the end
  18.      of this document for registration.
  19.      
  20.                                   DISCLAIMER
  21.      These  project files are distributed "as is"  and without expressed or
  22.      implied warranty.  Because of the diversity of conditions and hardware
  23.      under which these projects may be used,  no warranty as to performance
  24.      or  fitness for a particular purpose is offered.   The user is advised
  25.      to  test  the  projects and must assume the entire risk of  using  the
  26.      projects.  
  27.      ----------------------------------------------------------------------
  28.      
  29.      Now  with  all of that out of the way,  let's talk about  the  utility
  30.      package!  You should have received the following files.
  31.      
  32.      README.DOC - This document
  33.      REGISTER.DOC - registration form, Load and Print this from the WP
  34.      INSTALL.RF0 - Project file to install QuickDir, Secure, and EditProj
  35.      QUICKDIR.RF2 - Directory Changer
  36.      SECURE.RF2 - Screen blanker with password protection
  37.      EDITPROJ.RF2 - Utility to edit & compile project files
  38.      EDITPROJ.PF2 - source code 
  39.      ASCII.RF2 - Utility to display ASCII characters
  40.      ASCII.PF2 - source code
  41.      TEXTVIEW.RF2 - Text viewing function/project for programmers
  42.      TEXTVIEW.PF2 - source code
  43.      
  44.      
  45.      INSTALLATION - Read Carefully
  46.      The installation process will do several things:
  47.       1)  copy  the utility files from their current directory to the Smar-
  48.           tII system directory,
  49.       2)  create the file "SMART.MNU"  which allows commands to be added to
  50.           the SmartII "Tools"  menu.   Note:  If you have already defined a
  51.           "SMART.MNU" file, this will rename the old file to "SMARTOLD.MNU"
  52.           and  will create a new "SMART.MNU"  file.   You will then have to
  53.           load  both menu definition files into the text-editor or wordpro-
  54.           cessor  and  add  the old menu selections to  the  newly  created
  55.           "SMART.MNU"  file.  See Optional Menu Keywords section (pp 67-68)
  56.           of the Project Processing Manual for more information.
  57.       3)  modify  the "Tools Preferences Global"  file so that SmartII will
  58.           look for the "SMART.MNU" file on entry to SmartII.
  59.      
  60.      
  61.      TO RUN INSTALL:
  62.        1) make sure all of the files for this utility are in one directory
  63.        2) run SmartII (you should be in the Main-Menu)
  64.        3) use "Tools Directory New-Directory" to change the default  direc-
  65.           tory to the directory where the utilities are. 
  66.        4) Press "F8" and run Install
  67.        5) Answer any  questions that are asked during the installation pro-
  68.           cess.
  69.      
  70.      
  71.      The installation is complete and SmartII will be exited.  You must run
  72.      SmartII again to activate the new menu selections. 
  73.      
  74.      When  SmartII is reloaded,  you will notice that the commands "Secure"
  75.      "Quick_dir"  and  "Edit_projects" will be added to the "Tools" submenu
  76.      of  ALL  the modules of SmartII.   To the user they will behave as  if
  77.      they  were internal SmartII functions.   You can select them from  the
  78.      menu or even set up macros to execute them.   (e.g., personally I have
  79.      a macro file that is loaded every time I enter a module.  In it I have
  80.      defined ^E to run the Project Editor and ^D to run QuickDir)
  81.      
  82.      ----------------------------------------------------------------------
  83.                            PROJECT FILE DESCRIPTIONS
  84.      ----------------------------------------------------------------------
  85.      
  86.                                   QUICKDIR
  87.      
  88.      QuickDir is a pop-up directory changer.  It is very simple in it's op-
  89.      eration  which  is precisely why it is such an invaluable addition  to
  90.      SmartII.  It allows the user to quickly change back and forth from the
  91.      most  frequent directories that are used by the operators of the  sys-
  92.      tem.
  93.      
  94.      To use it you simply move the highlighter up and down until the direc-
  95.      tory  you  want  is highlighted and then press  "Enter".  The  options
  96.      available are:
  97.           "E" - This will allow you to edit the directory list
  98.           "M" or "\" - allows you to quickly choose a directory manually
  99.           "Esc" - exit without changing directory
  100.      
  101.      These  options are always listed at the bottom of the window,  and the
  102.      bottom row will always show the current datapath for your reference. 
  103.      
  104.      The first time QuickDir is run it will prompt the user to create a new
  105.      "SMART.DIR"  file  in the SmartII system directory.   There will be  a
  106.      pop-up  screen with a few rules and examples and then the  text-editor
  107.      will be loaded to create the directory file.   Basically you just need
  108.      to enter standard DOS path names in upper case,  lower case,  or mixed
  109.      case.   The  terminal backslash is optional unless you are  specifying
  110.      the root directory of a drive (i.e. C:\ or A:\).
  111.      
  112.      The  number of directories QuickDir will allow you to define is depen-
  113.      dant  on the current screen driver.   The total number of possible di-
  114.      rectories can be calculated as (screen height)-6   [e.g.  on most com-
  115.      puters there are 25 lines to the screen,  so therefore a total of 25-6
  116.      or 19 directories can be defined]  But,  if the display is EGA or VGA,
  117.      depending on the driver being used,  there can be from 29 to 54 direc-
  118.      tory entries stored. 
  119.      
  120.      NOTE:   If  you were a user of SMART 3.1 or earlier versions,  you may
  121.      have  used  a project file called CD which popped up a window and  al-
  122.      lowed  you to scroll up and down and select a directory to change  to. 
  123.      This  was either the project file that I wrote or the file after some-
  124.      one had modified it (I had distributed the source code).   QuickDir is
  125.      a vast improvement over the 3.0 version.   It now uses many of the ad-
  126.      vanced functions that SmartII has over Smart 3.1.  
  127.      
  128.      TECHNICAL INFO:   QuickDir looks very simple,  but it is actually over
  129.      300 lines of compact code.   The error checking and streamlining in it
  130.      is extensive and it has taken many hours to develop and debug.  
  131.      
  132.      
  133.      
  134.      ----------------------------------------------------------------------
  135.                                   SECURE
  136.      
  137.      SECURE  will ask for a password,  will verify the password,  and  will
  138.      then  blank the screen and do some nice unobtrusive graphics until the
  139.      password  is  reentered.   This serves as a screen saver to keep  from
  140.      burning  the screens of some monitors.   But more importantly,  SECURE
  141.      keeps  others from viewing or manipulating the files the user is work-
  142.      ing on and SAVES TIME because the user won't have to unload their cur-
  143.      rent work.
  144.      
  145.      The password can be up to eight key strokes.  One nice feature is that
  146.      ANY  key except "Esc"  or "Enter"  are valid keys in a password  (e.g.
  147.      Alt-P,  Ctrl-U, Home, F12, etc.).   The screen will then blank and you
  148.      are required to enter the exact keystrokes again in order to gain con-
  149.      trol of the terminal.   SECURE constantly monitors the keyboard, so it
  150.      is only necessary to reenter just the password (i.e. an "Enter" is not
  151.      needed).   The  operator is allowed about four tries at reentering the
  152.      password,  at  which  point each time a key is pressed an  alarm  will
  153.      sound.   This will let the operator know if someone has been trying to
  154.      access  the system.   The password can still be entered,  but an alarm
  155.      will still sound with each key stroke. 
  156.      
  157.      NOTE:   SECURE  cannot  be circumvented short of rebooting the  entire
  158.      system.   There are no "loopholes" to this protection once it is acti-
  159.      vated (i.e.  ^Z,  ^C, ^Break,  etc).   If the password key sequence is
  160.      forgotten, the computer will have to be rebooted to regain access.  If
  161.      a  person  reboots the system,  they will obviously have to  know  the
  162.      passwords of any databases,  spreadsheets, documents, etc. in order to
  163.      reload them.   It is recommended that all current work be SAVED before
  164.      executing this program.  
  165.      
  166.      IMPORTANT:  Be CAREFUL using User Defined Macros.  A User Defined Mac-
  167.      ro  will feed ALL the keystrokes that are defined.   For  example,  if
  168.      Ctrl-D is defined as [F8,"c:\smartii\secure.rf2",Enter,Enter] then all
  169.      of  these keystrokes will be sent to SECURE if the user types ^d as  a
  170.      keystroke.   This would be greater than 8 keystrokes, and,  therefore,
  171.      will  not work as a keystroke in a password.   However,  if a User De-
  172.      fined  Macro contains less than eight key strokes it can be used as  a
  173.      keystroke  and  ALL of the keystrokes in the Macro Definition will  be
  174.      sent  to SECURE.  (e.g.  if Ctrl-F10 is defined as  [Down,Down,Right],
  175.      then  if  the user presses Ctrl-F10 in a password then the three  key-
  176.      strokes  [Down,Down,Right]  will be sent to SECURE and it will be  the
  177.      same as if they were typed separately.
  178.      
  179.      
  180.      ----------------------------------------------------------------------
  181.                                     EDITPROJ
  182.      
  183.      EDITPROJ  is a programmer's tool.   It's purpose is to aid in  editing
  184.      and  compiling project files.   It will select all the project  source
  185.      code  files (*.pf?) for the current module that are in the current da-
  186.      tapath.  It will put them in a menu from which they may be selected to
  187.      edit in the Text-Editor.   When the editor is exited, either by Esc or
  188.      F10,  a menu will pop-up asking if the project is to be compiled.   If
  189.      yes, then it will ask if No-Debug or Debug mode is to be used.  
  190.      
  191.      EDITPROJ will save the information of which project was last chosen to
  192.      edit so that it will first highlight that file on re-execution of this
  193.      project  while  in the SAME module and the SAME session.   This  saves
  194.      time  when debugging,  recompiling,  and executing a project file when
  195.      the programmer is smoothing out the edges.   
  196.      
  197.      I  personally  do not like the Project File editor because  it  always
  198.      compiles  the  file in Debug mode and doesn't give the user a  choice. 
  199.      EDITPROJ always gives the programmer a choice of compiling and whether
  200.      to use Debug or No-Debug mode.  
  201.      
  202.      For  a large project file a programmer will probably want to write the
  203.      bulk of the project in a programming editor, but SmartII's text-editor
  204.      is  adequate for writing most project files,  and the on-line help in-
  205.      cludes the entire function and project command reference manuals.  
  206.      
  207.      If  an error occurs during compilation,  this project will reload  the
  208.      file  in the Text-Editor and move the cursor to the line and space  of
  209.      the  error.   [This is a very interesting piece of code for a program-
  210.      mer.  This is a good example of the power of SmartII PDL]
  211.      
  212.      I  have set ^E (EDIT) as a macro that will run this project.  It is in
  213.      my  default macro load.   I have also put this as a menu option off of
  214.      my tools menu using the SMART.MNU file.
  215.      
  216.      
  217.      ----------------------------------------------------------------------
  218.                                       ASCII
  219.      
  220.      This will display an ASCII table for the current text driver.  SmartII
  221.      ASCII  characters will be different depending on which text driver  is
  222.      being  used (set by Tools Preferences Hardware).   As programmer it is
  223.      very  useful to be able to pull up an ASCII table to eliminate  guess-
  224.      ing.  
  225.      
  226.      This  program  will store each screen driver's ASCII table to disk  so
  227.      that it will be "instantly"  restored when run again.   The programmer
  228.      will want to look at how this storage and retrieval is done. 
  229.      
  230.      ----------------------------------------------------------------------
  231.                                     TEXTVIEW
  232.      
  233.      TEXTVIEW  is  a text viewer with built in Find,  Goto,  and  Word-Wrap
  234.      functions.   This  is strictly a programmers tool.  Its only practical
  235.      use  is within a Project when you want to allow the user to view,  but
  236.      NOT edit,  a file (e.g.  help files, and text file reports,  etc).   I
  237.      have  not cleaned up the code,  and there are plenty of places to make
  238.      modifications.   I  recommend using this as a function in which it  is
  239.      fed $filename (the filename to be read) and $title (the title that ap-
  240.      pears on line 1 of the screen).   e.g. the function would be "FUNCTION
  241.      textview($filename,$title)"
  242.      
  243.      TEXTVIEW  is currently set up to put all the "*.txt"  files in a  menu
  244.      from  which to choose.   If you want to quickly see how it works,  set
  245.      the datapath to a directory that contains some "*.txt"  files and then
  246.      run TEXTVIEW.
  247.      
  248.      Play with it and enjoy.  If you use it, or any significant part of it,
  249.      for any commercial applications, I would appreciate some reimbursement
  250.      for  my efforts.    This may seem like easy code,  but it took quite a
  251.      long time to get the bugs out.
  252.      
  253.      ---------------------------------------------------------------------
  254.                         A NOTE TO FELLOW PDL PROGRAMMERS
  255.      
  256.      I  hope that these utilities aid you in your programming.   The source
  257.      codes  for  QuickDir and Secure were not included,  but both  programs
  258.      were written so that they could be run within another project and used
  259.      in your projects even though you don't have the source code.
  260.      
  261.      Even  though  the  source codes for QuickDir and Secure were  not  in-
  262.      cluded,  they  can be purchased.   If you are interested in purchasing
  263.      the  source  code write me or leave a message on DocTalk BBS (See  be-
  264.      low).
  265.      
  266.      ---------------------------------------------------------------------
  267.                               ABOUT THE PROGRAMMER
  268.      
  269.      My  name is Pierce Nunley and I have been a SMART user since 1985.   I
  270.      am  a third year medical student at the University of Kansas School of
  271.      Medicine and am planning on going into a surgery sub-specialty or pos-
  272.      sibly  interventional radiology.   I also hope to be a bridge  between
  273.      clinical medicine and totally integrated computer applications in med-
  274.      icine.  
  275.      
  276.      I  started extensively using project processing in 1986 and have writ-
  277.      ten  many powerful applications since that time including a project to
  278.      run a greeting card company [AlphaLight Publishing, Inc.] (orders, in-
  279.      voicing,  inventory,  commissions, client tracker,  sales rep tracker,
  280.      prospective client tracker, etc.) which has been running for 14 months
  281.      now.   I have also written programs for the KU medical center.  One is
  282.      a  (CAI) Computer Assisted Instruction program for the basic  sciences
  283.      which is currently installed on > 12 computers around the medical cen-
  284.      ter and many private computers which has been running since the summer
  285.      of  1987.    Another is a program to keep track of all the InHouse pa-
  286.      tients  in  the Department of Family  Practice  (patients,  diagnosis,
  287.      problem lists, medications, admitions and discharges).
  288.      
  289.      I  am always open to suggestions and new ideas so please write if  you
  290.      have any.  I can be reached at the address on registration form or al-
  291.      so at:
  292.                DocTalk BBS    
  293.                913-588-1998 
  294.                2400,N,8,1  
  295.                24hours/day, 4 nodes.  
  296.      
  297.      I  am a Co-SysOp of this medically oriented BBS out of the  department
  298.      of Family Practice at the University of Kansas School of Medicine.  
  299.      
  300.      ----------------------------------------------------------------------
  301.                                   REGISTRATION
  302.                                         
  303.      These files are distributed under the ShareWare concept.   If you find
  304.      that you are still using any of them after 30 days they should be reg-
  305.      istered.   If these are used by a For-Profit organization then you are
  306.      REQUIRED by law to register these utilities.  
  307.      
  308.      With  registration you will receive any future updates to these  proj-
  309.      ects.  
  310.      
  311.      Prices are as follows:
  312.                 Private User -  $20.00 or whatever you think it is worth.
  313.      Non-Profit Organization -  $10.00 
  314.                                 $ 5.00 per terminal
  315.      For-Profit Organization -  $30.00 1 terminal
  316.                                 $20.00 per terminal 2-10
  317.                                 $17.00 per terminal 11-20
  318.                                 $14.00 per terminal > 21
  319.      
  320.      ----------------------------------------------------------------------
  321.                                 REGISTRATION FORM
  322.      
  323.      Name/Company: ________________________________________________________
  324.      
  325.           Address: ________________________________________________________
  326.      
  327.                    ________________________________________________________
  328.      
  329.              City: ________________________   State: _____   Zip: _________
  330.      
  331.      Contact Person: _____________________________________________________
  332.      
  333.      Type of Computer(s): ________________________________________________
  334.      
  335.      _____________________________________________________________________
  336.      
  337.      Main Use of SmartII: ________________________________________________
  338.      
  339.      _____________________________________________________________________
  340.      
  341.      Where did you obtain these utilities: _______________________________
  342.      
  343.      _____________________________________________________________________
  344.      
  345.      
  346.      Qty.     Description                          Unit Price     Price
  347.      
  348.      _____    Pierce Nunley's SmartII Utilities    __________    ________
  349.      
  350.                       If Missouri Resident add 6.425% sales tax  ________
  351.                                                                ===========
  352.      
  353.                                                          Total   ________         
  354.                 Mail to:
  355.                 Pierce D. Nunley Consulting
  356.                 3921 Bell Avenue
  357.                 Kansas City, Missouri  64111
  358.      
  359.      
  360.                Make Checks payable to Pierce D. Nunley Consulting.
  361.