Copyright: "Copyright (C) 1992-93-94 Yves Roumazeilles"


ClusterView Introduction
ClusterView Application Help

ClusterView is a program which allows a MS-Windows user to browse through individual files and groups of files (named clusters).

ClusterView has been written by Yves Roumazeilles and is available as shareware. You are invited to read now the user license.

To learn how to use help, press F1.

Basic operations:

file operations

cluster operations

find operations

others

keyboard shortcuts

Copyright information

Requirements


ClusterView Requirements
Requirements

ClusterView is an MS-Windows program. Consequently, it requires a computer which can run Microsoft Windows version 3.0 or higher. This includes the following general conditions:

an 80286, 80386 (or higher level) processor. An 80386 is recommended for MS-Windows version 3.1.

at least 1 megabyte of RAM. 2 megabytes are recommended for better operation.

at least 1 megabyte of free disk space to install ClusterView and its support files. This can be reduced to 500 kilobytes if you really need it, but MS-Windows also needs a minimal free disk space for its normal operation.

a screen monitor compatible with MS-Windows. Most standard screens meet this condition (Hercules, EGA, VGA, most SVGA resolutions, TIGA, etc.); check with your hardware manufacturer or consult the MS-Windows compatibility list provided by Microsoft upon request.

If you want to use the drag and drop facilities of ClusterView, you must run it under MS-Windows version 3.1 (or higher).

For compatibility with MS-Windows NT, you can consider ClusterView as a standard MS-Windows application able to run in the Win31 environment. For further information and for future releases, please consult the author.


New Features in ClusterView
New Features in ClusterView v1.03

New features in version 1.03

Full approximative find is available for first time.

Proportional fonts are correctly handled.

Addition of the + accelerator (Next Document) and - accelerator (Previous Document).

ClusterView now accepts "drag'n drop" on either documents or clusters (based on automatic cluster recognition code).

Addition of an hyphen display preprocessing option for specific OCR text.

Widely improved help file and performance optimizations.

Various bugs where removed, application stability has been improved, more error messages and message boxes where added.

Features in the future releases

History of previous search strings.


Exiting ClusterView

To exit ClusterView, you can select the Exit option in the File menu or the Close option in the System menu.

Either way, in a dialog box, you will have to confirm that you indeed want to exit, and whether you want to save the currently open cluster (if there is one) and whether you want to save the configuration to the initialization file. The proposed default checked options take into account whether there is a need to save anything.

If you accept to save the present configuration, ClusterView will automatically go back to it next time you run it.


Cluster File Format

Cluster files are standard text files with a structure similar to Windows initialization files (see also help about the ClusterView initialization file CLUSTER.INI). However, some sections and entries are used or necessary for such a file to qualify for a Cluster file. Its file format is described here. However, remember that ClusterView is the best tool to generate legal Cluster files (using its create/edit/save capability).

A Cluster file is a special ASCII file that contains entry-value pairs representing run-time options for the applications.

The format of the file is following the general rule:

[section]
entry=value
   ...

Example

The following is the content of an example CLUSTER.INI file as it may be provided on the ClusterView distribution disk.

[Information]

Creator=ClusterView

Description=Any kind of text is welcome here.

Check=OK

[Contents]

Number of files=2

File1=DOC1.TXT

File2=C:\USER\JOHN\DOC2.DOC

Explanation

Each of the entries shown above will be now described.

[Information]	Creator=<string>

This entry is necessary for ClusterView to recognize that this is a Cluster file. The exact <string> is left to application and user choice, but it must not be empty. ClusterView fills it automatically on Cluster creation with the "ClusterView" value or "ClusterView v1.0" (or any other version number) value. Any file not containing this entry is automatically refused as non cluster.

[Information]	Description=<string>

This entry is not necessary for ClusterView to recognize that this is a Cluster file. The <string> value can be any string. It is used as the description string of the Cluster. There is no checking done by ClusterView on this string, but ClusterView let you edit it.

The use of this field is left to the user (or another application) appreciation.

[Information]	Check=<OK|string>

This entry is not necessary for ClusterView to recognize that this is a Cluster file. The value must be different from "OK" if the creator has a reason to believe that the Cluster file format is corrupted for some reason. This may be the consequence of a writing error detected by ClusterView when saving the Cluster. In this case, the value is set to "KO". However, this is not necessarily recognized by tools reading the cluster.

[Contents]	Number of files=<number>

