OVERVIEW

The TXS (Text Search) Program is used to create economic indexes on

static text files, and search these indexes using smart logic search

criteras.

The TXS sytem uses fast existential dictionaries to save space, and allow

fast searchs. These dictionaries are indexes that even the key of the

entry is not saved, but only hash function entries are stored in a

dictionary to indicate existance of a key.

Choose one of the following items for further information :

 Operation

 Terminology

 Contact

 Credits


OPERATION

To choose options of the TXS program :

Use the F10 key, (or point the mouse entry on the top line of the desktop,

and press the left mouse button) to open a menu from the menu line.

Use the arrows keys, and Entry key, (or move the mouse pointer while the

left button is pressed, and release when done) to choose and execute

a menu entry.

The main menu has the following menus :

 System - can be opened by pressing ALT-S.

 Files - can be opened by pressing ALT-F.

 Query - can be opened by pressing ALT-Q.

 Exclude - can be opened by pressing ALT-E.

 Help - can be opened by pressing ALT-H.


CONTACT

If you want to register the TXS program

  Please contact :

  ISoft D&M,

  P.O.B 5517

  Coralville IA 52241,

  U.S.A

To contact the author directly please write to :

  Loewy Ron,

  9 Haneveem St.

  Herzeliya 46465,

  ISRAEL


CREDITS

Credits :

  TXS was written using Turbo-Pascal 6.0 (Copyright - Borland International).

  E.T. Floyd wrote the DDJ published DICT unit, I used the ideas in this unit

  to create TXS, and was helped by the published source code, but My dictionary

  uses different hash algorithm. ( I saw that in DDJ Jan. 1991 MR. Floyd

  answered a letter regarding the hash algorithm. ), I removed some of the

  code I did not need from the DICT unit, and added the ability to remove

  keys from the dictionary.

  4DOS, and SHELL2E are copyrights of J.P. Software.

  DESQview is a copyright of Quarterdeck Office Systems.

  Windows is a copyright of Microsoft corp.

  NORTON COMMANDER is a copyright of SYMANTEC corp.

  Noa Nitzan helped me to pick the color selection for TXS (as well as APP),

  and I'm thankful for her help.

  Version 1.2 implemented a real-time clock that was rewritten in assembly

  from an idea I received after looking at a TP code written by Stefan

  Tritscher.

  Version 1.2 implemeted the enhanced cmdWin command log after looking in the

  assembly code supplied with execws 1.5 from Turbo Power and applying it

  to my INT2E interface .

  Roby Gilad showed me the bug about font-size detected on some VGA screens,

  and offered the mathematic logic substitution operators that were added on

  version 2.0

  Any products mentioned are copyrights, or trademarks of their respective

  owners.


TERMINOLOGY

The following Terms are used in the TXS program :

 Dictionary

 Search/Query

 Logic Expression

 Exclude words


DICTIONARY

The term Dictionary has the following meaning in the TXS program :

A dictionary is an index (built using existential dictionaries) that is

defined on a set of static text files. A dictionary description is

saved in a dictionary definition configuration file.

Choose the following Menu options to perform the following actions :

 System|New - to create a new dictionary.

 System|Stats - to display current dictionary statistics.

 Files|Add - to add a new file to the dictionary.

 Files|Remove - to remove a file from the dictionary.

 Files|Display - to display files from the dictionary.

 Query|Query Log - to query the dictionary.

 Exclude|New - to start a new exclude index for dictionary.

 Exclude|Add Words - to add word to the exclude index of the dictionary.

 Exclude|Rebuild - to Re-build the exclude index from a text file.


EXCLUDEMENU

The Exclude menu of the TXS is used to define an exclude Words

list to the current active dictionary.

Open this menu from the main menu, and choose one of the following

options :

 New - to start a new exclude index to the dictionary.

 Add Words - to add words to the exclude index.

 Rebuild - to rebuild the exclude index from a text file.

