_______________________________________________________________________

                     Awk Configuration Component
                           for WinEdt 5
                           ============

                           Release 1.0
                          April 9, 2002

                    by Zhongxiao (David) Wang
                    Email: zwang@mail.smu.edu


_______________________________________________________________________


Contents:
=========
    Acknowledgement
    About
    Installation
    What does it contain?
    History

_______________________________________________________________________

* Acknowledgement
  ===============

    This work is partly based on the Configuration Component
    for Perl 5 for WinEdt 5, Release 1.1, by Denis Stancer,
    denis@srce.hr (http://www.winedt.org/Config/index.html).

_______________________________________________________________________

* About
  =====
Awk Configuration Component contains highlighting, active strings,
menu and tool bar customizations for awk. Here awk means gawk, a GNU
implementation which is available through Internet. You can get it
from http://www.gnu.org.

NOTE:
=====
1. IF YOU HAVE A VERSION OF AWK, YOU HAD BETTER NAME THE EXCUTABLE
   FILE AS GAWK.EXE. Otherwise, you need to edit file
   '%b\Config\Awk\no-TeX\Menu Accessories.dat' and/or
   '%b\Config\Awk\no-TeX\Menu Awk.dat' by locating the following
   statement

   Definition:Run('gawk.exe -f "%f" nul','%p',0,0,'Awk...');

   and changing text 'gawk.exe' to 'awk.exe' or something else you
   assigned to your awk.

2. You also need to move/copy file 'gawk.exe' and other required
   files, such as cygwin1.dll for cygwin, to some directory which is
   included in your environment variable, PATH. Or, set PATH to
   point to where file 'gawk.exe' exists.

_______________________________________________________________________

* Installation
  ============

STEP ONE:
=========
    The downloaded ZIP file should be extracted in %b\Config\Awk,
    where %b usually means

 1) on WinNT/2000/XP working as Administrator or in single user mode,
    or on Win95/98/Me:

    X:\Program Files\WinEdt Team\WinEdt

 2) on Windows NT/2000/XP working as an ordinary user:

    X:\Documents and Settings\<username>\Application Data\WinEdt, or
    X:\WinNT\Profiles\<username>\Application Data\WinEdt

 3) any special directory where you installed WinEdt, for example,
    G:\WinEdt.

STEP TWO:
=========
    Now, you have two choices.

    CHOICE ONE: no-TeX installation
    ===============================
    If you like a menu and toolbar system without TeX/LaTeX
    interface, then, start WinEdt and run macro, install.edt, via
    Macros|Execute Macro..., which is in %b\Config\Awk\no-TeX.

    The original toolbar as well as menus, Insert and Accessories,
    will be completely replaced by new ones.

    CHOICE TWO: co-TeX installation
    ===============================
    If you like a menu and toolbar system combines both awk
    and TeX/LaTeX interface, then, start WinEdt and run macro,
    install.edt, via Macros|Execute Macro..., which is in
    %b\Config\Awk\co-TeX.

    A new menu, Awk, and two button icons will be added to the menu
    system and the toolbar, respectively.

    I would prefer the second manner because I cannot tolerate
    keeping switching from TeX/LaTeX to Awk and vice versa
    frequently.

        TIPS:
        =====
        After installation, you can use Options|Configurations to
        customize your WinEdt interface as ASCII, HTML, or Perl
        editor. You change back via Options|Configurations|Restore...
        If it does not work, you or somebody else must have executed
        command Options|Configurations|Restore... after the
        installation of Awk Configuration Component. In this case,
        you have to follow STEP TWO to reinstall.


    NOTE:
    =====
    If you want to change from one installation to the other, you need
    to restore the default setting first via Options|Configurations|
    Default..., and then, repeat STEP TWO again.

    When you decide which components to install with the installation
    dialog, you have a chance to build integration between your
    WinEdt and cygwin, which implements a large subset of UNIX
    commands on Windows. By integration, here, I mean you would have
    a button icon on your toolbar and a menu item in menu Awk for
    co-TeX installation or menu Accessories for no-TeX installation,
    through which you can start Bash shell and be taken to the very
    directory your current working file appears. If you have no
    cygwin installed in your system or decide not to build such
    integration, the button icon and the menu item mentioned above
    will take you to the MS DOS Command Prompt.

    The integration was identified by a file, %b\Config\Awk\cygwin.
    You can manually create or delete it so as to create or remove
    the relation between WinEdt and cygwin.

    The ..\bin directory of cygwin should be covered by environment
    variable, PATH, if integration needed.

_______________________________________________________________________

* What does it contain?
  =====================

The installation will automatically update WinEdt's menus and toolbar,
depending on either co-TeX or no-TeX installation (see Installation).


  Highlighting
  ============

  The highlighted items (switches) are
  - field variables of the form: $0-9a-zA-Z
  - strings:                     "*" or '*'
  - regular expressions:         /?/
  - function names of the form:  func *name* (, or
                                 function *name* (

  The highlighted items (keywords) are
  - awk keywords
  - awk standard functions
  - awk built-in variables
  - awk escapes (\n,\t,\r,\S,\s...)


  Active Strings
  ==============

    {{  - inserts a block
    iff - if-else block
    whh - while block
    doo - do-while block
    foo - for (; ;) { } block
    fuu - inserts the contents of the file %b\Config\Awk\funchead.awk


  Insert Menu for no-TeX Installation
  ===================================

  - Code Frame:
        Inserts the contents of file %b\Config\Awk\new.awk.
        It's an easy way to start a new awk script file.
  - Function Frame:
        Inserts the contents of file %b\Config\Awk\funchead.awk.
        It's an easy way to start a new function/subroutine.
  - Awk functions:
        Grouped by function.
  - Awk built-in variables:
        Grouped by function and similarity.
  - Awk control blocks.


  Accessories Menu for no-TeX Installation
  ========================================

  - Run awk code:
        Runs the awk interpreter 'gawk.exe' (it has to be in your PATH)
  - Awk help:
        Starts gawk.hlp if it exists. Or, opens text file awk.hlp.

        While the provided awk.hlp is a brief summary of awk, gawk.hlp
        can be much more comprehensive. It should be of Windows help-file
        format. You can download it from some websites. If you decide to
        do so, please make sure to put it in %b\Config\Awk, and name it
        as gawk.hlp.


  Akw Menu for co-TeX Installation
  ================================

  - Run awk code
  - Awk help
  - OS Shell:
        Starts OS shell. If you integrate WinEdt with cygwin, that
        will start bash shell. Otherwise, a MS DOS Command Prompt
        window will pop up.
  - The same menu items as Insert Menu for no-TeX Installation.

_______________________________________________________________________

* History
  =======

  *** April 9, 2002:    v1.0