This entry is not necessary for ClusterView to recognize that this is a Cluster file. The value must be a valid integer describing the number of available file entries shown next. ClusterView will accept Cluster files with invalid values there. However, to insure that other applications work well with it, ClusterView fills this field with the correct value when saving a Cluster.

[Contents]	File1=<file_name>

This entry is necessary for ClusterView to recognize that this is a Cluster file. Only empty cluster can have no File1 entry.

The document list of the Cluster is built from the list of File<i> entries. If there are N documents, all entries from File1 to FileN must be present. E.g. for three documents all File1, File2, and File3 entries must be present (even if they are not in numeric order).

The value for a FileX entry must be a valid file name. If it is not, the Cluster cannot be recognized properly.

Note

It is generally considered harmless to build your own Cluster files by hand. However, it is often easier to use the ClusterView application and its Cluster Edit capability.

For more about the Cluster file format, you can have a look at the examples which are on the distribution disk. Often, looking at an example gives you more useful information than any reference documentation. Don't miss the opportunity. It will save you many minutes looking for those silly little problems.

Even more to the point, or if you don't have the examples in the distribution disk you got from your BBS (in case of a partial distribution), you can write clusters using the cluster create/edit/save capability of ClusterView. It will automatically create cluster files which are following the building rules as strictly as possible.


Non-text Files

Non-text files are files which contains not only standard printable characters. They can be data files, non-ASCII files, non-Windows files, etc.


MS-Windows Copyright
MS-Windows

MS-Windows is a trademark of Microsoft Corporation.


Registration Fee
Single User Registration Fee

Yes! We remind you the single user license fee is only a mere 130FF or US$20.


Registering ClusterView

ClusterView is distributed as ShareWare. It is not free or public domain. This means you may copy and distribute it freely but should you find it useful and use it beyond an initial evaluation period of 30 days you are both legally and morally obliged to pay the registration fee or license fee.

Registrations should be sent to the author. Registered users will be sent a registration number and the ClusterView Professionnal edition, and will be informed of upgrades.

Yes, I want to register now!

Yves Roumazeilles - the author	France - No credit cards

Public (Software) Library	US - credit card orders

What you get when registering

This is the important question. Here is the list:

- updated ClusterView application (the latest version anyhow) with single user license.

- an immediate notice when a new release is ready on the market.

- sample Cluster files with sample data.

- a registration number to identify yourself when contacting us.

- support through fax, phone and Email.

- access to our database of bug reports between releases. No release is done while this database contains even a single bug. We do not ship products we know contain bugs. But after shipping, users may discover ugly things in our code, and we trace them while we hunt them.

Remember that you can also ask for source licenses which will include full C++ source code for the Microsoft Foundation Classes, with full resources, definition files (everything you need to rebuild the ClusterView application from scratch). I cannot give more. Well! May be not give, because you pay for it. But, it's a bargain you could discuss with me if you need this.

Acknowledgments

I will be pleased to receive any comments, bugs reports or suggestions for future releases.

I would like to thank the following people whose help has been invaluable during the development of ClusterView:

Christian Lescuyer provided the original idea and a large amount of time for product testing (even in alpha version).

Daniel Missud provided additional ideas and most of the beta testing effort.

Martin Heller for his excellent book "Advanced Windows Programming" published by John Wiley & Sons. This is the most useful book about Windows programming I ever found. If you intend to do Windows programming, you NEED it.

The whole WIN3-L@UICVM.BITNET internet mailing list who provided help when I was stopped in the development process. Not all the subscribers (more than 2000 currently) provided help, but a dozen of them are very proficient and helpful. I can remember and thank Walter Knopf, Yossi Oren, Yoav Chernobroda and Vance Gloster, and many others...


Registration Form - YR
Registration form

Yves Roumazeilles - author

Select "File-Print Topic" from the menu bar to print this form. You will then be able to fill it. You can accompany you order with check. Credit cards are NOT accepted. You can order by phone or fax. But these numbers are for placing an order only!

Please use the form when ordering by mail.

NAME:  __________________________________________

COMPANY:  ______________________________________

ADDRESS:  ______________________________________
                   ______________________________________
                   ______________________________________

TOWN:  __________________________________________

CITY:  ____________________________________________

POSTCODE:  ________  COUNTRY/STATE:  ____________

TELEPHONE: _______________________

FAX:               _______________________

EMAIL:           _______________________