Menu Activation key : ALT-E.


EXCLUDENEWOPTION

Use this menu option to start a new index of exclude words for the

current dictionary. This option deletes the previous exclude index

and starts a new one.

To Reach this option :

 Exclude|New

Related information :

 Exclude Menu

 Exclude|Add Words

 Exclude|Rebuild


EXCLUDEADDWORDSOPTION

Use this menu option to add exclude words to the current

dictionary exclude index.

This option updates the exclude index of the dictionary.

To Reach this option :

 Exclude|Add Words

Related information :

 Exclude Menu

 Exclude|New

 Exclude|Rebuild


EXCLUDEREBUILDOPTION

Use this menu option to Re-Build the exclude words index of the

current dictionary from a text file that contains a list of exclude

words.

This text file must have only one word on every line, and have the name

of the current dictionary with the suffix .EXL (e.g. TXSDEF.EXL)

To reach this option :

 Exclude|Rebuild

Related information :

 Exclude Menu

 Exclude|New

 Exclude|Add Words


EXCLUDEWORDS

The term Exclude Words is used in the TXS program to describe a set

of words that are defined as words that are assumed to exist in all

the text files indexed by the dictionary. The search algorithm checks

for the existance of a word in a particular file of the dictionary by checking

if the word is in the exclude word index, if it is the algorithm returns

True for this word's existance in the file, otherwise the algorithm

calculates the hash value and checks in the dictionary index files.

Choose the following Menu options to perform the following actions :

 Exclude|New - to create a new exclude index for the dictionary.

 Exclude|Add Words - to add words to the exclude index.

 Exclude|Rebuild - to Re-build the exlude index from a text file.


FILESADDOPTION

Use this menu option to add new file(s) to the current dictionary,

you will be given a prompt screen in which the name of the file to

be indexed and added to the dictionary, should be written.

The TXS program will scan this file, and update the index files

and dictionary configuration files to include information about the

words in this file.

To reach this option :

 Files|Add

Related information :

 Files Menu

 Files|Remove

 Files|Display

 Files|Print


FILESREMOVEOPTION

Use this menu option to remove file(s) from the current dictionary,

A list of the current files that are indexed in the dictionary, from which

you will be able to choose the files you want to remove from the

dictionary.

The TXS program will scan the file, remove the hash entries

from the dictionary, and delete the files entries in the dictionary

definition configuration file.

To reach this option :

 Files|Remove

Related information :

 Files Menu

 Files|Add

 Files|Display

 Files|Print


FILESPRINTOPTION

Use this menu option to format and print file(s) from the current dictionary,

A list of the current files that are indexed in the dictionary, from which

you will be able to choose the files you want to print from the

dictionary.

The TXS program will scan the file, and format it with

the options you specify from the prompt screen.

To reach this option :

 Files|Print

Related information :

 Files Menu

 Files|Add

 Files|Display

 Files|Remove


FILESDISPLAYOPTION

Use this menu option to display file(s) from the current dictionary,

in a browse text window. A list of the files indexed in the dictionary will

be displayed, from which you will be able to choose the files to display.

The browse window files can be viewed, and searched using the System|Find

menu option.

Reach this option using

 Files|Display

Related information :

 Files Menu

 Files|Add

 Files|Remove

 Files|Print


FILESMENU

The Files menu of the TXS is used to manage the files indexed

by the current dictionary.

Open this menu from the main menu, and choose one of the

following options :

 Files|Add - to add files to the dictionary.

 Files|Remove - to remove files from the dictionary.

 Files|Display - to display files indexed in the dictionary.

 Files|Print - to print files indexed in the dictionary.

Menu Activation key : ALT-F.


HELPMENU

The Help menu of the TXS is used to provide hyper-text help to

the TXS system. Choose one of the options in this menu to recieve

detailed help on the option chosen.

In the help window opened, you can choose Links (hi-lighted word) that

will display the word that is hi-lighted. Links appear in a different

