home *** CD-ROM | disk | FTP | other *** search
/ World of Shareware - Software Farm 2 / wosw_2.zip / wosw_2 / DATABASE / LISST20.ZIP / LISST.DOC next >
Text File  |  1989-02-10  |  24KB  |  453 lines
  1.  
  2.  
  3.  
  4.                                    LiSST
  5.                                  ---------
  6.  
  7.                   version 2.0 (c) 1989 by Sam Bellotto Jr.
  8.  
  9.        "LiSST" IS A MENU-DRIVEN utility that adeptly compiles, 
  10.        maintains and organizes a variety of everyday listings. In 
  11.        addition, the program offers:
  12.  
  13.            * a choice of output to either console, printer or 
  14.              disk
  15.            * sorting that is "The," "An" and "A" exclusive
  16.            * sorting on any field
  17.            * comprehensive record editing, deleting and undeleting.
  18.            * multiple and individual search capability
  19.            * compatibility with most word processors
  20.  
  21.        Only 33k, "LiSST" is the solution to a wide range of record- 
  22.        keeping problems for which more powerful database management 
  23.        systems would be overkill. It can be placed on a single disk, 
  24.        along with dozens of separate listings, and randomly access any 
  25.        or all of them.
  26.  
  27.        Invoking "LiSST:"  You run it like any EXE file, with the 
  28.        added advantage of being able to call up any listing directly 
  29.        from the command line. The syntax d:LiSST d:filename is 
  30.        optional. If employed, "LiSST" displays the Main Menu with 
  31.        the named listing loaded. Otherwise, you will initially be 
  32.        prompted for "Name of list?" Enter the name of any existing 
  33.        list or, enter the name of a file you wish to create. Use the 
  34.        standard DOS convention d:filename.  "LiSST" doesn't 
  35.        require a file extension. All of its lists are given an 
  36.        extension of LST, and those are the only files that "LiSST" 
  37.        recognizes. In fact, if you inadvertently enter, for example, 
  38.        MYFILE.TXT or B:MEMBERS.DBF at "LiSST's" prompt (or in the 
  39.        command line), the program disregards the incorrect extension 
  40.        and either opens or creates MYFILE.LST or B:MEMBERS.LST. Note: 
  41.        if "LiSST" is unable to locate a list, a new one is created.
  42.  
  43.        "LiSST" utilizes the top line of the computer screen as its 
  44.        Status Line. Information always available on this line includes 
  45.        the particular menu selection in current use, the name of the 
  46.        list being accessed and, depending upon which program mode is 
  47.        functioning, record count, printer/console/disk output 
  48.        assignment, or operational prompts.
  49.  
  50.        This is what the screen looks like at the Main Menu:
  51.  
  52.        LiSST   Relational Listmaker    [B:MYFILMS.LST]  #0000 vers 2.0
  53.  
  54.             Get List           F1-Delete             F6-Copy List
  55.             Input              F2-Undelete           F7-Rename List
  56.             Edit               F3-Change             F8-Erase List
  57.             Sort               F4-Labels             F9-List Lists
  58.             Output             F5-ASCII              F10-Quit
  59.  
  60.                                     Select?
  61.  
  62.        Menu selections on the left are considered ordinary functions. 
  63.        Choose them by entering the initial letter (upper or lower 
  64.        case). Menu selections in the center are special features and 
  65.        can be called by striking the function key shown. (In 
  66.        other words, entering F4 runs the "Labels" option.  Menu
  67.        selections on the right are DOS functions, also initiated with 
  68.        function keys.
  69.  
  70.        The question mark is "LiSST's" prompt. Enter an initial 
  71.        letter or function key to select an option. To Get a List (either 
  72.        another existing list or create a new one), enter "G" or "L" at 
  73.        the prompt. Similarly, to Quit, enter F10.
  74.  
  75.        CREATE:  To create a new listing, simply enter a name for the 
  76.        new file in the command line or in response to the "Name of 
  77.        list?" startup prompt. Again, no extension is required. But if 
  78.        you provide one that is not LST, the program will change it. 
  79.        "LiSST" displays "New list ...."  to inform you that it is 
  80.        creating a list and displays the new filename in the Status 
  81.        Line along with an indication that you are in CREATE mode.
  82.  
  83.        Now select the parameters for the list, the structure of which 
  84.        will be written to a disk file. Enter "Field 1 heading?," 
  85.        "Field 1 length?," "Field 2 heading?" ... and so on, until you 
  86.        have established all the fields for a typical record, or a 
  87.        maximum 79 character line, whichever comes first. "LiSST's" 
  88.        largest record length is 79 bytes, which should be more than 
  89.        adequate for ordinary listings. Individual fields within a 
  90.        record can vary, so long as the aggregate length of all fields 
  91.        does not exceed 79.
  92.  
  93.        "LiSST" helps keep track of the number of characters used by 
  94.        echoing the tally, field after field, to the Status Line. The 
  95.        program "builds-in" one character of space to separate each 
  96.        field column: you needn't do this. Furthermore, the program 
  97.        won't accept a field length if it brings the total above the 79 
  98.        character limit. (Note: field headings should be no longer than 
  99.        their respective field lengths, otherwise "LiSST" truncates 
  100.        any field heading to fit the established size for its field.)
  101.        The maximum number of fields per record has been fixed at 9. It 
  102.        is not recommended that this limitation be exceeded. Creating 
  103.        lists with more than 9 fields will likely cause the program to 
  104.        crash.
  105.  
  106.        When the character total reaches 78 or 79 "LiSST" signals 
  107.        this with "max len!" in the Status Line and halts CREATE. 
  108.        Otherwise, when all field headings and sizes have been entered, 
  109.        you can halt CREATE simply by hitting <enter> at the next 
  110.        "field heading" prompt. ("LiSST" halts CREATE at 78 as well 
  111.        as 79 chars because of the extra space byte the program appends 
  112.        to each field. This makes the minimum field size, in actuality, 
  113.        two characters long.)
  114.  
  115.        How to Abort from CREATE:  Should an unintentional "Name of 
  116.        list?" response take you into CREATE mode, or you decide after 
  117.        the fact that you really don't want to create a new list,
  118.        <enter> at the VERY FIRST Field heading? prompt will return you to 
  119.        "Name of list?" without opening a new listing. A second 
  120.        <enter> will boot out of "LiSST" altogether.
  121.  
  122.        After establishing the field heads and sizes for a new listing, 
  123.        and hitting <enter> to quit (or reaching the maximum character 
  124.        length), "LiSST" inquires "Input data now?" Answer 'Y' and 
  125.        "LiSST" switches to INPUT mode. Typing <enter> or any other key 
  126.        signifies "no" and the program returns to the Main Menu. (Your 
  127.        newly created file remains quite safe on disk, only empty.)
  128.  
  129.        "LiSST" does not provide a CREATE mode option in the Main 
  130.        Menu per se. The function is accomplished as previously 
  131.        explained: (1) selecting Get List from the menu and, at the 
  132.        "Name of list?" prompt, entering the name of the list to be 
  133.        created; or (2) placing the name of the list to be created in 
  134.        the d:LiSST command line.
  135.  
  136.        INPUT:  Entering data is simple with "LiSST." Select "I" or 
  137.        "i" from the Main Menu. For each new record, all of the field 
  138.        headings are individually prompted on-screen. Again, the 
  139.        program rejects any input larger than the established field 
  140.        length. After data has been entered for each field in a single 
  141.        record, the program prompts "OK?" in the Status Line. A 
  142.        response of any key other than "N" or "n" writes the completed 
  143.        record to the file, updates the record count, and proceeds to 
  144.        the next record. A response of "N" or "n" clears the data from 
  145.        the screen, does not write the record to the file, and permits 
  146.        you to re-enter data for that record. [This procedure can be 
  147.        undertaken ad infinitum until you are satisfied with the 
  148.        particular record.]
  149.  
  150.        To exit INPUT, hit <enter> at any field 
  151.        heading prompt. The incompleted record won't be included in the 
  152.        listing.
  153.  
  154.        Note that while inputting data, "LiSST" keeps updating the 
  155.        number of records in the list. The count appears in the upper 
  156.        right side of the Status Line. "LiSST" first tallies the 
  157.        number of records already in the list (whether or not they have 
  158.        been deleted) to the Status Line before it accepts additional 
  159.        entries.
  160.  
  161.        MAKING EMPTY FIELDS:  Oftentimes is is desirable to 
  162.        intentionally leave a field or a field heading blank. You may 
  163.        want to do this in CREATE mode, or in INPUT mode when you don't 
  164.        have any information available for a specific field. But 
  165.        entering <enter> in CREATE mode forces termination of the setup 
  166.        process. Similarly, an <enter> response in INPUT halts data entry.
  167.  
  168.        To get around this, many "LiSST" owners have been using 
  169.        symbols such as "--" or "n/a" as place holders. But this is not 
  170.        necessary! Merely enter one or two spaces with the space bar, 
  171.        followed by <enter>, to produce completely empty fields.
  172.  
  173.        NOTE: If this technique is used in CREATE mode to make a blank 
  174.        field heading, during INPUT mode the field will be prompted as 
  175.        " : ". Also be aware that the standard ASCII sort order places 
  176.        the "space" (20 hex) first.
  177.  
  178.        EDIT:  Complete editing of records either singly or throughout 
  179.        an entire list is possible with "LiSST." In EDIT mode, the 
  180.        program asks "Search for?" Enter a unique character string. The 
  181.        program responds "Searching ... " while it looks for a match to 
  182.        the string. Systematically, you will be prompted with each 
  183.        field by heading and current entry in the located record and 
  184.        asked "Change?" To change, type in a new entry. Otherwise,
  185.        <enter> is interpreted as no change; "LiSST" verifies this by 
  186.        echoing the unchanged entry. Following display of the last 
  187.        field in each record located, you will be asked to "Delete?" If 
  188.        you want the entire record removed from the list, a "Y" answer 
  189.        (plus a carriage return to make accidental erasures more 
  190.        difficult) deletes that record. Hitting <enter> (or 
  191.        any key other than "Y") only implies "no" and the record, with 
  192.        any alterations, if made, is returned to the list. The program 
  193.        displays "Still searching ..." while it looks for other 
  194.        occurrences of the search string. If no other matches are 
  195.        found, the program informs you and loops to "Search for?" 
  196.        Continue editing or exit EDIT mode with <enter>.
  197.  
  198.        The EDIT feature also makes it a snap to do multiple record 
  199.        corrections. At the "Search for?" prompt, enter a character 
  200.        string common to all the records you wish to change and 
  201.        "LiSST" will present each record right down the line. In 
  202.        fact, to edit every record in the list, enter <space><enter> at the 
  203.        "Search for?" prompt. (This latter technique could take a very 
  204.        long time with a large listing, however.)
  205.   
  206.        If no records contain the search string entered, "LiSST" 
  207.        responds with "No records contain [search string]" and pauses 
  208.        briefly before returning to the Main Menu.
  209.  
  210.        SORT:  "LiSST's" sort routine is one of the most powerful 
  211.        implementations of the program. A listing may be sorted on any 
  212.        field. Upon invoking the SORT mode from the Main Menu, you are 
  213.        first prompted for "Sorted file name? " Input d:filename. The 
  214.        LST extension is unnecessary. You are then asked "Sort on?" 
  215.        Reply with the appropriate field heading. You do not have to 
  216.        enter the entire field heading -- enough of the first few 
  217.        letters to make a unique character string will suffice. 
  218.        However, they must be the first few letters or the sort may 
  219.        have unexpected results! (E.g., to sort on the field COMPANY 
  220.        NAME, the string COMPANY, COMP or even CO may do the trick.)
  221.  
  222.        Your original list remains on disk; it is never sorted. This 
  223.        allows the user to create a variety of sorts from the "master" 
  224.        list. Please note that each time a list is sorted, however, a 
  225.        new LST file is created.
  226.  
  227.        When sorting on the first field, "LiSST" employs an 
  228.        algorithm which is "blind" to initial "The," "An" or "A" 
  229.        articles. This makes "LiSST" ideal for cataloging books, 
  230.        films, records, etc. For example, one can enter "The Maltese 
  231.        Falcon," verbatim, without having to corrupt the title to 
  232.        "Maltese Falcon, The." "LiSST" sorts all titles beginning 
  233.        with "The," "An" and "A" at optimum speed and accuracy, 
  234.        provided the first field is the title field. (Most listings of 
  235.        this kind place the title in the first field, anyway.)
  236.  
  237.        "LiSST" incorporates a sort method based upon the well-known 
  238.        Shell Sort, proven to be the fastest routine for lists that are 
  239.        already largely in alphabetical order. Most listings, after 
  240.        all, require significant sorting only once, as re-sorts involve 
  241.        less than 25 percent new entries.
  242.  
  243.        "LiSST" will not initiate a sort if it cannot locate the 
  244.        "Sort on?" input string within any field heading. "LiSST" 
  245.        sorts entirely in RAM memory. This makes the routine extremely 
  246.        fast. However, a listing that is larger than the TPA (transient 
  247.        program area), aborts. But it is anticipated that most lists
  248.        won't overflow the 640k DOS limitation (and LiSSt itself 
  249.        occupies less than 35k of RAM). In the event a list does
  250.        exceed RAM, "LiSST" exits from the sort routine and 
  251.        indicates that the list is "too large for available memory," 
  252.        displaying the record count of the list. [Any listing that is 
  253.        too large for "LiSST" to sort should probably be handled 
  254.        with a more powerful DBMS, like dBase, anyway.]
  255.  
  256.        PLEASE NOTE THAT THIS CONSTRAINT APPLIES ONLY TO "LiSST's" 
  257.        RAM-RESIDENT SORT ROUTINE. Files can be as large as available 
  258.        disk space allows, and be edited, searched and output with no 
  259.        difficulty whatsoever.
  260.  
  261.        OUTPUT: "LiSST" provides three channels to which listings, 
  262.        either totally or selectively, can be output: to the printer, 
  263.        to the console, or to a disk file. In OUTPUT mode, "LiSST" 
  264.        initially prompts "Listing of?" for a particular scope. As in 
  265.        EDIT mode, enter an unambiguous search string common only to 
  266.        the records you want. This string can be in any field or 
  267.        fields. For a complete listing of all records, type <enter> 
  268.        (default for "all.")
  269.  
  270.        "LiSST" next asks "To printer/disk/console?" Reply "P" or 
  271.        "p" if you want a printed listing, "D" or "d" to output to a 
  272.        disk file, or "C," "c" or <enter> for output to screen.
  273.  
  274.        Before printing, you are asked to supply a "Heading of list?" 
  275.        Lists are printed approximately 51 lines per page, with page 
  276.        numbers, margins, and a heading (if given). Field headings for 
  277.        each column are automatically printed; the heading option 
  278.        allows a more general title such as "My Videotape Collection" 
  279.        or "Current Club Members." If no general heading is desired, 
  280.        <enter> defaults to no heading. Finally, "LiSST" asks "Pause 
  281.        between pages?" This facilitates printing to single sheets or 
  282.        printing on both sides of the paper. Answer "Y" to pause, <enter> 
  283.        or any other key to print normally on fanfold paper.
  284.  
  285.        If you selected to output to disk, "LiSST" asks "Disk file 
  286.        name?" Enter d:filename.ext. Output is directed to that disk 
  287.        file. Simultaneously, output is echoed to the screen, allowing 
  288.        the user to see exactly what is being ported to the disk file.
  289.        There are a lot of advantages to disk output. For one, the 
  290.        resulting disk file can be incorporated into any word 
  291.        processing document. The following, sorted by year:
  292.  
  293.          FILM TITLE                               DIRECTOR     YEAR
  294.  
  295.          The Man Who Knew Too Much                Hitchcock    1934
  296.          The Secret Agent                         Hitchcock    1936
  297.          Rebecca                                  Hitchcock    1940
  298.          Suspicion                                Hitchcock    1941
  299.          Lifeboat                                 Hitchcock    1944
  300.          Spellbound                               Hitchcock    1945
  301.          Rope                                     Hitchcock    1948
  302.          Stage Fright                             Hitchcock    1950
  303.          Strangers on a Train                     Hitchcock    1951
  304.          Psycho                                   Hitchcock    1960
  305.  
  306.        was output from a much larger listing, to disk, and pulled into 
  307.        this document with WordStar's ^KR command. (Output to disk in 
  308.        conjunction with "LiSST's" ^ASCII menu option is one way to 
  309.        produce sub-listings sorted on multiple fields.)
  310.  
  311.        If you replied with "C," "c" or <enter> (indicating output to 
  312.        screen) "LiSST" defaults to console output.
  313.  
  314.        During output to both disk and console, "LiSST" sends about 
  315.        21 lines to the screen, pauses and prompts "More?" Striking any 
  316.        key except <end> scrolls another 21 lines, and so on, 
  317.        until "[end of list]" is displayed. At any time, output may be 
  318.        aborted by striking thσ <end> key at the "More?" prompt. Further 
  319.        records will not be output to either screen or disk file and 
  320.        the program will return to the Main Menu.
  321.  
  322.        Incidentally, should you enter an output scope character string 
  323.        that "LiSST" is unable to locate, or if the particular list 
  324.        is empty (which can happen), you will be notified!
  325.  
  326.        LIMITATIONS AND CONSTRAINTS
  327.  
  328.        number of fields per record  ..........................  9
  329.        number of characters per record  .....................  79
  330.        number of records per list  ...................  unlimited
  331.        number of records sorted  .................  RAM dependent
  332.  
  333.        COMMAND SUMMARY FOR ORDINARY OPTIONS
  334.  
  335.  
  336.  
  337.        Startup:    d:LiSST
  338.                    "Name of list?" d:LISTNAME
  339.                    or
  340.                    d:LiSST d:LISTNAME
  341.  
  342.        Create:     "Field [1-8] heading?"  string
  343.                    "Field [1-8] length?"   integer
  344.                    <enter> at any "Field heading?" prompt to quit or
  345.                    until max char length equals 78 or 79.
  346.  
  347.        Input:      "[Field head]:"  string
  348.                    repeats for each field head in record, for each new
  349.                    record.
  350.                    "OK?"  Y/N
  351.                    <enter> at any prompt to quit. Incompleted
  352.                    record is not written to disk.
  353.  
  354.        Edit:       "Search for?"  search string
  355.                    <enter> to quit
  356.                    "[Field head: Entry]"
  357.                    "Change?"  new entry, or <enter>
  358.                    repeats for each field in record, for each record
  359.                    matching search string.
  360.                    "Delete?"  Y or <enter>
  361.                    repeats until end of list
  362.  
  363.        Sort:       "Sorted file name?"  d:filename
  364.                    "Sort on?"  field head start string
  365.                    aborts sort routine if list too large for RAM
  366.  
  367.        Output:     "Listing of?"  search string, <enter> for all
  368.                    "To printer/disk/console?"
  369.                              if P or p
  370.                    "Heading of list?"  optional title or <enter>
  371.                    "Pause between pages?"  Y or <enter>
  372.                              if D or d
  373.                    "Disk file name?"  d:filename.ext
  374.                    creates ascii file
  375.                    "More?"  Y or <end>
  376.                              if C, c or <enter>
  377.                    defaults to console, screen-by-screen output
  378.                    "More?"  Y or <end>
  379.  
  380.        Quit:       F10
  381.  
  382.        USING KWIKLISTS WITH TEXT EDITORS  Lists produced with 
  383.        "LiSST" are binary; however, output to disk from the Main 
  384.        Menu creates ASCII text files which can be accessed with 
  385.        virtually any word processor in non-document mode. Because of 
  386.        this, it is often easier to undertake heavy LST file editing 
  387.        tasks with WordStar or Word Perfect than with "LiSST's" 
  388.        EDIT option. Most word processors' find & replace, tab and 
  389.        macro features make editing very long lists quite uncomplicated 
  390.        and fast. To edit a "LiSST" file with a word processor, keep 
  391.        in mind the following:
  392.  
  393.          (1)  Work with the ASCII disk file output via "LiSST's" 
  394.               OUTPUT mode "D" selection only.
  395.          (2)  Use only non-document mode.
  396.          (3)  Do not add to or subtract from the total length of any
  397.               field in any record.
  398.  
  399.        If you've used the "Change" option to add new field(s): enter 
  400.        data in the new field(s) for two or three records with 
  401.        "LiSST" first. This way, you will have a "guide" in place if 
  402.        you then wish to use a word processor as described in the above 
  403.        method to complete entering data into the new field(s) for the 
  404.        rest of the list.
  405.  
  406.        MULTIPLE LINE LISTINGS  It is possible to get multiple line 
  407.        listings per record with "LiSST." Simply establish one field 
  408.        (on which the full list will be sorted) for a common "key." 
  409.        Then, for however many lines you'd like a record to occupy, 
  410.        give them the same "key" in that field. There are obvious 
  411.        limitations to this technique, but it does work. For example:
  412.  
  413.           Bailey, George   320 Sycamore   Bedford Falls   17
  414.           "            "   Epson Equity   bank officer    17
  415.           Smith, Winston   London         England         18
  416.           "            "   Kaypro 286i    historian       18
  417.  
  418.        and so forth. Get the idea?
  419.  
  420.        SORTING ON MORE THAN ONE FIELD  This is possible; there is some 
  421.        doubt as to whether it is practical. Let's assume you have a 
  422.        large listing of movies that you would like sorted 
  423.        alphabetically, but also by category (e.g., comedy, drama, 
  424.        adventure, sci-fi, documentary). First run a general sort by 
  425.        title for alphabetical order. With "LiSST" outputting To 
  426.        disk, create a text file for each category. Join all the text 
  427.        files together with a text editor, eliminating extra spaces and 
  428.        the column headings. Use the "ASCII" option to convert the 
  429.        combined text files into a new LST file. And there you have it. 
  430.        The list is now sorted by category and in alphabetical order. 
  431.  
  432.        AND THERE'S MORE: This should be enough explanation to get
  433.        you going with the ordinary functions of 'LiSST.' I have
  434.        deliberately left out any reference to the Special Functions
  435.        or the DOS functions. You may well be able to figure those
  436.        out with no documentation at all. Good for you! But whether 
  437.        or not you want additional documentation, if 'LiSST' appeals
  438.        to you, a suggested registration fee of a mere $25 will
  439.        bring you your own pristine copy of LiSST, and a real nice
  440.        instruction manual covering ALL of 'LiSST's' features and
  441.        uses. PLUS, if you act now, you will be entitled to one free
  442.        upgrade!
  443.  
  444.        The 'LiSST' Relational Listmaker System is shareware, and is
  445.        copyright (c) 1989 by Sam Bellotto Jr. If you like it, send
  446.        $25 to
  447.                      Sam Bellotto Jr.
  448.                      45 Rowley Street 
  449.                      Rochester, NY 14607
  450.                      (716) 461-1008
  451.  
  452.                ***********************************************
  453.