AGrep Search Engine
Single user license ($20 or 130 French Francs)	  ________
Developer kit license ($295 or 1920 French Francs)	  ________

BitList Engine
Single user license ($20 or 130 French Francs)	  ________
Developer kit license ($295 or 1920 French Francs)	  ________

ClusterView Application
Single user license ($20 or 130 French Francs)	  ________

Shipping/Handling to Europe ($4 or 25 French Francs)	  ________

Shipping/Handling outside of Europe ($6 or 40 French Francs)	  ________

==========

Sub-Total....	  ________

European residents, apply VAT/TVA 18.6% (on sub-total)	  ________

==========

Total...........	  ________

Here, shipping/handling costs are applied once even for multiple orders.

Make cheques payable to: Yves Roumazeilles

If you wish to pay in other currencies than French Francs or dollars, apply the normal change rate to French Francs and add a 6% increase to cover the costs my bank charges me. Thank you.

Mail to:

Yves Roumazeilles
63 rue des Moines
75017 PARIS
     (FRANCE)

This address is also the place where you can get information of various kinds (about the status of the shipment of the order, registration options, product details, technical support, volume discounts, dealer pricing, site licenses etc).

Phone: +33-1-42.28.74.51
Fax: +33-1-34.30.53.34
Email: Roumazeilles@sagem.fr


Registration Form - PsL
Registration form

Public (Software) Library - registration service

Select "File-Print Topic" from the menu bar to print this form. You will then be able to fill it.

You can order with MC, Visa, Amex, or Discovery from the Public (Software) Library by callingYou can accompany you order with check. Credit cards are NOT accepted. You can order by phone or fax. But these numbers are for placing an order only!

Please use the form when ordering by mail.

NAME:  __________________________________________

COMPANY:  ______________________________________

ADDRESS:  ______________________________________
                   ______________________________________
                   ______________________________________

TOWN:  __________________________________________

CITY:  ____________________________________________

POSTCODE:  ________  COUNTRY/STATE:  ____________

TELEPHONE:  _______________________

FAX:               _______________________

EMAIL:           _______________________

