home
***
CD-ROM
|
disk
|
FTP
|
other
***
search
/
Hall of Fame
/
HallofFameCDROM.cdr
/
wp3
/
pcindx11.lzh
/
PCI.DOC
< prev
next >
Wrap
Text File
|
1989-07-01
|
31KB
|
1,030 lines
PC-INDEX USER'S GUIDE
Version 1.0
Copyright 1989, HELP SOFTWARE
16706 BRADLEY COURT
BELTON, MO 64012
(816) 331-5809
CIS 73720,2530
DISCLAIMER
The user hereby agrees that regardless of the form of any claim, liability
for any damages or loss incurred because of this product shall not exceed
the registration fee or purchase price.
TABLE OF CONTENTS
WHAT DOES PC-INDEX DO ? ..................................... 1
WHY SHOULD I REGISTER MY COPY OF PC-INDEX ................... 1
SYSTEM REQUIREMENTS ......................................... 2
QUICK START - EXAMPLE ....................................... 2
MENU SELECTIONS ............................................. 5
REGISTRATION FORM ........................................... 9
BUG REPORT FORM ............................................. 10
SUGGESTION / QUESTIONNAIRE FORM ............................. 11
INDEX ....................................................... 12
WHAT DOES PC-INDEX DO ?
PC-INDEX is designed to produce the type of an index that you would find in
the back of a book or reference manual. It has many options available and
can produce a professional looking index in a very short time and with a
minimum of user input.
PC-INDEX can produce an index on every single word in a document, or you
can control which words will be included or discarded.
PC-INDEX can handle any size file. In tests run on an 8086 machine with a
slow hard disk, a 400K file took about 6 minutes to index. On a 16Mhz
80386 machine the same test took about 1 minute and 15 seconds.
PC-INDEX differs significantly from the index feature you will find in most
word processors. Instead of having to mark each word or phrase (as you do
with most word processors), PC-INDEX simply indexes your document using
every word (or optionally, every word that you choose to include).
Registered users will receive a non-shareware version which will contain
some additional features, primarily the ability to handle word processor
documents without converting to ASCII format first.
WHY SHOULD I REGISTER MY COPY OF PC-INDEX ?
By registering PC-INDEX you will receive the latest version on disk and a
printed manual.
The registered version will not contain the 'advertising' that is included
in the shareware version.
The registered version will contain advanced features. The current
advanced features include:
a) The ability to process Wordperfect 4.2 and 5.0, and Wordstar
Professional 5.0 documents in their original format. Other formats are
planned for future versions.
b) The ability to produce multi-column indexes. The shareware version
allows you to produce one column indexes only.
If you register, you will receive notices of new versions and bug fixes as
they are available.
You will encourage the future development of this program.
Whether you register or not, please take time to fill out the questionnaire
included at the end of this document. This is your chance to send in your
comments and make PC-INDEX more useful to YOU.
PC-INDEX User's Guide - Page 1
SYSTEM REQUIREMENTS
The minimum requirements for PC-INDEX are 384K of RAM and one floppy disk
drive. Additional memory will speed up the operations of PC-INDEX. PC-
INDEX will use up to 640K of RAM. A hard disk drive is highly recommended
and may be necessary for larger files.
QUICK START - EXAMPLE
In order to get you up and running as quickly as possible, an example has
been included to demonstrate the general use of PC-INDEX.
The document that you process must be an ASCII file. We will index this
documentation (PCI.DOC) for our example.
The PCI.DOC file was created by printing the file to disk using
Wordperfect. The print to disk method is preferred over saving the file as
an ASCII file, because it records page breaks more accurately.
To begin using PC-INDEX type PCI and press enter.
There are two required steps and an optional third step to producing an
index with PC-INDEX.
STEP ONE: Extract Words
This option is found in the FILE menu. Select the Extract Words option by
using the cursor keys and pressing ENTER. You should now see a new window
asking you for an input filename, an output filename, the page size, the
first page number to start indexing on, and the first page number to use.
For the input filename type 'PCI.DOC' and press enter. For the output
filename type 'PCI.SRT' and press enter. Since this document was created
using 66 lines per page (the standard for letter size paper) we will leave
this setting as it is. Next enter 4 for the Start Indexing on Page entry,
(we want to skip the title page, the disclaimer, and the table of contents)
and leave the First Page Number to use setting at 1.
The completed window should look like this:
__________________________________________________________________________
Input File Name: (Name of Document to process)
pci.doc
Output File Name:
pci.srt
Page Size Start Indexing on Page First Page Number to use
66 4 1
__________________________________________________________________________
PC-INDEX User's Guide - Page 2
When you have finished entering the filenames and other information, press
F10 to begin processing 'PCI.DOC'.
You should now see a window which gives you the current status and tells
you how the processing of PCI.DOC is going. You will be kept informed of
how many characters, lines, words, and pages have been processed as well as
how many words have been included and discarded.
This process should only take a few seconds for PCI.DOC.
STEP TWO: Edit Extracted word file
This step is optional. It gives you the chance to fine tune the list
before creating the index. This option is found under the EDIT menu.
Select the 'Extracted word file' option from the EDIT menu. You will be
asked for an input file name. PC-INDEX will enter the name of the output
file from the Extract Words option, PCI.SRT. Just leave the name alone and
press enter. After a few seconds you will see a list of each unique word
in PCI.DOC and the number of times that each word occurred.
To the far left of each word are a set of brackets and an asterisk. The
presence or absence of an asterisk indicates whether or not the word is
active. If a word is active, it will be included in the index when it is
created. Words can be toggled between being active and inactive by using
the spacebar.
If you haven't changed any options before processing PCI.DOC, all words
will be lowercase. If you have individual words which need to be different
you may change them now. For instance go to the entry 'ASCII'. You will
notice that it is lowercase. Since ASCII is an abbreviation it needs to be
listed in uppercase. By pressing F3, the entry will be changed immediately
to all uppercase. You may have a name which needs to have the first letter
uppercase and the rest lowercase. For example go to the entry 'Australia'.
You'll notice that it too is all lowercase. By pressing F5 you can change
the word from australia to Australia.
You may notice that the word Australia is only shown to have one occurrence
when it seemingly should have at least 4 occurrences since there are 4 on
this page alone. However, PC-INDEX comes configured to delete duplicate
words on the same page. This is an option, though, and can be changed if
you wish.
When you are done editing the word list press ESCape to return to the main
menu. All changes have already been saved.
PC-INDEX User's Guide - Page 3
STEP THREE: Build Index
The third and final step 'Build Index' is found under the FILE menu. This
step takes the file created by the 'Extract Words' selection and edited by
the 'Edit Extracted Word File' selection and creates an index.
Select 'Build Index' from the FILE menu. You will be asked for the input
file and output file. PC-INDEX remembers the name that you gave the file
('PCI.SRT') when you extracted the word list. You should be able to leave
this name as it is.
Next you will be asked what name you want to use for the output file. This
is the name that the actual index will be called. For this example we'll
call it 'INDEX'.
Next, PC-INDEX wants to know the page size (how many lines per page) you
want to use. The default setting is 66 which is the proper setting for
letter size paper. This number does not need to match the lines per page
setting you used when you selected 'Extract Words'. Most laser printers
will only output 60 lines per page. If you will be outputting the index to
a laser printer later, you will want to set this option to 60.
Next, PC-INDEX asks you the number of columns you would like the output to
be in. If you are using the shareware version you will only be able to
produce a one column index. If you are using the registered version you
will be able to produce a one or two column index. An example of a two
column index is included at the end of this document.
The completed window should look like this:
__________________________________________________________________________
Input File Name:
pci.srt
Output File Name:
index
Page Size Number of Columns
66 1
__________________________________________________________________________
When you have finished entering the filenames and other information, press
F10 to begin processing 'PCI.SRT'.
You should see a status box which tells you the number of words to be
processed, the number of words actually processed, the letter of the
alphabet currently being processed, the percentage completed, and the total
elapsed time so far.
PC-INDEX User's Guide - Page 4
This process should only take a few seconds for this example. When it is
finished, you will be returned to the main menu and the completed index is
contained in the text file named 'INDEX'. If you wish to view the file you
can enter 'TYPE INDEX' from the DOS command line. You could also print the
document to the printer by entering 'TYPE INDEX >PRN' from the command
line. Since 'INDEX' is an ASCII file, you could also load it into most
word processors and edit it further if you wish.
MENU SELECTIONS
The following section gives a brief description of all menu choices.
The main menu consists of four menus, FILE, EDIT, OPTIONS, and DOCUMENT.
FILE menu:
The FILE menu has four available selections: Extract Words, Build Index,
Save Settings, and Quit.
Extract Words is the first step performed in building an index. It's basic
function is to extract each individual word from the document and decide
whether or not it should be included in the index.
Build Index is the final step in creating an index. Build Index takes the
file created by the Extract Words selection and uses it to create the
actual index file.
Save Settings saves the current settings in the OPTIONS and DOCUMENT menus.
Quit exits PC-INDEX and returns you to the DOS prompt.
EDIT menu:
The EDIT menu has four available selections: Custom character set, Discard
word file, Include word file, and Extracted word file.
EDIT Custom character set: There are two predefined character sets that
you can use to determine what characters will be included in a word when
you extract words from your document. The first is alpha characters only
(A-Z), the second contains alpha characters and numeric characters as well
(A-Z and 0-9). If neither of these predefined character sets will work
then you can define your own set of characters to use.
There are 256 possible characters and any characters can be valid in a
word. To select or deselect a character simply position it under the
highlight bar and press the spacebar.
PC-INDEX User's Guide - Page 5
EDIT Discard word file: The Discard word file contains a list of words
which can be searched during the Extract words selection. If the 'Use
Discard Word List' option is selected from the options menu, when a word is
extracted from a document, the Discard word file is searched. If a match
is found then the extracted word will be discarded and will not be included
in the index.
Over 350 words are included in the Discard word list right now. Many words
are words like a, and, the, if, or, etc. You may want to take a look at
the words currently in the list to see if it meets your needs.
By using the EDIT Discard word file, you can add, edit, or delete words
from the list to customize it to your needs. Up to 1000 words can be
included in the list.
EDIT Include word file: The Include word file contains a list of words
which can be searched during the Extract words selection. If the Use
Include Word List option is selected from the options menu, when a word is
extracted from a document, the Include word file is searched. If a match
is found then the extracted word will be included in the index.
There are no words included in the Include word list as it ships.
By using the EDIT Include word file option, you can add, edit, or delete
words from the list to customize it to your needs. Up to 1000 words can be
included in the list.
EDIT Extracted word file: This is an optional step in creating an index.
It gives you a chance to fine tune the index before you complete it. By
using this option, you can deactivate words so that they will not be
included in the index and change the case of words that are included (from
lowercase to uppercase and vice versa).
OPTIONS menu:
The OPTIONS menu has nine available selections. There are four basic
groups of selections: valid characters, case selection, compare list, and
eliminate duplicates.
The first group of options determines what characters will be allowed in a
word when it is extracted. The Include Alpha Characters option will allow
only the characters A-Z to be included in extracted words. The Include
Alphanumeric Characters option allows the characters A-Z and 0-9 to be
included in extracted words. The Custom Character Set option will allow
the characters that you have selected using the EDIT Custom character set
option to be included in extracted words.
PC-INDEX User's Guide - Page 6
The second group of options determines what case the characters will be
converted to when written to disk.
For consistency, PC-INDEX will convert all words to be the same case as
they are being extracted. You have three choices. Convert words to UPPER
CASE will convert all words to upper case, Convert words to lower case will
convert all words to lower case, and Convert words to UPPER & lower case
will convert the first letter in the word to upper case and the rest of the
word to lower case.
The third group of options determines which words will be included in the
extracted word list.
You have three options to determine which words will be included.
Use Discard Word List: When the Use Discard Word List option is selected,
PC-INDEX will compare the extracted word to the discard word list. If a
match is found, the extracted word will be discarded and will not be
included in the extracted word list or the index.
Use Include Word List: When the Use Include Word list option is selected,
PC-INDEX will compare the extracted word to the include word list. If a
match is found, the extracted word will be included in the extracted word
list.
The third option is to have neither of the two options selected. When
neither option is selected no search takes place and every extracted word
is included in the extracted word list.
The last option is Eliminate Duplicate Words. This option is recommended.
It will speed up processing of large files. When this option is selected
any duplicates that occur on the same page will be deleted.
DOCUMENT menu:
The registered version of PC-INDEX has the ability to process documents of
several popular word processors without any conversion. If you have
purchased the registered version and wish to process Wordperfect 4.2 or
5.0, Wordstar, or Microsoft Word 4.0 in their original format, simply
select the document type that you are using and PC-INDEX will process the
document without any conversion.
If you do not have the registered version, you will get an error message
when you try to select a format other than Text.
PC-INDEX User's Guide - Page 7
Black and White Screen
Using PC-INDEX with a black and white screen: If you are using a computer
which has a black and white screen, but uses a color video adapter, (such
as a Compaq or laptop computer) you may have trouble reading the screen in
some places. PC-INDEX has a black and white option. If you enter 'PCI bw'
when you start PC-INDEX, then PC-INDEX will know that you have a black and
white monitor and will adjust the colors accordingly.
PC-INDEX User's Guide - Page 8
PC-INDEX
Copyright (C) HELP SOFTWARE
Registration Form:
Remit to: Help Software
16706 Bradley Court
Belton, MO 64012
QTY Description Amount
___ Registration(s) of PC-INDEX ______
@ $25.00 each.
___ Copies of PC-INDEX Disk and Manual ______
(includes registration fee) @ $35.00 each.
Subtotal ______
(Missouri Residents please add 6.225% sales tax) Tax ______
Total ______
Payment by: [ ] Check [ ] PO # ___________
Name: ______________________________________________________
Company: ______________________________________________________
Address: ______________________________________________________
______________________________________________________
______________________________________________________
Work Phone: (____) _____________ Home Phone: (____) ____________
PC-INDEX User's Guide - Page 9
PC-INDEX Bug Report Form
Name: ______________________________________________________
Company: ______________________________________________________
Address: ______________________________________________________
______________________________________________________
______________________________________________________
Work Phone: (____) _____________ Home Phone: (____) ____________
System memory ____ Version of DOS ____ Version of PC-INDEX ____
Bug Repeatability Always ___ Sometimes ___ Rarely ___
Type of Bug Locks up machine ___ Does not perform as Documented ____
Bug Description _______________________________________________________
________________________________________________________________________
________________________________________________________________________
________________________________________________________________________
________________________________________________________________________
________________________________________________________________________
________________________________________________________________________
How can the bug be duplicated _________________________________________
________________________________________________________________________
________________________________________________________________________
________________________________________________________________________
________________________________________________________________________
________________________________________________________________________
________________________________________________________________________
PC-INDEX User's Guide - Page 10
PC-INDEX Suggestion / Questionnaire Form
Name: ______________________________________________________
Company: ______________________________________________________
Address: ______________________________________________________
______________________________________________________
______________________________________________________
Work Phone: (____) _____________ Home Phone: (____) ____________
Suggestion(s): ________________________________________________________
________________________________________________________________________
________________________________________________________________________
________________________________________________________________________
________________________________________________________________________
________________________________________________________________________
________________________________________________________________________
Questionnaire
What type of industry are you in? ______________________________________
What do you use PC-INDEX for? __________________________________________
________________________________________________________________________
How often do you use PC-INDEX? _________________________________________
What size of document do you generally use with PC-INDEX? ______________
About how much time does PC-INDEX save you? ____________________________
If you didn't use PC-INDEX, would you still create an index for your
documents? ____________________________________________________________
PC-INDEX User's Guide - Page 11
----- A ----- default 4
accurately 2 define 5
active 3 delete 3, 6
adapter 8 deselect 5
adjust 8 designed 1
advanced 1 development 1
advertising 1 discard 5-7
alpha 5-6 discarded 1, 3, 6-7
alphabet 4 document 1-2, 4-7, 11
alphanumeric 6 documentation 2
ASCII 1-3, 5 documents 1, 7, 11
Australia 3 duplicates 6-7
----- B ----- ----- E -----
bar 5 edit 3-6
basic 5-6 edited 4
black 8 editing 3
brackets 3 eliminate 6-7
bug 1, 10 entry 2-3
build 4-5 error 7
building 5 extract 2-6
bw 8 extracted 3-7
----- C ----- ----- F -----
case 6-7 features 1
character 5-6 filenames 3-4
characters 3, 5-7 files 2, 7
choices 5, 7 fixes 1
column 1, 4 format 1, 7
columns 4 formats 1
comments 1
Compaq 8
complete 6 ----- H -----
completed 2, 4-5 highlight 5
configured 3 home 9-11
consistency 7
conversion 7
convert 7 ----- I -----
converted 7 inactive 3
converting 1 include 1, 5-7
create 5, 11 included 1-7
created 2-5 index 1-11
creates 4 indexes 1
creating 3, 5-6 indexing 2
custom 5-6 input 1-4
customize 6
----- L -----
----- D ----- laptop 8
deactivate 6 laser 4
PC-INDEX User's Guide - Page 12
letter 2-4, 7 printers 4
lines 2-4 printing 2
list 3-4, 6-7 prn 5
lowercase 3, 6 processed 3-4
processing 3-4, 7
processor 1
----- M ----- processors 1, 5, 7
manual 1, 9 program 1
mark 1 prompt 5
match 4, 6-7
memory 2, 10
menu 2-7 ----- Q -----
menus 5 questionnaire 1, 11
message 7 Quickstart 2
minimum 1-2 QUIT 5
minute 1
minutes 1 ----- R -----
monitor 8 RAM 2
recommended 2, 7
records 2
----- N ----- reference 1
number 2-4 register 1
numeric 5 registered 1, 4, 7
registering 1
registration 9
----- O ----- required 2
occurrence 3 requirements 2
occurrences 3 running 2
option 2-4, 6-8
optional 2-3, 6
optionally 1 ----- S -----
options 1, 3, 5-7 save 5, 11
output 2-4 saved 3
outputting 4 saves 5
saving 2
screen 8
----- P ----- search 7
page 1-11 searched 6
pages 3 select 2-5, 7
paper 2, 4 selected 4, 6-7
pc 1-11 selection 4-6
pci 2-4, 8 selections 5-6
percentage 4 setting 2, 4
perform 10 settings 5
performed 5 shareware 1, 4
position 5 spacebar 3, 5
predefined 5 speed 2, 7
preferred 2 start 2, 8
print 2, 5 status 3-4
printed 1 suggestion 11
printer 4-5
PC-INDEX User's Guide - Page 13
----- T -----
text 5, 7
time 1, 4, 11
times 3
toggled 3
tune 3, 6
----- U -----
uppercase 3, 6
----- V -----
version 1, 4, 7, 10
versions 1
video 8
view 5
----- W -----
white 8
Wordperfect 1-2, 7
Wordstar 1, 7
PC-INDEX User's Guide - Page 14
PC-INDEX User's Guide - Page 15