home *** CD-ROM | disk | FTP | other *** search
/ CP/M / CPM_CDROM.iso / jsage / zsus / z3help / t.lbr / TCSRC.HZP / TCSRC.HLP
Encoding:
Text File  |  1991-11-18  |  10.9 KB  |  193 lines

  1. ;
  2.                                   TCSRC.COM                                   
  3.  
  4.              Size (recs) CRC   Version    Author/Latest Issue      Disk
  5.                5k (38)   EE90  1.4        Terry Hazen 8/90         Z3COM13
  6.  
  7.   1- Syntax  2- VLIB4D  3- Notes                                              
  8.  
  9.    The new extended Z3TCAP defined in VLIB4D includes  two terminal configura-
  10. tion bytes that allow the user to  specify to applications programs how he has 
  11. his terminal configured as well  as several new  terminal control  strings and 
  12. basic line graphics.  Since it is difficult to extensively customize an exist-
  13. ing Z3TCAP.Z3T file by patching alone,  TCSRC  was written  to  help  the user 
  14. customize his Z3TCAP by  creating  a commented source  code  file (MYTERM.Z80) 
  15. from an existing MYTERM.Z3T file for his terminal,  such as one extracted from 
  16. Z3TCAP.TCP by TCSEL, or from the current Z3TCAP located in memory in the ZCPR3
  17. environment.  The new source code file can then be edited,  assembled to a COM
  18. file, renamed to a .Z3T file, and uploaded to the environment using LDR, NZCOM
  19. or JETLDR.
  20. :1
  21.  
  22.     Syntax   TCSRC [[dir:]infile[.z3t]] [[dir:]outfile[.z80]]
  23.  
  24.      Default outfile is infile.Z80 on default directory.  Any
  25.      existing R/W file of the same name will be overwritten.
  26.  
  27.      Infile 'BLANK' creates blank commented source code file.
  28.  
  29.      If no infile is specified, Z3TCAP.Z80 is created from
  30.      the Z3TCAP in the environment.
  31.  
  32.  
  33. The companion utility ENVSRC  creates  commented  source  code from your ZCPR3
  34. environment using the latest extended environment definitions.
  35. :2
  36.  TCSRC and VLIB4D - 1/2 
  37.  
  38.    TCSRC generates Z3TCAP commented  source code  based on the extended Z3TCAP
  39. defined by VLIB4D.   VLIB4D  modifies the sequence of  control strings in  the 
  40. extended Z3TCAP over that  specified by earlier VLIB4 beta  releases to  bring 
  41. all  the  terminal control strings into  a common area  located  prior  to the 
  42. graphics area, reduces the length of the  terminal name to 13 bytes and adds a
  43. byte defining the offset of the graphics area from the start of the Z3TCAP.
  44.  
  45.    TCSRC expects input files to  be subsets  of the  VLIB4D standard,  such as 
  46. standard Z3TCAP files.   Consult the VLIB4 help files for explanations of each  
  47. of the defined terminal functions  and consult your terminal manual for infor-
  48. mation on the  terminal control  strings  required to  implement  the terminal 
  49. functions for your terminal.
  50.  TCSRC and VLIB4D - 2/2 
  51.  
  52.    Source code  produced  by TCSRC  from  earlier  extended  Z3TCAP files with 
  53. different extended formats will begin to  be incorrect  when  the  sequence of 
  54. control strings begins to  differ from  the  new VLIB4D standard and will have 
  55. to be corrected with  a text editor.   Lines  of source code defining terminal 
  56. control strings  may simply  be  moved into the correct  order, ignoring  both
  57. comments and labels (except for GOELD,  which  is used  to define the graphics
  58. area offset), as the corrected source code file  can  be  assembled  to  a COM
  59. file and TCSRC can then be  used  again  to quickly generate a new,  correctly
  60. commented source code file.
  61.  Graphics TCAP Offset 
  62.  
  63.    VLIB4D defines a  graphics offset byte at  GOFF (Z3TCAP+12), which contains
  64. the offset from the start of the Z3TCAP to the start of the  graphics  area at
  65. GEOLD,  to allow the  future  addition  of  terminal  control  strings  in the
  66. terminal control string area without requiring rewritting of the VLIB graphics
  67. routines using the  graphics data.   To  compensate for  the  addition  of the
  68. graphics offset byte, the length of the terminal name area has been reduced to
  69. 13 bytes.
  70.  Terminal Configuration Bytes - 1/2 
  71.  
  72.    VLIB4 defines two terminal configuration bytes  at B14 (Z3TCAP+14)  and B15
  73. (Z3TCAP+15) to allow an application program access to terminal characteristics 
  74. not otherwise specified in the Z3TCAP.  Application programs such as WordStar4
  75. (with Joe Wright's WSPAT ZCPR3 patch),  V and SCAN now have access to informa-
  76. tion not only about terminal control strings, but about how users have config-
  77. ured their terminals.   Users  can  set  configuration  bits  indicating,  for 
  78. example,  whether or not their terminals are set  to auto-wrap at the end of a 
  79. line or auto-scroll at the  end of a screen,  whether their terminals use ANSI 
  80. or ASCII control sequences,  and whether they use reverse video or non-reverse 
  81. (usually dim)  video for their standout  mode.   Not  all application programs 
  82. will check the terminal configuration  bytes,  but their  presence  allows the 
  83. user some control over how application programs configure his screen display.
  84.  Terminal Configuration Bytes - 2/2 
  85.  
  86.    SCAN, for example, checks the auto-wrap and auto-scroll bits to see whether 
  87. it can put characters in the last display column on the screen without causing 
  88. additional blank lines to be inserted into the display.   If both  bits are 0, 
  89. the last column is considered  safe,  and the whole screen can be used for the
  90. display.  If either bit is set, the last column is considered reserved and the 
  91. next-to-last column will be  the final column used.   So  if  your terminal is 
  92. configured to  not  automatically  wrap  or  scroll,  you  can  set  the  bits 
  93. accordingly and SCAN  will  use  the  whole screen.   Joe Wright's  WSPAT  for 
  94. WordStar4  uses the  configuration  bytes in a similar way, along with the set
  95. attribute string to create WS4 display screens.
  96.  Screen Display Configuration - 1/2 
  97.  
  98.    When you start looking at how many ways a given terminal can  be configured 
  99. by  a user and  how that configuration can affect screen displays,  it quickly 
  100. becomes clear that a standard Z3TCAP for a given terminal type is not adequate 
  101. to convey more than basic standard information for that terminal.  It may make 
  102. a difference to  a screen display intensive applications program, for example,
  103. whether a screen is configured  as dark letters  on  a light  screen  or light 
  104. letters on  a dark screen  and whether  reverse video or  a  non-reverse video 
  105. mode, such as dim or bold is used as standout.  For example, if dim is used as 
  106. standout mode on a dark screen,  spaces in standout mode won't show up, but if 
  107. reverse video is used, they will, creating quite a different display.
  108.  
  109.    If the Z3TCAP for a particular terminal specifies dim as the standout mode, 
  110. but the user prefers to use bold,  reserving  dim  for standard mode, but then 
  111. wishes to exit to a normal video command line, he must customize his Z3TCAP to 
  112. use SO (Start Standout),  SE (End Standout),  TI (Terminal Initialization) and 
  113. TE (Terminal Deinitialization) to  set  his  terminal according to his prefer-
  114. ences.  In  this example, SO would set dim,  SE would set normal, TI would set
  115. dim, and TE would set normal video.
  116.  Screen Display Configuration - 2/2 
  117.  
  118.    Still another user of the  same terminal type  might  prefer half intensity 
  119. for standout,  and would need to customize  his Z3TCAP accordingly.   So  many 
  120. terminal characteristics may  be user configured,  in fact,  that it is really 
  121. the user's  responsibility  to create  a customized Z3TCAP for his system that 
  122. reflects his own preferences.   TCSRC attempts  to facilitate this  process by
  123. providing the user  a handy tool  to  quickly  create Z3TCAP source code files 
  124. that may be easily edited and used to create his working customized Z3TCAP.
  125.  Extended Z3TCAP Terminal Control Sequences 
  126.  
  127.    The source code created  by TCSRC includes  the  LD (delete line  at cursor 
  128. position)  and  LI  (insert line at cursor position) sequences  added  in  the 
  129. extended Z3TCAP defined by VLIB4B.  Applications such as WordStar and SCAN can 
  130. use these control sequences to produce better displays.
  131.  
  132.    For screen display intensive applications such as WordStar 4.0 patch WSPAT, 
  133. Joe Wright added a macro to the Z3TCAP and a routine in VLIB4C to set terminal 
  134. display attributes.   The source code created  by TCSRC includes  the  SA (set 
  135. Attributes) macro and AT (the attribute string).
  136.  
  137.    The source code created  by TCSRC  also  includes  a  CD (clear screen from 
  138. cursor to end-of-screen) sequence.   While  sequence  is,  in  some  cases,  a 
  139. duplication of part  of the  CL (Home Cursor and Clear Screen) sequence, it is 
  140. now available as a separate control sequence.
  141.  Other New VLIB4 Terminal Control Sequences 
  142.  
  143.    For use  with  windowing  routines used in  pull-down  menus,  the extended
  144. Z3TCAP includes provisions  for  a  new  RC sequence that  returns the current
  145. cursor position in HL and  a new RL sequence that  reads  the  entire  line up
  146. until the cursor position into a buffer.  Consult V4LIBD.HLP for more informa-
  147. tion.
  148.  
  149.  Graphics Extensions 
  150.  
  151.    VLIB4 adds a new standardized  character  graphics area beginning  at GOELD
  152. (graphics on/off delay).   Graphics extensions include GO/GE (graphics mode on
  153. and off), and CDO/GDE (turn the cursor off and on).
  154.  Graphics Characters 
  155.  
  156.    Graphics characters now used by VLIB4  are one-byte characters that produce 
  157. lines,  intersections,  corners,  as  well  as full and  hashed  blocks.   For 
  158. terminals without graphics capability, very good results can be obtained using 
  159. the characters '-'  and '|'  for  horizontal (GHL)  and  vertical  (GVL)  line 
  160. characters.   The characters '*' and '#' can be used for full (GFB) and hashed
  161. (GHB) blocks,  the characters  '+'  or  '*' can  be  used  for corners and the 
  162. character '+' for intersections.
  163.  
  164.    Use TCSRC to add  graphics characters to  your own  Z3TCAP and  try BOX.COM 
  165. from VLIB4D for  a demonstration of  the new line graphics  as  used in  a box 
  166. drawing routine.
  167. :3
  168.  TCSRC Notes - 1/2 
  169.  
  170.    a. Version 1.4 updates (08/24/90, Terry Hazen):
  171.       - Adds new command line syntax to make it compatible with ENVSRC.
  172.       - The RC function is now correctly described in the documentation.
  173.    
  174.    b. Version 1.3 updates (05/07/90, Terry Hazen):
  175.       - Adds ability to create blank source code file when infile is specified
  176.         as BLANK.
  177.  
  178.    c. Version 1.2 updates (02/05/90, Terry Hazen):
  179.       - Revised to reflect changes in  control  string  locations  in  VLIB4D,
  180.         including  replacing the last byte of the name string  (now reduced to
  181.         13 bytes) by GOFF,  the offset from the  start  of  the  Z3TCAP to the 
  182.         start of the graphics area at GOELD.  
  183.       - Adds ability to  generate  source code from the current  Z3TCAP in the 
  184.         environment by specifying 'Z3ENV' as the infile.
  185.  TCSRC Notes - 2/2 
  186.  
  187.    d. Version 1.1 updates (01/26/90, Terry Hazen):
  188.       - Rewritten to do translation and loading in loops.  
  189.       - Fixes missing putud in help requests.  
  190.       - Adds  outfile  specification,  graphics  support  per VLIB4C.   Unless
  191.         otherwise specified, the default outfile (INFILE.Z80) is now placed in
  192.         the default directory.
  193.