color then the back ground and text color. The active (current) link

is hi-lighted in RED.

Choose the active link, from the possible links by using the Tab and

Shift-Tab key.

Open this menu from the main menu, and choose one of the following

options :

 Overview

 Terminology

 Operation

 Help

Menu Activation key : ALT-H.


LOGICEXPR

The queries understood by the query window

in the TXS are the form :

  [NOT] search-word-1 [AND | OR | XOR [NOT] search-word-2 [AND | ...]]

  Some examples will clarify the definition :

 RON and not landmark                   - will print all of the files that

                                          contain the word RON, but do not

                                          contain the word LANDMARK.

 JOG or DIE                             - will print all the files that

                                          contain the word JOG, or the

                                          word DIE, or both of them.

 JOG xor DIE                            - All of the files that contain

                                          either one of the words DIE or JOG,

                                          but not both of them.

  Some points to consider :

  TXS does not make a difference between upper and lower case letters. -

 lanDmark, LANDMARK, landMArK and landmark are all the same.

  TXS define a word - any set of characters ['a'..'z', 'A'..'Z'].

  Operator precedence   : NOT, AND, XOR, OR.

  Over-riding operator precedence - using the () notation :

 Joe and Mark or Jehoshaphat

  is the same as : (Joe and Mark) or Jehoshaphat,  but

 Joe and (Mark or Jehoshaphat)

  is different, and will yield different results.

  Operator substitution : NOT = , AND = *, XOR = @, OR = +

  Joe AND Mark                          is the same as

  Joe * Mark

  Mark XOR (Joe OR Jill AND NOT Ben)    is the same as

  Mark @ (Joe + Jill * not Ben)           and as

  Mark @ (Joe OR Jill AND NOT Ben)


QUERYQUERYLOGOPTION

Use this menu option to bring one of the open query windows

to the top of the TXS desktop.

In the query window you can enter a logic expression to initiate

a search on the current dictionary.

To Reach this option :

 Query|Query Log

Related information :

 Query Menu

 Query|Open Log


QUERYOPENLOGOPTION

Use this menu option to open a new query window on the top of the TXS

program desktop.

This window can be used to enter a logic expression to initiate

a search on the current dictionary.

To Reach this option :

 Query|Open Log

Related information :

 Query Menu

 Query|Query Log


QUERYMENU

The Query menu of the TXS is used to open Query windows,

and perform searchs using Logic Expressions on the current

dictionary.

Open this menu from the main menu, and choose one of the following

options :

 Query|Open Log

 Query|Query Log

Activation key for this menu is : ALT-Q.


SEARCH

The Term Search (Query) is defined in the TXS program as a pass

that is performed on the dictionary index, and testing for each

file in the index, if the logic expression defined

in the query results in an exist (match), or not.

To initiate a search refer to the following information :

 Query Menu

 Query|Open Log

 Query|Query Log


SYSTEMFINDOPTION

Use this menu option to find a word in a browse window that

is the active window on the top of the TXS program desktop.

You will be asked for a word to find, and TXS will search for the word in the

file, and if it exists, will scroll the window to this word.

To reach this option :

 System|Find

Related information :

 System Menu


SYSTEMMENU

The System menu of the TXS is used to manage the the entire

TXS working environment.

Open this menu from the main menu, and choose one of the

following options :

 System|Path - to set the working directory.

 System|Directory - to browse a directory list.

 System|New - to start a new dictionary.

 System|About - to display TXS logo, and contact information.

 System|Command - to open a dos command window.

 System|Stats - to display information on the current dictionary.

 System|Find - to find a text in a browse window.

 System|Options - to set global TXS options.

 System|Quit - to leave the TXS program.

Activation key for this menu is : ALT-S.


SYSTEMABOUTOPTION

The About menu option is used to display the TXS program logo

and contact information. Use this option to find the current

version of TX Syou are using.

To reach this option :

 System|About

Related information :

 System Menu


