home *** CD-ROM | disk | FTP | other *** search
/ HAM Radio 1 / HamRadio.cdr / misc / baycom / ew.doc < prev    next >
Text File  |  1991-01-01  |  9KB  |  194 lines
  1.      EDITOR WORKBENCH
  2.      ----------------
  3.  
  4.  
  5.      1. What is the Editor Workbench ?
  6.      ---------------------------------
  7.      The Editor Workbench (EW) is a simple text editor which
  8.      edits plain ASCII files of up to 240 characters per line,
  9.      999 lines per file, and a maximum total size of around 50k
  10.      per file. It is designed as a programmers tool, not a word
  11.      processor, so it doesn't offer features like word wrap or
  12.      print formatting. Instead it allows the programmer to create
  13.      a customised workbench for those programming languages which
  14.      don't come in an integrated programming environment, such as
  15.      the DOS BATCH language, or A86.
  16.  
  17.  
  18.      2. Installation and Invocation.
  19.      -------------------------------
  20.      The program can be run from the hard disk or a diskette.
  21.      Best results are obtained with a hard disk. Copy the files
  22.      from the diskette into a subdirectory called EW.
  23.  
  24.      If you want to use a customised configuration for EW then
  25.      you need to be in the EW directory when you start the
  26.      program, but if you just want to quickly edit a file then
  27.      you can be in any directory, but you will only have one
  28.      screen of help information available when you press the help
  29.      button.
  30.  
  31.  
  32.      3. Trying out EW.
  33.      -----------------
  34.      First try EW in its simplest form, using the command EW
  35.  
  36.      You will be presented with a menu of four options, change
  37.      drive, change directory, edit an old file, or create a new
  38.      file. If you specify a new file you are presented with a
  39.      window to enter the file name. Whenever you are presented
  40.      with a data entry field you may toggle insert on and off
  41.      with the Ins key, delete characters with the Del or
  42.      Backspace keys, jump to the ends of lines with Home and End,
  43.      and erase to the end of a line with Ctrl/Z. If you have
  44.      completely mistyped something you may untype any changes by
  45.      pressing the f2 key BEFORE you enter the data.
  46.  
  47.      If you specify an old file you are presented with a menu.
  48.      All EW menus are scrolling. If there are more options than
  49.      can be displayed in the window then the menu will scroll
  50.      when you cursor past the bottom. The Home, End, PgUp, and
  51.      PgDn keys allow faster navigation of menus. Press enter to
  52.      select an option, or the ESCAPE key to back out of the menu
  53.      without making a selection. If you select a directory name
  54.      (ends in \ on the menu), rather than a file name then EW
  55.      will change to that directory and present a fresh menu of
  56.      file names.
  57.  
  58.      At any time you can press f1 for HELP which summarises the
  59.      edit key details. When you use a customised configuration
  60.      you can get much more info from the help screens. Press
  61.      ESCAPE to leave HELP.
  62.  
  63.      At any time you can press Alt D to shell to DOS so that you
  64.      can do the things that programmers always want to do in the
  65.      middle of an editing session, such as running CHKDSK or
  66.      formatting a floppy. To get back into EW from DOS type the
  67.      command EXIT
  68.  
  69.      When you have selected an old file or specified a new file
  70.      you are dropped into the screen editor. There are few
  71.      surprises in this editor. It is a simple 240 column screen
  72.      editor.
  73.  
  74.      CTRL Z deletes to the end of a line, and if the cursor is in
  75.      column 1 when you do this it deletes the whole line.
  76.  
  77.      The Insert key toggles the insert function on and off. When
  78.      Insert is toggled on you can enter new lines just by
  79.      pressing the enter key. If the cursor is in column 1 it will
  80.      insert a new line before the current line. Otherwise it will
  81.      open up a new line immediately after the current line.
  82.  
  83.      CTRL PgUp and CTRL Home get you back to the first line of
  84.      the file. CTRL PgDn and CTRL End get you to the last line of
  85.      the file. Press f4 and you will be asked which line number
  86.      you want to go to. Press f6 and you will be asked to enter a
  87.      string of characters, and EW will take you to the FIRST
  88.      occurrence of that string in the file. It ignores
  89.      UPPER/lower case differences for this search. Pressing f8
  90.      does the same but finds the NEXT occurrence of the string
  91.      after the current line.
  92.  
  93.      Press f9 to mark the start of a block anf f10 to mark the
  94.      end of a block. Blocks can only be whole lines, not parts of
  95.      lines. When you set up a block the lines are highlighted.
  96.      Now you can use Shift f9 to jump to the start of the block,
  97.      Shift f10 to jump to the end, and shift f6 and shift f8 to
  98.      find the first or next occurrence of the string within the
  99.      block.
  100.  
  101.      f3 brings up a menu of miscellaneous edit functions such as
  102.      deleting the marked block, moving it to another part of the
  103.      file, or sorting it.
  104.  
  105.      f5 brings up a menu of miscellaneous file functions such as
  106.      writing the block to a new file, or combining a file from
  107.      disc with the one in memory.
  108.  
  109.      Press ESCAPE to get out of the editor. If you have made any
  110.      changes you will be asked if you want to save the changes or
  111.      abandon them. When you have answered this question you will
  112.      be returned to the main menu, which now contains more than
  113.      just four options. Ignore these for now and just select
  114.      Quit, or press the ESCAPE key again.
  115.  
  116.  
  117.      4. Using EW with a monochrome screen.
  118.      -------------------------------------
  119.      Monochrome screens sometimes have trouble with the colour
  120.      combinations used in software designed for colour screens.
  121.      If this is the case try invoking EW with the /M parameter.
  122.  
  123.  
  124.      5. Using EW with a file specification.
  125.      --------------------------------------
  126.      You can pass a file spec to EW when you invoke it, e.g.
  127.  
  128.        EW *.TXT
  129.  
  130.      This will limit EW's directory search to files matching this
  131.      file spec. If you pass a filename without wild cards, e.g.
  132.  
  133.        EW FRED.BAT
  134.  
  135.      then EW will edit this file automatically, without you
  136.      having to select the OLD or NEW options from the menu. File
  137.      specs can be qualified with a directory and a disk drive
  138.      identifier if desired.
  139.  
  140.  
  141.      6. The ESCAPE character.
  142.      ------------------------
  143.      One of the most infuriating things about many editors from a
  144.      programmers point of view is the impossibility of entering
  145.      the escape character, ascii 27. In EW, you can enter this
  146.      using the CTRL E combination, and it is displayed on the
  147.      screen as a back arrow.
  148.  
  149.  
  150.      7. Defaults.
  151.      ------------
  152.      So whats so special about EW you may well ask, a pretty
  153.      standard text editor with a DOS shell option. So lets see
  154.      how we can get EW to do something a bit more useful to the
  155.      Batch File Programmer.
  156.  
  157.      Invoke EW with the command
  158.  
  159.      C>EW /D=BAT
  160.  
  161.      This parameter causes EW to look for a Defaults File called
  162.      BAT.DFT, which again is just an ordinairy ascii file set up
  163.      using EW. (The default Defaults File is called EW.DFT but
  164.      you don't have to have one). The defaults file specifies
  165.      which directory and file spec, and help file to use, and how
  166.      to interface to the language you are using.
  167.  
  168.      EW will now look only for batch files, i.e. using the spec
  169.      *.BAT. Try loading an old file and the file list is now
  170.      considerably shorter. Select TEST.BAT which is a very simple
  171.      batch file. Try the HELP key and you will discover that
  172.      there is considerably more HELP information than there was
  173.      before and its all relevent to programming in batch. This
  174.      help file is also just an ASCII file, set up with EW. EW is
  175.      worth using just for the Help file alone!
  176.  
  177.      Now you can try those other options on the EW main menu.
  178.      Select RUN to run your batch file without having to quit the
  179.      EW program. Select Parameters to specify the parameters to
  180.      be passed to your program. Select Show Output to remind
  181.      yourself what the last screen of output looked like, and
  182.      select Variables to see what the current settings of the
  183.      environmental variables are.
  184.  
  185.      The Defaults option on the menu allows you to select a new
  186.      set of defaults on the fly without having to exit EW.
  187.  
  188.  
  189.      9. Influences.
  190.      --------------
  191.      EW was originally developed as a batch program editor, and
  192.      has been greatly influenced by the wonderful development
  193.      environments found in the Borland Turbo products.
  194.