home *** CD-ROM | disk | FTP | other *** search
/ ProfitPress Mega CDROM2 …eeware (MSDOS)(1992)(Eng) / ProfitPress-MegaCDROM2.B6I / PROG / PASCAL / TOTDOC.ZIP / README.COM (.txt) < prev    next >
Encoding:
Graham's TXT2COM  |  1991-02-10  |  28.1 KB  |  492 lines

  1.                   WELCOME TO TECHNOJOCK'S OBJECT TOOLKIT
  2.                   --------------------------------------
  3.  
  4.   This README file contains important information about TechnoJock's
  5.   Object Toolkit (TOT) version 1.0. For the latest information about 
  6.   TOT, the accompanying programs and the manual, read this file in 
  7.   its entirety. To print this file, just press T and specify a printer
  8.   port or a filename.
  9.  
  10.  
  11.                   TABLE OF CONTENTS
  12.                   -----------------
  13.                   1.  Usage Hints
  14.                   2.  Using the Demos
  15.                   3.  TOT Enhancements and Undocumented Features
  16.                   4.  The Norton Guides TOT Database  
  17.                   5.  Files on the Disks  
  18.                   6.  Shareware  
  19.                   7.  Printing the Manual  
  20.                   8.  Installation
  21.                   9.  Association of Shareware Professionals
  22.                 
  23.               +----------------------------------------------+
  24.               |  P a r t   1    -    U s a g e   H i n t s   |
  25.               +----------------------------------------------+
  26.  
  27. Many of you will want to start using the Toolkit immediately. However, we 
  28. really do recommend that you read the first three chapters of the User's 
  29. Manual before you start coding. Ideally, you should read the entire 
  30. manual - after all, we wrote it in the hope that you would!
  31.  
  32. If you insist on using the Toolkit without reading the documentation, at 
  33. least follow these hints:
  34.  
  35.    1)  The Toolkit includes the following, globally declared and initialized
  36.        objects:
  37.  
  38.               SCREEN       - for writing to the visible screen
  39.               KEY          - for accessing the keyboard
  40.               MOUSE        - for controlling the mouse location and shape
  41.               MONITOR^     - a POINTER to an object controlling display 
  42.                              characteristics
  43.               LOOKtot^     - a POINTER to an object controlling default 
  44.                              colors, etc. 
  45.               SHADOWtot^   - a POINTER to an object controlling shadow
  46.                              characteristics
  47.               SCROLLtot^   - a POINTER to an object controlling scroll bar
  48.                              characteristics
  49.               DATEtot^     - a POINTER to an object controlling date
  50.                              characteristics
  51.               IOtot^       - a POINTER to an object controlling the form
  52.                              input defaults
  53.               ALPHABETtot^ - a POINTER to an object controlling how the
  54.                              TOOLKIT manipulates upper- and lower-case chars
  55.  
  56.    2)   If you create any other object instances (i.e. variables), make
  57.         sure you call the INIT method before any others, and the DONE method
  58.         when you are finished. The following code fragment illustrates how you
  59.         could use the ScreenOBJ object to save and restore the visible screen:
  60.  
  61.              var  SaveScreen: ScreenOBJ;
  62.              begin
  63.                 SaveScreen.Init;
  64.                 SaveScreen.Save;
  65.                 {...}
  66.                 {other procs which write to the screen}
  67.                 {...}
  68.                 SaveScreen.Display;
  69.                 SaveScreen.Done;
  70.              end;
  71.  
  72.         IMPORTANT NOTE: don't call the INIT and DONE methods for the
  73.         global instances described in hint 1).
  74.  
  75.    3)   Enable the FINAL directive in the TOTFLAGS.INC file to minimize
  76.         program size.
  77.  
  78.    4)   Run the demos to see how each unit can be used (discussed next).
  79.  
  80.             +---------------------------------------------------+
  81.             |  P a r t   2    -    U s i n g  t h e  D e m o s  |
  82.             +---------------------------------------------------+
  83.  
  84. There are over 80 demo programs in the Toolkit. The majority of these 
  85. demos are designed to illustrate a specific finite part of the Toolkit. They 
  86. are referred to at the appropriate places in the documentation. Listed below 
  87. is a summary of the demo files:
  88.  
  89.                      DEMBR1-5    Browse demos   
  90.                      DEMBX1-3    Box demos
  91.                      DEMCU1      Cursor demo
  92.                      DEMDR1-7    Directory demos
  93.                      DEMDT1-2    Date demos
  94.                      DEMEX1-2    DOS EXEC demos
  95.                      DEMFS1      Screen writing demo
  96.                      DEMIN1-4    Keyboard and mouse input demo
  97.                      DEMIO1-23   Form Input demos
  98.                      DEMLK1-2    Link list demos
  99.                      DEMLS1-9    List demos
  100.                      DEMMN1-9A   Menu emos
  101.                      DEMMS1-8    Message demos
  102.                      DEMOV1-2    Overlay demos
  103.                      DEMSC1      Scroll bar demo
  104.                      DEMSH1      Shadow demo
  105.                      DEMST1-3    String demos
  106.                      DEMSY1      System demo
  107.                      DEMVI1      Virtual screen demo
  108.                      DEMWI1-4    Window demos
  109.                      DEMWR1      Screen writing demo
  110.                      EXTDEM1-8   Extension demos
  111.                      TOTDEMO     Overall Demo
  112.  
  113. If your goal is to appreciate the power of the Toolkit, then consider 
  114. running the following demos (as well as being educational, they have visual 
  115. impact):
  116.                       TOTDEMO
  117.                       DEMIO21,22
  118.                       DEMLS9
  119.                       DEMMN9
  120.                       DEMBR5
  121.  
  122. A special thank-you to George Butts and George Bean, two Toolkit users who
  123. have generously given us some programs they developed with the Toolkit. Try 
  124. running the programs
  125.           
  126.                      TBROWSE
  127.                      TELE
  128.  
  129. to see how easy the Toolkit is to use!
  130.   
  131.  
  132.               +-----------------------------------------------+
  133.               |  P a r t   3    -    E n h a n c e m e n t s  |
  134.               +-----------------------------------------------+
  135.  
  136. This section identifies any last minute changes that have been made since
  137. the documentation was printed. The following topics are discussed:
  138.  
  139.                   1) International Customization
  140.                   2) Additions to totMISC
  141.                   3) Key Constants
  142.  
  143. 1) INTERNATIONAL CONSIDERATIONS
  144. ===============================
  145. The TOTIO2.PAS unit includes the following declarations:
  146.  
  147.    CONST
  148.    NumberError: array[1..2] of string[60] =
  149.    (' The number you entered is out of range. ',
  150.     ' Enter a number in the following range: ');
  151.    DateError: array[1..6] of string[60] = 
  152.    (' The date you entered is invalid. ',
  153.     ' Enter a date in the format:',
  154.     ' The date you entered is too early. ',
  155.     ' The earliest acceptable date is: ',
  156.     ' The date you entered is too late. ',
  157.     ' The latest acceptable date is: ');
  158.  
  159. NumberError is an array of strings with two elements. These two elements
  160. represent the text that is displayed if an out-of-range value is
  161. entered in an IO field. 
  162.  
  163. DateError is an array of strings with six elements. This array includes
  164. three pairs of strings which represent the various messages which are 
  165. displayed when an invalid or out-of-range date is entered in a date field.
  166.  
  167. Similarly, the totLINK unit includes the following declaration:
  168.   Const
  169.   NoFiles: string[20] = 'No Files';
  170.  
  171. The text is displayed in directory listings when no file is found.
  172.  
  173. You may customize these messages as necessary.
  174.  
  175. Refer to the Toolkit documentation on AlphabetTOT and DateTOT for other
  176. customization considerations.
  177.  
  178.  
  179. 2) ADDITIONS to TOTMISC
  180. =======================
  181. The following procedures and functions have been added to the totMISC
  182. unit, and are not discussed in the manual:
  183.  
  184.   function  DeleteFile(Filename:string): shortint;
  185.        Deletes a file from the disk, and returns a shortint code as
  186.        follows:     -1    File not found
  187.                      0    File deleted
  188.                      1    Error - file not deleted.  
  189.  
  190.   function  RenameFile(Oldname,NewName:string):shortint;
  191.        Renames a file, and returns a shortint code as
  192.        follows:      0 file renamed
  193.                      1 file not found
  194.                      2 rename failed
  195.  
  196.   function  ValidFileName(FN:string): shortint;
  197.        Checks a fully qualified filename to see if it is valid, and
  198.        returns a shortint code as follows: 
  199.           -1     Path and name OK but file does not exist
  200.            0     Path and name OK and file exists
  201.            1     Illegal drive specifier
  202.            2     Illegal characters in path
  203.            3     Invalid Path
  204.            4     No file specified
  205.            5     Illegal Characters in name
  206.            6     Name longer than eight characters
  207.            7     Extension longer than three characters
  208.  
  209.   function  ParamLine: String;
  210.        Returns a string identifying all the items that were typed on
  211.        the command line after the program name. Each item is separated by
  212.        a single space, i.e. ' '.
  213.  
  214.   function  ParamVal(Marker:string): string;
  215.        Searches the parameters (typed when the program was executed) for
  216.        'Marker' and returns the item following.
  217.  
  218.   function  Frequency(Match:string;Source:string): byte;
  219.        Returns the number of occurences of match in Source.
  220.  
  221.   procedure ResetStartUpMode;
  222.        Sets the display mode and cursor style to the setting that was
  223.        active when the program was first executed.
  224.  
  225. The remaining three functions are used to run child programs, but remember to
  226. use the $M compiler directive to leave some memory for the child process.
  227. Refer to the demo files DEMEX1-2 for more information. All three functions
  228. return the Turbo Pascal DOSERROR code generated when the command was 
  229. executed.
  230.  
  231.   function  RunAnything(Command: string):integer;
  232.       Runs any DOS command or file with a BAT, COM or EXE extension, just
  233.       as though you had typed the command at DOS. This function uses a
  234.       secondary copy of COMMAND.COM.
  235.  
  236.   function  RunEXECOM(Progname, Params: string):integer;
  237.       Runs any EXE or COM program without needing a second installation
  238.       of COMMAND.COM. Progname is the name of the program, and Params is a
  239.       string representing the passed parameters.
  240.  
  241.   function  RunDOS(Msg:string):integer;
  242.       Drops the user to the DOS prompt. The user returns to the program
  243.       by typing EXIT. The Msg string parameter will be displayed as the
  244.       user is dropped to DOS. Normally, you should save the screen before
  245.       calling this function, and restore the screen when the user returns.
  246.  
  247. 3) Key Constants
  248. ================
  249.   A new unit, totKEY, has been included in the Toolkit. This unit includes
  250.   a set of global constants which represent the various keys which are
  251.   recognized by the Toolkit. All the constants begin with the letter k, and
  252.   may be followed by Alt, Ctl or Sft (for Alt, Ctrl and shift) as appropriate.
  253.   
  254.   For example, if you use totKEY in your program, you can use kF1 instead
  255.   of 315. Whilst easy to use, this unit does use some memory, and if
  256.   you are tight on memory, you may want to use 315!
  257.  
  258.              +--------------------------------------------------+
  259.              |  P a r t   4    -    N o r t o n   G u i d e s   |
  260.              +--------------------------------------------------+
  261.  
  262. If you have a copy of the Norton Guides On-Line database engine, you are 
  263. in luck. The Toolkit inludes file TOT.NG is a Norton Help Guide to the 
  264. Toolkit. If you own the Norton Guides, you can use TOT.NG to provide you with 
  265. a degree of on-line help. If you don't own the Norton Guides, don't buy it 
  266. just to use TOT.NG, you're not missing that much!! 
  267.  
  268.           +--------------------------------------------------------+
  269.           |  P a r t   5    -    F i l e s  o n   t h e   D i s k  |
  270.           +--------------------------------------------------------+
  271.  
  272. The following files are included in the Toolkit:
  273.  
  274. Source Files:
  275.  
  276.              EXTFAST  PAS        Extensions to totFAST
  277.              EXTIO    PAS        Extensions to totIO
  278.              EXTLINK  PAS        Extensions to totLINK
  279.              EXTWIN   PAS        Extensions to totWIN
  280.              TOTBUILD PAS        Program for building all units
  281.              TOTDATE  PAS        Date management
  282.              TOTDIR   PAS        Directory display and file selection
  283.              TOTFAST  ASM        Assembly module for screen writing
  284.              TOTFAST  OBJ        Object file for TOTFAST.ASM
  285.              TOTFAST  PAS        Screen writing 
  286.              TOTFLAGS INC        Conditional defines and compiler directives
  287.              TOTINPUT PAS        Keyboard and mouse control
  288.              TOTIO1   PAS        Input objects
  289.              TOTIO2   PAS        Input objects
  290.              TOTIO2   INC        Input objects
  291.              TOTIO3   PAS        Input objects
  292.              TOTKEY   PAS        Key constants 
  293.              TOTLINK  PAS        Linked list manager
  294.              TOTLIST  PAS        Browse and list windows
  295.              TOTLOOK  PAS        Controls overall color defaults
  296.              TOTMENU  PAS        Menus
  297.              TOTMENU  INC        Menus
  298.              TOTMISC  PAS        Miscellaneous procedures and functions
  299.              TOTMSG   PAS        Message windows
  300.              TOTREAL  PAS        Real type declarations
  301.              TOTSTR   PAS        String manipulation
  302.              TOTSYS   PAS        Hardware 
  303.              TOTWIN   PAS        Window management
  304.  
  305. Demonstration Files
  306.  
  307.              TOTDEMO  PAS        The main show-off demo program
  308.              DEMXXXX  PAS        Smaller demo programs (see section 2 above)
  309.              DEMXXXX  TXT,DBF    Resource files used by demo programs
  310.              EXTDEMX  PAS        Extending the Toolkit demos
  311.  
  312. Documentation Files
  313.  
  314.              XXXXXXX  TXT        On-disk documentation (see section 7 below)
  315.  
  316. Miscellaneous Files
  317.    
  318.              INSTALL  EXE       The Toolkit installation program
  319.              OVERLAY  DOC       Unit Dependencies for Overlay Initialization
  320.              README   COM       This file!
  321.              REGISTER DOC       Registration data for Toolkit evaluators
  322.              VENDOR   DOC       Instructions and restrictions for ShareWare
  323.                                 vendors.
  324.  
  325.  
  326.               +-----------------------------------------+
  327.               |  P a r t   6    -    S H A R E W A R E  |
  328.               +-----------------------------------------+
  329.  
  330.                     HERE'S HOW SHAREWARE WORKS:
  331.  
  332. You are encouraged to copy the TOT diskettes and share them freely with
  333. others. You have the luxury of trying out the complete programs, at your own
  334. pace and in the comfort of your own home or workplace. This is not a crippled
  335. or demo copy, but the complete working version of the program.
  336.  
  337. After you have used TOT for a reasonable evaluation period (not to exceed
  338. 90 days) you must either stop using it or buy a licensed copy from TechnoJock
  339. Software, Inc. or from an authorized dealer. The file REGISTER.DOC includes
  340. all the information you need to buy the Toolkit. If you cannot find the file,
  341. or if you have any questions, don't hestitate to call or write to:
  342.  
  343.                       TechnoJock Software, Inc.
  344.                       PO Box 820927
  345.                       Houston TX 77282
  346.                       USA
  347.  
  348.                       Voice (713) 493-6354
  349.                       Fax   (713) 493-5872
  350.  
  351.                       Compuserve 74017,227
  352.                       MCI Mail   TECHNOJOCK
  353.  
  354.  
  355. Why pay at all?
  356. ----------------------------------------------------------------------
  357.    *  You receive the most CURRENT copy of the program
  358.    *  You receive the printed manuals (typeset and bound) and Quick Reference
  359.    *  Notification of updates and new products
  360.    *  Your input and ideas help shape future products
  361.    *  A sense of pride and ownership, by having honestly participated
  362.       in the Shareware revolution
  363.    *  The satisfaction of helping to keep software prices down, by supporting
  364.       a distribution method which doesn't depend on expensive advertising
  365.       campaigns
  366.  
  367. So please dive in and enjoy the fun of legally sharing good software with
  368. your friends and associates. The following restrictions are designed to
  369. protect the community of Shareware users and to prevent others from taking
  370. unfair advantage of the trust, hard work and good will of Shareware authors.
  371. Exceptions to these conditions must be received in writing from TechnoJock
  372. Software, Inc.
  373.  
  374.                   +-----------------------------+
  375.                   |  DISTRIBUTION RESTRICTIONS  |
  376.                   +-----------------------------+
  377.  
  378. 1. Disk vendors (those who sell Shareware disks for a profit) must follow
  379.    the procedure outlined in the "VENDOR.DOC" file.
  380. 2. You may not charge more than $6 U.S. per diskette.
  381. 3. The files and programs on the disks may not be modified or deleted.
  382. 4. The programs cannot be sold as part of some other more inclusive package.
  383. 5. The programs cannot be rented or leased to others.
  384. 6. When distributed via a telecommunications link, all TechnoJock programs
  385.    (and documentation files) must be transferred in a library or archive
  386.    format. This means that all the files on each TechnoJock disk must be
  387.    combined into one file - one file for each TechnoJock disk.
  388.  
  389.  
  390. If you are distributing the files on a BBS, then the following four
  391. archive files must be available :
  392.  
  393.                   TOTSRC  - Source code files, REGISTER.DOC and README
  394.                   TOTDOC  - Documentation files
  395.                   TOTDEM  - Demonstration files
  396.                   TOTNG   - Norton Guides file
  397.  
  398.  
  399.        +-----------------------------------------------------------+
  400.        |  P a r t  7   -    P R I N T I N G   T H E   M A N U A L  |
  401.        +-----------------------------------------------------------+
  402.  
  403. If you did not purchase TOT (complete with printed manual) directly
  404. from TechnoJock Software, Inc., or from an authorized dealer, then you are 
  405. evaluating the program.
  406.  
  407. We have tried to provide you with everything necessary to evaluate TOT,
  408. including all the documentation, demo programs and source code. All the 
  409. documentation files have a TXT extension and the following files are
  410. provided:
  411.  
  412.      Filename          Description
  413.      ------------      -------------------------------------------
  414.      INFO     TXT      A brief description of the on-disk documentation
  415.  
  416. Part 1 - User's Guide
  417.      CHAPT1   TXT      Chapter 1     Introduction
  418.      CHAPT2   TXT      Chapter 2     Getting Started
  419.      CHAPT3   TXT      Chapter 3     Toolkit Basics
  420.      CHAPT4   TXT      Chapter 4     Determining & Controlling Hardware
  421.      CHAPT5   TXT      Chapter 5     Writing to the Screen
  422.      CHAPT6   TXT      Chapter 6     Keyboard & Mouse Input
  423.      CHAPT7   TXT      Chapter 7     Using Windows
  424.      CHAPT8   TXT      Chapter 8     Displaying Messages and Prompts
  425.      CHAPT9   TXT      Chapter 9     Managing Lists
  426.      CHAPT10  TXT      Chapter 10    Displaying Directories
  427.      CHAPT11  TXT      Chapter 11    Controlling User Input
  428.      CHAPT12  TXT      Chapter 12    Menus Menus Menus
  429.      CHAPT13  TXT      Chapter 13    Managing Dates
  430.      CHAPT14  TXT      Chapter 14    String Handling
  431.      CHAPT15  TXT      Chapter 15    Miscellaneous
  432.                                      
  433. Part 2 - Extending the Toolkit       
  434.      CHAPT16  TXT      Chapter 16    OOP Principles
  435.      CHAPT17  TXT      Chapter 17    Replacing The Screen Writer
  436.      CHAPT18  TXT      Chapter 18    Extending Windows
  437.      CHAPT19  TXT      Chapter 19    Customizing Linked Lists
  438.      CHAPT20  TXT      Chapter 20    Extending Input Field Types
  439.  
  440. Part 3 - Flash Cards
  441.      FLASH    TXT      A Not-Too-Quick Reference
  442.  
  443. Remember there is no substitute for the bound manuals which include
  444. multiple indexes, screen shots and diagrams, and a quick reference. 
  445. Each TXT file represents a chapter of the User's manual or Flash Cards. Each 
  446. file includes running headers, and there is an embedded formfeed character 
  447. at least every 60 lines. To print the documentation you can copy each file
  448. to the printer using the syntax
  449.  
  450.                COPY file.TXT PRN
  451.  
  452. or you can import the file into your word processor. Just have a lot of paper 
  453. ready!!
  454.  
  455.  
  456.  
  457.     +-----------------------------------------------------------------+
  458.     |  P a r t  8   -    I n s t a l l i n g   t h e   T o o l k i t  |
  459.     +-----------------------------------------------------------------+
  460.  
  461. Refer to the beginning of Chapter 2 - Getting Started for a description
  462. of how to install the Toolkit.
  463.  
  464.  
  465.        +------------------------------------------------------------+
  466.        |  P a r t  9   -    Association of Shareware Professionals  |
  467.        +------------------------------------------------------------+
  468.  
  469.                           _______
  470.                      ____|__     |                  (R)
  471.                   --|       |    |-------------------
  472.                     |   ____|__  |  Association of
  473.                     |  |       |_|  Shareware
  474.                     |__|   o   |    Professionals
  475.                   -----|   |   |---------------------
  476.                        |___|___|    MEMBER
  477.  
  478.  
  479. Bob Ainsbury, VP Software Development at TechnoJock Software, Inc., is a 
  480. member of the Association of Shareware  Professionals (ASP). ASP wants to 
  481. make sure that the shareware principle works for you. If you are unable to 
  482. resolve a shareware-related problem with an ASP member by contacting the 
  483. member directly, ASP may be able to help. The ASP Ombudsman can help you 
  484. resolve a dispute or problem with an ASP member, but does not provide 
  485. technical support for members' products. Please write to the ASP Ombudsman 
  486. at 545 Grover Road, Muskegon, MI 49442 or send a Compuserve message via 
  487. easyplex to ASP Ombudsman 70007,3536.
  488.  
  489.  
  490.  
  491.                           That's All, Folks!
  492.