home *** CD-ROM | disk | FTP | other *** search
/ HomeWare 14 / HOMEWARE14.bin / prog / ks94an.arj / MISC.TXT < prev    next >
Text File  |  1994-03-01  |  14KB  |  374 lines
  1. .TIF FILES
  2. ------------------------------------------------------------------------------
  3.  
  4. Several functions in the Klipper Library create internal TIF files (Table
  5. Information Files).  In each of these cases, the functions are designed
  6. such that these files may be deleted without ill effect.  All functions
  7. that use TIF files check to see if they exist and build them if necessary.
  8.  
  9. In fact, in several cases, such as editing a menu definition file, it is
  10. a good idea to delete the .TIF file before running the application so that
  11. a fresh one will be built reflecting whatever changes you have made.
  12.  
  13. The following functions create .TIF files:
  14.  
  15.     _KMenu()    --> MENUDEF.TIF
  16.     _MenuA()    --> APPMSG.TIF
  17.     Help()      --> SYS_HLP1.TIF
  18.     Help()      --> SYS_HLP2.TIF
  19.     _ReIndex()  --> DATALINK.TIF
  20.     _SetIndex() --> DATALINK.TIF
  21.  
  22. Some of these functions allow you to specify the NAME ot the LOCATION
  23. (ie, PATH) of the TIF file.  If you opt to do this, then you must keep
  24. track of those names accordingly to avoid confusion.
  25.  
  26.  
  27. BOX DEFINITIONS
  28. ------------------------------------------------------------------------------
  29.  
  30. The following preprocessor definitions are listed in KLIPPER.CH
  31.  
  32. BOXSINGLE      : single line border all sides
  33.  
  34. BOXDOUBLESIDE  : double line sides, single line top/bottom
  35.  
  36. BOXDOUBLETOP   : double line top/bottom, single line sides
  37.  
  38. BOXDOUBLE      : double line all sides
  39.  
  40. BOXTHICK       : "Thick" line all sides
  41.  
  42. BOXNONE        : no box (space for line draw)
  43.  
  44.  
  45. EXAMPLES
  46.  
  47.  BOXSINGLE  BOXDOUBLESIDE  BOXDOUBLETOP   BOXDOUBLE    BOXTHICK
  48. ─────────────────────────────────────────────────────────────────────────────
  49.  ┌──────┐   ╓─────────╖    ╒══════════╕   ╔════════╗   █▀▀▀▀▀▀▀▀▀▀▀▀▀█
  50.  │      │   ║         ║    │          │   ║        ║   ▌             ▐
  51.  │      │   ║         ║    │          │   ║        ║   ▌             ▐
  52.  │      │   ║         ║    │          │   ║        ║   ▌             ▐
  53.  └──────┘   ╙─────────╜    ╘══════════╛   ╚════════╝   █▄▄▄▄▄▄▄▄▄▄▄▄▄█
  54.  
  55.  
  56. INCLUDES
  57. ------------------------------------------------------------------------------
  58.  
  59. KLIPPER.CH    General Klipper Library definitions
  60. KFILE.CH      Definitions used by the BEGIN_FILE and END_FILE xtrans commands
  61. KGRAPH.CH     Definitions for alternate Bargraph function syntax
  62. KMETRIC.CH    Definitions used by _MetricConvert() function
  63.  
  64.  
  65. The following source code files use the following #include statements:
  66.  
  67.  
  68. SOURCE FILE                             #INCLUDE
  69. ******************************************************************
  70. ALLFIELD.PRG:                           #include "klipper.ch"
  71.  
  72. ARR2STR.PRG:                            #include "klipper.ch"
  73.                                         #include "fileio.ch"
  74.  
  75. ARRAYTXT.PRG:                           #include "fileio.ch"
  76.  
  77. BOX.PRG:                                #include "klipper.ch"
  78.  
  79. CHECKDRV.PRG:                           #include "fileio.ch"
  80.  
  81. CHECKSUM.PRG:                           #include "klipper.ch"
  82.  
  83. CHRLIMIT.PRG:                           #include "klipper.ch"
  84.  
  85. COLOR2NU.PRG:                           #include "klipper.ch"
  86.  
  87. COLORSAY.PRG:                           #include "klipper.ch"
  88.  
  89. DBCHOICE.PRG:                           #include "inkey.ch"
  90.  
  91. DIAL.PRG:                               #include "klipper.ch"
  92.                                         #include "fileio.ch"
  93.                                         #include "inkey.ch"
  94.  
  95. FCOMBINE.PRG:                           #include "fileio.ch"
  96.  
  97. FEOF.PRG:                               #include "fileio.ch"
  98.  
  99. FILE2VAR.PRG:                           #include "klipper.ch"
  100.                                         #include "fileio.ch"
  101.  
  102. FILEBOX.PRG:                            #include "klipper.ch"
  103.  
  104. FILEBROW.PRG:                           #include "klipper.ch"
  105.                                         #include "fileio.ch"
  106.                                         #include "inkey.ch"
  107.  
  108. FPEEKBYT.PRG:                           #include "klipper.ch"
  109.                                         #include "fileio.ch"
  110.  
  111. FSCREEN.PRG:                            #include "klipper.ch"
  112.  
  113. FSEEK.PRG:                              #include "klipper.ch"
  114.  
  115. FSIZE.PRG:                              #include "fileio.ch"
  116.  
  117. FWRITELI.PRG:                           #include "klipper.ch"
  118.  
  119. FX286MS.PRG:                            #include "set.ch"
  120.                                         #include "klipper.ch"
  121.  
  122. IMPORTP.PRG:                            #include "klipper.ch"
  123.                                         #include "kfile.ch"
  124.                                         #include "fileio.ch"
  125.  
  126. ISDBF.PRG:                              #include "fileio.ch"
  127.  
  128. ISDBFMEM.PRG:                           #include "fileio.ch"
  129.                                         #include "klipper.ch"
  130.  
  131. ISENVVAR.PRG:                           #include "klipper.ch"
  132.  
  133. KMENU.PRG:                              #include "inkey.ch"
  134.                                         #include "kfile.ch"
  135.                                         #include "klipper.ch"
  136.                                         #include "kfile.ch"
  137.                                         #include "klipper.ch"
  138.  
  139. LINEDAVA.PRG:                           #include "klipper.ch"
  140.  
  141. LINEDGET.PRG:                           #include "klipper.ch"
  142.  
  143. LINEDKIL.PRG:                           #include "klipper.ch"
  144.  
  145. LINEDPUT.PRG:                           #include "klipper.ch"
  146.  
  147. LINEDSIZ.PRG:                           #include "klipper.ch"
  148.  
  149. MAKEDICT.PRG:                           #include "klipper.ch"
  150.                                         #include "fileio.ch"
  151.  
  152. MEMARRAY.PRG:                           #include "fileio.ch"
  153.  
  154. MENUA.PRG:                              #include "achoice.ch"
  155.                                         #include "inkey.ch"
  156.                                         #include "klipper.ch"
  157.  
  158. METRIC.PRG:                             #include "kmetric.ch"
  159.  
  160. NEON.PRG:                               #include "setcurs.ch"
  161.                                         #include "klipper.ch"
  162.  
  163. NTXKEY.PRG:                             #include "fileio.ch"
  164.  
  165. NUM2COLO.PRG:                           #include "klipper.ch"
  166.  
  167. PASSWORD.PRG:                           #include "klipper.ch"
  168.                                         #include "inkey.ch"
  169.  
  170. PEEKSET.PRG:                            #include "klipper.ch"
  171.  
  172. POPBOX.PRG:                             #include "klipper.ch"
  173.  
  174. POPSCRSV.PRG:                           #include "fileio.ch"
  175.                                         #include "inkey.ch"
  176.                                         #include "klipper.ch"
  177.  
  178. POPSET.PRG:                             #include "klipper.ch"
  179.  
  180. PREPARE.PRG:                            #include "fileio.ch"
  181.                                         #include "klipper.ch"
  182.                                         #include "error.ch"
  183.  
  184. PRNTFILE.PRG:                           #include "klipper.ch"
  185.                                         #include "fileio.ch"
  186.  
  187. PRNTTEXT.PRG:                           #include "fileio.ch"
  188.  
  189. PULLTEXT.PRG:                           #include "klipper.ch"
  190.                                         #include "fileio.ch"
  191.  
  192. PUSHSET.PRG:                            #include "klipper.ch"
  193.                                         #include "set.ch"
  194.  
  195. Q_CLOSE.PRG:                            #include "klipper.ch"
  196.  
  197. Q_CONFIR.PRG:                           #include "klipper.ch"
  198.                                         #include "inkey.ch"
  199.  
  200. READF.PRG:                              #include "setcurs.ch"
  201.  
  202. READLINE.PRG:                           #include "fileio.ch"
  203.  
  204. RECOLOR.PRG:                            #include "klipper.ch"
  205.  
  206. SAVESCRN.PRG:                           #include "fileio.ch"
  207.                                         #include "inkey.ch"
  208.                                         #include "klipper.ch"
  209.  
  210. SCRNSCAN.PRG:                           #include "klipper.ch"
  211.  
  212. SELUSRPR.PRG:                           #include "klipper.ch"
  213.                                         #include "kfile.ch"
  214.  
  215. SETUSRPR.PRG:                           #include "klipper.ch"
  216.                                         #include "kfile.ch"
  217.  
  218. SLIDEBOX.PRG:                           #include "klipper.ch"
  219.  
  220. STR2ARR.PRG:                            #include "klipper.ch"
  221.                                         #include "fileio.ch"
  222.  
  223. SYS_HELP.PRG:                           #include "inkey.ch"
  224.                                         #include "memoedit.ch"
  225.                                         #include "setcurs.ch"
  226.                                         #include "set.ch"
  227.                                         #include "klipper.ch"
  228.                                         #include "kfile.ch"
  229.  
  230. S_USE.PRG:                              #include "klipper.ch"
  231.                                         #include "inkey.ch"
  232.  
  233. TEXTBROW.PRG:                           #include "klipper.ch"
  234.                                         #include "inkey.ch"
  235.  
  236. TIMER.PRG:                              #include "klipper.ch"
  237.                                         #include "inkey.ch"
  238.                                         #include "set.ch"
  239.  
  240. TO_PRN.PRG:                             #include "klipper.ch"
  241.  
  242. TXTARRAY.PRG:                           #include "fileio.ch"
  243.  
  244. VAR2FILE.PRG:                           #include "klipper.ch"
  245.                                         #include "fileio.ch"
  246.  
  247. WSPOPSSV.PRG:                           #include "fileio.ch"
  248.                                         #include "inkey.ch"
  249.                                         #include "klipper.ch"
  250.  
  251. WSSAVSCR.PRG:                           #include "fileio.ch"
  252.                                         #include "inkey.ch"
  253.                                         #include "klipper.ch"
  254.  
  255. WSSVSCR.PRG:                            #include "fileio.ch"
  256.                                         #include "inkey.ch"
  257.                                         #include "klipper.ch"
  258.  
  259. X_USE.PRG:                              #include "klipper.ch"
  260.                                         #include "inkey.ch"
  261.  
  262. __EDIT.PRG:                             #include "INKEY.CH"
  263.  
  264. __FOPEN.PRG:                            #include "fileio.ch"
  265.                                         #include "klipper.ch"
  266.  
  267. __GAT.PRG:                              #include "klipper.ch"
  268.  
  269. __LOG.PRG:                              #include "klipper.ch"
  270.  
  271. __LPRINT.PRG:                           #include "set.ch"
  272.  
  273. __REIDX.PRG:                            #include "klipper.ch"
  274.                                         #include "kfile.ch"
  275.  
  276. __SCAT.PRG:                             #include "klipper.ch"
  277.  
  278. __SETIDX.PRG:                           #include "klipper.ch"
  279.                                         #include "kfile.ch"
  280.                                         #include "klipper.ch"
  281.  
  282.  
  283. OS ENVIRONMENT VARIABLES
  284. ------------------------------------------------------------------------------
  285.  
  286. The following OS Environment variables are used in the places indicated.
  287. Refer to your OS manual for information on setting and using OS
  288. environment variables.
  289.  
  290.  
  291. U_NAME
  292.  
  293.     U_NAME is used directly (ie, read from the environment) by the
  294.     following functions:
  295.  
  296.         _MENUA()
  297.         _PREPARE()
  298.         _SELUSRPRN()
  299.         _SETUSRPRN()
  300.  
  301.     In addition to this, the value obtained from this environment
  302.     variable is used extensively in MANY places thorughout the
  303.     library.  Use of the Klipper Library almost mandates the setting
  304.     of this environment variable.
  305.  
  306.  
  307. HELPPATH
  308.  
  309.     This variable is used in the On-Line Help function.  If it is
  310.     specified, it's contents must be a PATH setting indicating the
  311.     location of the SYS_HELPDBF file.  If it is not specified, the
  312.     current directory is assumed.
  313.  
  314.  
  315. MSGPATH, APPMSGFILE, APPMSGIDX
  316.  
  317.     These variables are used my the _MenuA() function.  All three are,
  318.     currently, reserved for future use and are not used in the current
  319.     release.
  320.  
  321.     Together they will, when complete, enable applications using the
  322.     _KMENU() menu system to send and receive messages between users.
  323.  
  324.  
  325. BOXDELAY
  326.  
  327.     This variable is used by the _POPBOX() and _SLIDEBOX() functions
  328.     to "slow down" the "exploding box" effect when it is too fast on
  329.     some CPUs.
  330.  
  331.     It is a number in the range of 1 to 65535.  Normal ranges, however,
  332.     are in the 100 to 500 range.
  333.  
  334.  
  335. ERRPATH, ERRFILE
  336.  
  337.     These two variables contain a PATH and a FILE NAME, respectively,
  338.     of the location and name of the error log file that is created
  339.     by the _Prepare() function's error object.  If this environment
  340.     variable is not present at run-time, then the defaults are "current
  341.     directory" for ERRPATH, and "ERRORLOG.TXT" for the errorlog file
  342.     name.
  343.  
  344.  
  345. BOXRATIO
  346.  
  347.     This variable is used in _SLIDEBOX().  It controls the box ratio
  348.     for verticle and horizontal explode speeds.  Since most boxes
  349.     you may wish to draw will be longer in one direction than in the
  350.     other (due to having 80 columns but only 25 lines), the box will
  351.     finish it's verticle draw long before it finishes the horizontal
  352.     draw.
  353.  
  354.     This variable says, in effect, jump <BOXRATIO> horizontal positions
  355.     for each verticle position drawn.
  356.  
  357.     Thus the variable can be used to help ensure that the box completes
  358.     it's draw in all directions at approximately the same time.
  359.  
  360.     It is available in the first place because you may use several
  361.     different screen modes (I commonly use 132x50).
  362.  
  363.     If not present at run-time, the default value is 3.  This is pretty
  364.     close for 80x25 mode.  But in other modes, you may want to experiment
  365.     or you may just prefer that one explode direction complete before
  366.     another.
  367.  
  368.  
  369.  
  370. -------------------
  371. | END OF MISC.TXT |
  372. -------------------
  373.  
  374.