home *** CD-ROM | disk | FTP | other *** search
/ OS/2 Shareware BBS: 5 Edit / 05-Edit.zip / kdraw.zip / kDraw.Doc < prev    next >
Text File  |  1998-09-12  |  7KB  |  133 lines
  1. ******************************************************************************
  2. * (c) Copyright International Business Machines Corporation 1994, 1998.      *
  3. *                  All rights Reserved.                                      *
  4. *                                                                            *
  5. *        User's Guide of DRAW and DRAWJ macros                (Ver 1.23)     *
  6. *                                                                            *
  7. *                                                                            *
  8. *        Author: Shintaroh Hori                   (Yamato Lab, IBM Japan)    *
  9. ******************************************************************************
  10.  
  11. List of files extracted from KDRAW.ZIP
  12. --------------------------------------
  13.    LICENSE.TXT   IBM License Agreement
  14.    KDRAW.ABS     Abstract of this program
  15.    KDRAW.DOC     User's Guide   (this file)
  16.    DRAW.KEX      Draw macro. Customized for codepage 437 and 850
  17.    DRAWJ.KEX     Draw macro. Customized for DBCS codepages 932 and 942.
  18.    Draw.the      THE version.
  19.    DrawJ.the     THE version.
  20.  
  21.  
  22. Introduction
  23. ------------
  24. Draw.kex and DrawJ.kex are macros of KEDIT which is a PC based XEDIT look-alike
  25. offered by Mansfield Software Group. You can use the macros to draw box
  26. characters by cursor movement keys just like DRAW.E macro of E-family editor.
  27.  
  28. Draw.kex/DrawJ.kex macros are better than DRAW.E macro in following points:
  29.  
  30.  o  Any characters can be entered in a file area while in drawing mode.
  31.  o  Up and down of a drawing pen is controlled by Ctrl-F1 key which would make
  32.     it easier to enter characters while you are drawing boxes.
  33.     (In DRAW.E macro, it is done by INSERT key.)
  34.  o  You can change box line type between single-line and double-line by Ctrl-F2
  35.     key while in drawing mode. (In case of DrawJ macro, box line types are
  36.     single-line and bold-line.)
  37.  o  Joint or cross of two lines with different types is supported.
  38.  o  You can also draw arrow characters of two types.
  39.  
  40.  
  41. Function of DRAW.KEX:
  42. ---------------------
  43.   When it is invoked, it enters a drawing mode where you can use Cursor move
  44.   keys(Up/Down/Right/Left) to draw box characters like a pen.
  45.   You can raise the pen by pressing Ctrl-F1 key to move the pen anywhere you
  46.   like by Cursor move keys, TAB keys, and any other keys that move the cursor,
  47.   and then put down the pen by pressing again the Ctrl-F1 key.
  48.  
  49.   The drawing mode is exited by pressing ESC key.
  50.  
  51.   In addition to this basic operation, the macro has following functions:
  52.  
  53.   1) You can select either primary code page or secondary code page for the
  54.      box characters when you invoke the macro.
  55.      The macro is customized for the primary to be for US and the secondary to
  56.      be for Japan.
  57.      (You can easily change them by modifying the macro.)
  58.  
  59.   2) US code page users can switch between box characters of single-line and
  60.      ones of double-line while in the drawing mode.
  61.      Ctrl-F2 key is assigned to alter the type.
  62.  
  63.      Join or cross of two lines of different types is supported so that one
  64.      type recognizes the other while in drawing whenever a character for the
  65.      join or cross is defined in the primary code page.
  66.  
  67.      For example, when a double-line crosses a single-line, then a cross
  68.      character of both double-line and single-line is drawn rather than the
  69.      single double-line that overlays the single-line.  See example below:
  70.  
  71.         ┌─────────────────────────────────────────────────┐
  72.         │           ┌──╥─┐   ╔═════╗                      │
  73.         │  ╔══╤══╗  │  ║ │   ║  ┌──╫──┐                   │ ── Looks good in
  74.         │  ║  │  ║  │  ║ │   ║  │  ║  │                   │     code page 437.
  75.         │  ╟──┼──╢  ╞══╬═╡   ║  │  ║  │                   │
  76.         │  ║  │  ║  │  ║ │   ╚══╪══╝  │                   │
  77.         │  ╚══╧══╝  └──╨─┘      └─────┘                   │
  78.         └─────────────────────────────────────────────────┘
  79.  
  80.   3) Arrow characters(Up/Down/Right/Left) can be entered by Cursor move keys
  81.      with Alt key pressed.  (         )
  82.  
  83.   4) While in the drawing mode, you can use any editing keys except the ones
  84.      that are assigned to control drawing as mentioned above.
  85.      (Mouse is disabled.)
  86.  
  87.   5) Two types of the arrow characters can be switched by C-F3 key for the
  88.      primary code page.
  89.  
  90.  
  91. Function of DRAWJ.KEX:
  92. ---------------------
  93.   This macro draws box characters of DBCS, and therefore only for DBCS users.
  94.   The box characters to be used are customized for Japanese code page.
  95.   You can easily modify the macro to support other code page for your own.
  96.  
  97.   Functions of this macro is the same as DRAW.KEX except the function #1
  98.   described above;
  99.  
  100.   1) You can switch between box characters of single-line and ones of bold-line
  101.      while in the drawing mode by Ctrl-F2 key.
  102.  
  103.      Join or cross of two lines of different types is supported so that one
  104.      type recognizes the other while in drawing whenever a character for the
  105.      join or cross is defined in the code page. (The same function as 2) of
  106.      Draw.kex macro.)
  107.  
  108.      Japanese code pages 932 and 942, however, do not have corner characters
  109.      that consist of both single-line and bold-line, they are treated as the
  110.      ones of only single-line.
  111.  
  112.   2) Arrow characters(Up/Down/Right/Left) can be entered by Cursor move keys
  113.      with Alt key pressed.
  114.  
  115.   3) While in the drawing mode, you can use any editing keys except the ones
  116.      that are assigned to control drawing as mentioned above.
  117.      (Mouse is disabled.)
  118.  
  119.  
  120. Syntax of DRAW and DRAWJ macros:
  121. --------------------------------
  122.    ┌─────────────────────────────────────────────────────────────────────┐
  123.    │                                                                     │
  124.    │  ─────DRAW──────┬─────────┬────────────────────────────────     │
  125.    │                   └───ALT───┘                                       │
  126.    │                                                                     │
  127.    │     Where ALT option enables the secondary code page to be used.    │
  128.    │                                                                     │
  129.    │                                                                     │
  130.    │  ─────DRAWJ────────────────────────────────────────────────     │
  131.    │                                                                     │
  132.    └─────────────────────────────────────────────────────────────────────┘
  133.