AGrep Search Engine (item/product #11244)
Single user license ($20)	  ________
Developer kit license ($295)	  ________

BitList Engine (item/product #11245)
Single user license ($20)	  ________
Developer kit license ($295)	  ________

ClusterView Application (item/product #11246)
Single user license ($20)	  ________

Shipping/Handling to Europe ($4)	per license	  ________

Shipping/Handling outside of Europe ($6) per license	  ________

==========

Sub-Total....	  ________

==========

Total...........	  ________

Contact one of the following:

by phone: 800-2424-PsL or 713-524-6394

or by FAX: 713-524-6398

or by CIS Email to 71355,470

or send by mail to:
PsL
P.O. Box 35705
Houston, TX 77235-5705
     (United States of America)

Remember! The above numbers are for orders only. You cannot expect any kind of support through them. If you call there, not only will you be left without an appropriate answer, but I will have to pay for the useless call. PLEASE, if you do not like the long distance calls involved with my address in France, do prefer sending a Fax (it won't hang your phone too long), sending an Internet Email (it won't cost too much, and Compuserve, BIX, AOL all have Internet gateways for your mail - I know you are paying for that, I won't overuse it, but any Email with the product name in its subject field gets a very high priority).

Any questions about the status of the shipment of the order, registration options, product details, technical support, volume discounts, dealer pricing, site licenses etc, must be directed to:

Yves Roumazeilles
63 rue des Moines
75017 PARIS
     (FRANCE)
Phone: +33-1-42.28.74.51
Fax: +33-1-34.30.53.34
Email: Roumazeilles@sagem.fr

To insure that you get the latest version, PsL will notify us the day of your order and we will ship the product directly to you.


Copyright and User License
Application Copyright and User License

The ClusterView application, the AGrep Dynamic Link Library (DLL) and their respective documentations are copyrighted (C) 1992-93-94 by Yves Roumazeilles. Their use is subject to the acceptance of the User License hereafter terms.

All the names used here are trademarks and registered trademarks of their respective owners.

Registration Fee

If you are using ClusterView after the initial 30 day evaluation period, your gift in any amount (165 French Francs or US$30 minimal) is necessary. This payement is named registration fee. Registered users will receive a registration number to remove the shareware notice box. This number will be applicable to any future release of ClusterView.

Please make checks payable in French Francs (or in U.S. dollars) to Yves Roumazeilles. Other currencies require excessive bank charges.

For use by corporations and other institutions, please contact the author for a licensing arrangement. Customizing and other special licensing are available upon request.

If you want to get the full source code of the application or of one of its components, please contact the author for a licensing arrangement.

User License

The program files and the associated documentation (e.g. this documentation) are copyrighted by the author. The copyright owner hereby licenses you to use the software given these restrictions:

*	The program shall be supplied in its original, unmodified form, which includes this documentation.

*	For-profit use without a license is prohibited.

*	The program may not be included - or bundled - with other goods or services. Exception may be granted upon written request only.

*	No fee is charged. An exception is granted for not-for-profit user's group, which are permitted to charge a small fee (under $5) for materials, handling, postage and general costs. No other organization is permitted to charge any amount for distribution of copies of the software or documentation, or to include copies of the software or documentation with sales of their own products.

There is no warranty of any kind (either implied or not). The copyright owner may not be held liable for any damages, including any lost profits or other incidental or consequential damages arising out of or inability to use the software. By using the software, you agree to this.


Author Address

Registration fees can be sent to and the author can be reached at the following address (Email and duly paid registration fee is the preferred interface if you want a prompt answer):

Yves Roumazeilles

63 rue des Moines

75017 PARIS (FRANCE)

Phone: +33 1-42.28.74.51

Email: Yves.Roumazeilles@sagem.fr

For comments, suggestions and bug reports, Email is also available at:

Yves.Roumazeilles@sagem.fr

Roumazeilles@sagem.fr


Shareware description
What is Shareware?

"Shareware" is a way to distribute software while retaining the best of all worlds. People are invited to freely make copies of the software for evaluation purposes (it's cheap distribution). You are both legally and morally obliged to pay the registration fee if you start using the software after an initial 30 day evaluation period (the author gets money from its work). This respects the rights of the author while avoiding burdenning the users with high costs of traditionnal distribution channels.

Shareware is not free, Shareware is not public domain, but Shareware is not expensive.

Remember! The fee is small because the distribution is simple, but the user (YOU) must honestly pay the registration fee. This will allow future releases to hit the market.


File Operations

ClusterView can deal with clusters, but it also accepts any kind of files (even non-text files).

How to...

Open an existing file

Get information about an open file


Opening an Existing File

To open a file:

1	From the File menu, choose Open... .

2	Type or select the filename.

3	Select the OK button.

The document file can be of any kind (text files or non-text files). However, non-text files may be displayed with some characters replaced with the special Û sign.


Getting Information about an Open File

To get the full name, the size (in bytes), the last modification date and time of the currently open file:

1	From the File menu, choose File Info.

2	Select the OK button when finished.

The dialog box displays the requested information. You can close it pressing the OK button.


Cluster Operations

ClusterView is written to handle clusters and documents.

A cluster is a group of files which are handled simultaneously by ClusterView. These files can be shown to the user with ClusterView. You can manipulate them as a group (browsing into them, searching a word into them, etc.)

How to...

Open an existing cluster

Find a text in a cluster

Create a cluster

Modify an existing cluster

Copy an existing cluster

Browse in a cluster


Opening an Existing Cluster

To open a cluster:

1	From the Cluster menu, choose Open... .

2	Type or select the filename.

3	Select the OK button.

The selected file must have the appropriate format for a cluster file or it will be refused and a message box will pop open. The easiest way to create a valid cluster file, is to use the cluster edit capability of the ClusterView application.


Creating a Cluster

To create a cluster

1	First, create an empty cluster choosing New... from the Cluster menu.

2	Second, edit the cluster using the Edit... from the Cluster menu.


Modifying an Existing Cluster

To modify an existing cluster, you first need to open one (see "Opening an existing cluster"). Then, you can modify it, choosing Edit... from the Cluster menu.

The dialog boxe displays the name of the cluster (Cluster Name field - which can be modified directly or using the Save As... button), the description string (Cluster Description field - which may be filled or not, and is modified directly), and the List of Documents.

-	To empty the cluster under scrutiny, choose the New button.

-	To start modifying another cluster, choose the Open... button.

-	To save the modified cluster, choose the Save button (if the Cluster Name is appropriate), or the Save As... button (to change the Cluster Name before saving).

-	To exit the Cluster Edit dialog box, choose the Exit button.

Changing the List of Documents

-	To add one file to the List of Documents, select the position where you want to insert the new file in the List (if the List is empty this step is unnecessary), choose the Add File... button, then select the file in the file dialog box.

-	To remove a file from the List of Documents, select the file to remove in the List, then choose the Remove File button.

-	To move up or down a file in the List of Documents, select it in the List, then choose either the Up button, or the Down button according to your will. The list is immediately updated according to the choice you made.

Related topics

The Cluster menu contains some commands which allow to trigger the equivalent commands shown in the Cluster Edit dialog box. This is most interesting to apply commands to cluster you don't want to modify as when you want to copy a cluster.

See also copying a cluster.


Copying a Cluster

To copy a cluster without modifying its contents:

1	From the Cluster menu, choose Open... .

2	Type or select the filename.

3	Select the OK button.

4	From the Cluster menu, choose Save As... .

5	Type or select the new filename.

6	Select the OK button.

The new cluster will have the same contents (the same document list) as the original cluster, but is stored under a different name.


Browsing in a Cluster

You can browse in a cluster (i.e. jump from one file to another) using one of the four available commands.

Going to the first file

Going to the previous file

Going to the next file

Going to the last file


Going to First File

This allows to jump back to the first file in the document list of the cluster.

This command is available both in the File menu (choose First File) and in the Cluster menu (choose First File).

See also Going to previous file, Going to next file, Going to last file.


Going to Previous File

This allows to jump back to the previous file in the document list of the cluster. Using repetitively this command you can reach the first file of the cluster.

This command is available both in the File menu (choose Previous File) and in the Cluster menu (choose Previous File).

See also Going to first file, Going to next file, Going to last file.


Going to Next File

This allows to jump forth to the next file in the document list of the cluster. Using repetitively this command you can reach the last file of the cluster.

This command is available both in the File menu (choose Next File) and in the Cluster menu (choose Next File).

See also Going to first file, Going to previous file, Going to last file.


Going to Last File

This allows to jump forth to the last file in the document list of the cluster.

This command is available both in the File menu (choose Last File) and in the Cluster menu (choose Last File).

See also Going to first file, Going to previous file, Going to next file.


Find operations
Find/Search Operations

ClusterView is intended to allow easy searching in the documents and the clusters of documents.

How to...

Find a text in a cluster

Fundamentals of text searching with ClusterView


Finding Text in a Cluster

It is possible to use ClusterView to look for a character, word, or group of words (or a specific pattern) into all the files of a cluster. Two basic commands can be used.

To find text

1	Position the window at the place you want to start your search.

2	From the Find menu, choose Find.

3	In the Find dialog box, type the search text.

4	To search the whole cluster (and not only the currently open file), select the Search Whole Cluster check box.

5	To search forward or backward from the cursor position, select the appropriate radio button.

6	To force the search to take into acocunt the exact casing of letters, select the Check Upper/Lower Case button.

7	Select an error level for approximative search (0 is exact search).

7	To start the search operation, choose the OK button.

8	To close the Find dialog box without searching, choose the Cancel button.

For the users who want a command as short as possible, it is also possible to avoid using even the Find menu, and to go to the Find! menu (or to press Ctrl+F).

To search without the Find dialog box

1	Use the Find command, as in the preceeding procedure, to find the first occurence of the search text.

2	To find the next occurrence of the search text, choose Again from the Find menu.

For the users who want a command as short as possible, it is also possible to avoid using even the Find menu, and to go to the Again! menu (or to press F3).

To cancel a search while it is running

If you decide that a long search operation must be cancelled (e.g. when searching something in a very large Cluster), you can press the ESC key. The search is stopped and a message box gives a confirmation of the cancellation.


Fundamentals of Text Searching
Fundamentals of Text Searching in ClusterView

ClusterView is using a specific set of search operation whose fundamentals are most interesting for large search applications as it is often the case with large Clusters of Documents.

It is based on Approximative Search (often called AGREP search)

for more information about these and the AGREP Dynamic Link Library, select the topics in the preceeding paragraph.


Keyboard Shortcuts

The following table shows the keyboard shortcuts and their corresponding menu and options. To help you remember them, the shortcuts are shown on the right part of the pull-down menus (when appropriate).

Shortcut	Menu	Option

Ctrl+F	Find	Find...

Ctrl+N	Cluster	New

Ctrl+O	Cluster	Open...

Ctrl+S	Cluster	Save

F1	Help	Help

F3	Find	Again

-	File	Previous File

+	File	Next File


Mouse Operation

Double clicking on a word, trigger an automatic find forward operation for the word which was under the cursor.


Mouse Options

By choosing the Options menu, then selecting the Mouse... option, you access to a dialog box which allows to specify the exact meaning of the mouse clicks (both single and double). The user may be able to select its preferred operation for the use of the mouse in ClusterView.

The available options are the following:

Find! opens the find dialog box to start finding after selecting a set of options.

Again! search again with the already choosen find options.

(Nothing) no action is associated with this mouse operation.

To modify the associated mouse action, make the convenient set of selections, and choose the OK button.

To exit without changing the options, choose the Cancel button.


AGREP

AGREP is the traditional name for Approximative Search. The notion has been brought to light by Ricardo Baeza-Yates and Gaston H.Gonnet.

The AGrep Search Engine (AGREP.DLL) is the name of a Dynamic Library built for MS-Windows by Yves Roumazeilles and which can be found bundled with some applications like ClusterView.


Approximative Search

The approximative search is allowing you to find a text without knowing the exact form of what you are looking for. For example, you can look for text without taking into account the case of the letters (without making a difference between uppercase and lowercase letters).

The operation is centered on the fact that in most cases you know a text string which is "approximately" what you are looking for in your files. Additionaly, you are able to say that you expect this text string to have a certain number of errors.

For example, the string 'East' is approximately identical to 'West', but there are 2 errors (the first two letters of the words) and 2 matches (the last two letters of both words: 's' and 't').

Basic Operations

Searching for non-cased text


Searching for Approximative Text

AGREP offers to search for text even if the pattern you give is not exactly what you look for (you only have a faint idea of the exact spelling of the text). AGREP allows you to select an error level (the maximum number of errors you can accept when looking for the pattern in the text).

For example, you want the strings to look for are 'EAST', 'CAST' and 'FAST', but the following strings must not be matched: 'WEST', 'EMIT', 'COST'. This can be solved by increasing the number of errors accepted. Just propose the pattern 'EAST' with an error level of 1.

Operation

1	Position the window at the place you want to start your search.

2	From the Find menu, choose Find.

3	In the Find dialog box, type the pattern ('EAST').

4	To search the whole cluster (and not only the currently open file), select the Search Whole Cluster check box.

5	To search forward or backward from the cursor position, select the appropriate radio button.

7	To avoid the program taking into account the difference between upper and lower case letters, unselect the Check Upper/Lower Case button.

6	Ensure that the error level is 1, either by typing this value in the error level window or by selecting it in the pull down menu at the right of the number little window.

7	To avoid the program taking into account the difference between upper and lower case letters, unselect the Check Upper/Lower Case button.

8	To start the search operation, choose the OK button.

9	To close the Find dialog box without searching, choose the Cancel button.

For the users who want a command as short as possible, it is also possible to avoid using even the Find menu, and to go to the Find! menu (or to press Ctrl+F).

To search without the Find dialog box

1	Use the Find command, as in the preceeding procedure, to find the first occurence of the search text.

2	To find the next occurrence of the search text, choose Again from the Find menu.

For the users who want a command as short as possible, it is also possible to avoid using even the Find menu, and to go to the Again! menu (or to press F3).


Searching for Non-Cased Text

AGREP is limited in the maximum number of errors is accepts.

You can overcome this limitations (and use a lower error level) if you know that most of the errors will be in lettercase mismatch between the pattern and the text.

For example, you want to look for the strings 'West', 'WEST' and 'west', but the following strings must not be matched: 'East', 'east', 'EAST'. This cannot be solved by increasing the number of errors accepted. Just propose the pattern 'west' with an error level of 0 and do not check for upper/lower case.

During the search, the program do not take into account differences between an upper case letter ('A') and its lower case equivalent ('a').

Operation

1	Position the window at the place you want to start your search.

2	From the Find menu, choose Find.

3	In the Find dialog box, type the pattern ('west').

4	To search the whole cluster (and not only the currently open file), select the Search Whole Cluster check box.

5	To search forward or backward from the cursor position, select the appropriate radio button.

6	Ensure that the error level is 0.

7	To avoid the program taking into account the difference between upper and lower case letters, unselect the Check Upper/Lower Case button.

8	To start the search operation, choose the OK button.

9	To close the Find dialog box without searching, choose the Cancel button.

For the users who want a command as short as possible, it is also possible to avoid using even the Find menu, and to go to the Find! menu (or to press Ctrl+F).

To search without the Find dialog box

1	Use the Find command, as in the preceeding procedure, to find the first occurence of the search text.

2	To find the next occurrence of the search text, choose Again from the Find menu.

For the users who want a command as short as possible, it is also possible to avoid using even the Find menu, and to go to the Again! menu (or to press F3).


AGREP Limitations

The AGrep Search Engine is limited in both the length of the pattern it can manage and in the maximum number of errors it accepts.

The length of the pattern is limited to 1024 letters maximum.

The number of errors is limited to 1024 maximum.

Both of them are limited by the following formula:

length_of_pattern * (log2(number_of_errors) + 1)  <=  1024

The simple meaning of this formula is that if you have a long pattern, you cannot have a large number of errors. For example, with a 16 character pattern you must limit yourself to 1 error only. In most cases, this is not too limiting, but it should be noticed.

To overcome such a virtual constraint (if it ever becomes an actual constraint) it is also possible to use the non-cased text search fonctionality. As a matter of fact, using very complex patterns is usually limited by the increased compute time needed during the search operation which may become prohibitive with large number of errors.


Initialization File and ClusterView Configuration

The CLUSTER.INI file is used by ClusterView to optimize its operation in various fields.

This is a special ASCII file that contains entry-value pairs representing run-time options for the applications.

The format of the file is following the rule:

[section]
entry=value
   ...

Various sections (and entries in each section) are defined for ClusterView.

Example

The following is the content of an example CLUSTER.INI file as it may be provided on the ClusterView distribution disk.

[ClusterView]

Yield=16

[Font]

Name=Arial

Size=12

[Directories]

Documents Init=C:\usr\cluster

Clusters Init=C:\usr\cluster


Initialization Sections

The definable sections are the following:

[ClusterView]

[Font]

[Directories]

If other sections are defined, they are ignored by ClusterView during its operation.


Initialization Entries

The definable entries (with their corresponding sections) are the following:

Yield	in [ClusterView]

Name	in [Font]

Size	in [Font]

Documents Init	in [Directories]

Clusters Init	in [Directories]

If other entries are defined or if these ones are defined in another section, they are ignored by ClusterView during its operation.


[ClusterView] Section

This section allows to optimize the performance of the ClusterView application in various fields.

The definable entries are:

Yield

If other entries are defined, they are ignored by ClusterView during its operation.


[Font] Section

This section allows to modify the display font which is used by ClusterView when showing the contents of a Document in its main window.

The definable entries are:

Name

Size

If other entries are defined, they are ignored by ClusterView during its operation.


[Directories] Section

This section allows to modify the operation of ClusterView when the application needs to access files on disk.

The definable entries are:

Documents Init

Clusters Init

If other entries are defined, they are ignored by ClusterView during its operation.


Yield Entry
Yield Entry - in [ClusterView] section

When ClusterView is executing a long operation (e.g. a search operation in a whole cluster), it may lock the system until the end of the operation. To reduce the inconvenience, ClusterView tries to allow other MS-Windows application get control of the machine at internally defined times. This is called cooperative multitasking.

The Yield entry allows the user to modify the default yield value in order to increase ClusterView performance (increasing the Yield value) or the MS-Windows performance (decreasing the Yield value).

Minimum value is 1, maximal value is 32767. Default value is 64.

Small values are advisable for systems with low-powered CPU (like an 80286) or with small available memory.

Example

To set the Yield value to a "very cooperative" level:

[ClusterView]
Yield=4

This allows other applications to get access to the processor at very frequent intervals.


Name Entry
Name and Size entries - in [Font] section

When ClusterView displays the contents of a Document in the main window of the application, it uses a specific font which can be customized with these entries.

The Name entry is the alphanumeric name of an existing font (even True-Type fonts are allowed).

The Size entry is the numeric value of the point size of the display font. The allowed values depend on the selected font.

Example

To change the display font to a MS-Windows True-Type font like "Times New Roman" in 12 points:

[Font]
Name=Times New Roman
Size=12


Documents Init Entry
Documents Init Entry - in [Directories] section

When ClusterView opens a dialog box to get access to a Document stored on disk, it uses this entry to select the default directory to search for Documents.

The Documents Init entry must be the alphanumeric name of a valid disk directory.

Default value is the directory where ClusterView was run from.

This entry can be changed at run time (between opening of each dialog box).

Example

To set the default initial directory for Documents to C:\ directory:

[Directories]
Documents Init=C:\

See also

Clusters Init


Clusters Init Entry
Clusters Init Entry - in [Directories] section

When ClusterView opens a dialog box to get access to a Cluster stored on disk, it uses this entry to select the default directory to search for Clusters.

The Clusters Init entry must be the alphanumeric name of a valid disk directory.

Default value is the directory where ClusterView was run from.

This entry can be changed at run time (between opening of each dialog box).

Example

To set the default initial directory for Documents to E:\cluster directory:

[Directories]
Clusters Init=E:\cluster

See also

Documents Init


Other Operations

Some of the ClusterView capabilities are less obvious and grouped here.

ClusterView configuration

Registration file

Drag and drop operation

Command line arguments

Furthermore, you can get direct access to the help capabilities either through the Help Contents option of the Help menu (this leads you to the introduction of this help file) or through the Search for Help On... option of the same Help menu (this leads you to the Search command of this help file).


Egg Operation
Easter Egg Operation

An easter egg is the traditional name for these non-documented nice features of an application. It must not be counfounded with undocumented fonctions of the application. They may have some utility. On the contrary, the egg is of no use at all, but is generally either nice or funny but never useful.

In all cases, the egg is hidden.

Try and find the one in ClusterView. If you EnAbLe it, you may like it.


Configuration
ClusterView Configuration

ClusterView is configurable both through the use of its initialization file (whose name is CLUSTER.INI) and through the use of the Options menu. This allows you to easily optimize its operation and its performance.

The initialization file interface is more powerful (provides more options to the user) but is more difficult to use than the Options menu. The preferred interface for the user is the Options menu because it is more user friendly and providing all necessary information to avoid confusion.

The modifications made through the Options menu are autmatically saved back to disk into the CLUSTER.INI file at the normal end of the execution of the application (when you choose Exit in the File Menu or in the system menu).

For more information on these, please select either one of the keywords shown here.


Registration File

A default registration file is provided with ClusterView. To install it, follow the procedure:

1	Run the File Manager if it is not already running. To do this, you need to double click on the FileManager icon.

2	Switch to the drive and directory where the registration file is. Normally, you will find it on the distribution disk in the root directory (A:\).

3	Double click on the CLUSTER.REG registration file.

The ClusterView registration data is automatically added to your registration database. Next time you will run File Manager, all file whose suffix is CLU will be considered as ClusterView clusters. By double clicking on them, you will immediately open them with a new ClusterView application.


Drag'n Drop Operation
Drag and Drop Operation

This is an alternative to using the File Open... command and the Cluster Open... command from the application menu followed by the Open dialog box.

ClusterView is a Drag'n Drop client for File Manager. This means that if you take a file from the File Manager (selecting it with the mouse), drag it accross the desktop (keeping the left button pressed) and drop it on the ClusterView icon or window, then, ClusterView will automatically open the file. If it can recognize a Cluster file, it will be opened as such. If not, the file will be opened as a Cluster.

ClusterView does not allow multiple files to ne dropped at the same time. Only the first one will be used and a message box will be issued to warn the user of its error.

For more about Drag'n Drop operation, you may consult your Windows 3.1 User's guide and File Manager Help menu.

See also

Cluster File Format


Command Line Arguments

If a file name is found on the command line at start time, ClusterView interpret it as a cluster name to open.

This, with the help of the registration file, allows to open automatically the cluster whose name suffix is CLU. In the File Manager, you only have to double click on the cluster to open it in a new session of ClusterView.


Font Selection

The display font can be choosen by the user through the Font choice in the Options menu. The dialog box allows to choose a character font, if it must be bold/italicized, and its point size.


Line/Hyphen Options

ClusterView has a specific option for OCR hyphenated texts. It is able to modify automatically at display time the characters inserted at the start or the end of a line. The normal use is to modify the visual aspect of the hyphen which is often an unusual character added by OCR software.

The Line/Hyphen dialog box allows to select the hyphen character position in a line (either at start of line or at end of line), to show the hyphen character used in documents, to select the hyphen character to be used by ClusterView at display time.

Moreover, find operations are able to understand what an hyphen is and consequently it is optionally possible to wrap hyphenated words when searching for a pattern. This is done to allow the recognition of an hyphenated word (split to two different lines) as a single word and to allow an efficient search even in heavily hyphenated texts.