SYSTEMCOMMANDOPTION

The Command and cmdWin options are used to open a dos command box, and

allows the user to initiate dos commands without leaving TXS.

To reach this option :

 System|Command

 System|cmdWin

Related information :

 System Menu

Technical information :

  The command window is a window that offers a text field in which the user

 can enter DOS command lines, and TXS will mimic the shell operation, and

 display the results in the window, however, this feature is very dangerous,

 because DOS is not a reentrant operating system, to use this feature you must

 understand how TXS handles the commands entered at the command line.

  TXS uses the undocumented DOS INT2E to transfer control to the parent OS

 shell, this method was chosen to allow floppy diskettes users use this

 feature without having to put the boot diskette in the boot drive, (otherwise

 we will have to load a secondary shell), this approach, however causes

 difficulties with some of the command shells available. 4DOS for example

 does not normally support INT2E, J.P.Software supplies a free TSR program

 called SHELL2E, to allow 4DOS users to use INT2E, if you use 4DOS,

 get that program, and load it in your AUTOEXEC.BAT file.

  APP uses an old time trick to display the results of the command in the

 window, (assuming the command does not write directly to screen), by

 re-directing the command output to a temporary file, and displaying it. This

 approach restricts you to use some of the normal commands, commands that

 require user response, will not work - unless you know the required

 response by heart.

  This feature is only useful for quick analysis - to list an archives contents,

 to look at the memory list (using mcbList ..), etc.

 (***) - cmdWin - The enhanced command log window - This window was added

         from version 1.7 - this window uses an idea I got from the

         execws unit published by Turbo Power and implemented a similiar

         clip to window to stdout, stdin and stderr by hooking to the

         int 21 vector. Do notice that the code used by me was rewritten

         to hook into my INT2E interface (while execws uses a swap mechanism

         and calls DOS EXEC function). The reason I left both the command

         and cmdWin windows is as follows :

         the cmdWin does not create a temporary file and reads from it, so

         lines that are longer then the current window display are wrapped

         around and not truncated, this can cause a very messy display inside

         that window, however - the cmdWin window will display input requests

         from the user, and wait for responses without the need to remember

         the answers. In cmdWin you can type DIR *.* /P and see the

         "Press any key for more ..", while the normal Command window

         will wait for the key Press without displaying the message !

         - The advantage is that user response is now available through a

         window !


SYSTEMDIRECTORYOPTION

This menu option is used to open a directory list that displays the

files of the current directory in a window. The list can be

scrolled, and you can change directories by pressing enter on a

directory entry.

To reach this option :

 System|Directory

Related information :

 System Menu

 System|Path

 System|Options


SYSTEMNEWOPTION

Use this menu option to start a new dictionary index. The

dictionary files will be created, and you will be able to assign files

and exclude words to the dictionary.

To reach this option :

 System|New

Related information :

 System Menu

 System|Stats


SYSTEMOPTIONSOPTION

Use this menu option to set global TXS options, such as

the directory window sort order, The use of a

dialog directory window vs. a floating directory window, and the use

of 43/50 rows on EGA/VGA screens vs. 25 rows.

To reach this option :

 System|Options

Related information :

 System Menu


SYSTEMPATHOPTION

Use this menu option to change the current working directory. You

will be asked to specify the path, and a change directory command will

be issued by the TXS program.

To reach this option :

 System|Path

Related information :

 System Menu

 System|Directory


SYSTEMQUITOPTION

Use this menu option to leave the TXS program. You will be asked

to confirm that request, Tab to the Exit button and press enter.

If The dictionary you have been working on was changed you will

be asked if you want the changes to be saved or discarded.

To reach this option :

 System|Quit

Related information :

 System Menu


SYSTEMSTATSOPTION

Use this menu entry to display statistics about the current dictionary.

This option specifies the dictionary name, number of files, and keys in

each directory index file.

To reach this option :

 System|Stats

Related information :

 System Menu

 System|New