Copyright: ® Jurisoft, Inc., Div. Mead Data Central, Inc.


Help Contents
Table of Contents

Warranty Information

License and Limited Warranty

Network License Addendum

1. The Basics

About Chapter 1

How CompareRite Software Works

Welcome to CompareRite 5.0

Manual & Program Conventions

Getting Started

Support & Return Policies

Navigating the CompareRite Menu

Option Sets

2. Network Set Up

About Chapter 2

Initial Set Up

Understanding Network Set Up Options

Walkthrough Exercises

Override Table

Access Table

Defining Option Set Libraries

3. Shortcuts & Special Functions

About Chapter 3

Custom Help

Customizing the Initialization File

Appendix A. CompareRite Options

About Appendix A

Additions Options

Deletions Options

Methods Options

Preferences Options

Appendix B. Troubleshooting & Error Messages

About Appendix B

Program Troubleshooting

Redline Document

Calling Customer Support

Appendix C. CompareRite Program Option Sets

About Appendix C

Making Keyboard Selections

Main Window

Appearance of Additions Dialog Box

Appearance of Deletions Dialog Box

Methods Dialog Box

Preferences Dialog Box

Define Option Sets Dialog Box

Save Modify Option Set


License and Limited Warranty

Jurisoft, A Division of Mead Data Central, Inc. has produced CompareRite at great time and expense. This program is protected under United States copyright laws and Massachusetts trade secret laws. Jurisoft hereby grants you a non-exclusive, non-transferable license to use this software as long as you abide by the terms of this agreement.

Before you use the software you should read this license. If you do not accept these terms, you may return the unused program to your dealer within 30 days.

You agree to treat this software just like a book, except that you may not rent, lease, or license the program to others. This means that, like a book, any number of people may use the program sequentially and it may be moved freely from one computer to another, so long as there is no possibility of it being used at two different locations at the same time. Also, you cannot place this program on a local area network, whether or not it will be shared. If you wish to use the program on more than one computer at a time, or place it on a network, you must license such rights from Jurisoft. You may not make copies of the manual or other documentation. You may make copies of the software for backup purposes to protect against failure of your original disk. You further agree to protect this software from unauthorized use, illegal reproduction, or illicit distribution. Finally, you agree not to change or reverse engineer this software or its method of operation by debugging, disassembling, reprogramming, intercepting on-line communications, or by any other means.

We warrant this product to be free from defective materials or workmanship in normal use for 90 days from your receipt from an authorized dealer.

JURISOFT SPECIFICALLY DISCLAIMS ALL OTHER WARRANTIES, EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE. IN NO EVENT SHALL JURISOFT BE LIABLE FOR ANY LOSS OF PROFIT OR ANY OTHER COMMERCIAL DAMAGE, INCLUDING, BUT NOT LIMITED TO, SPECIAL, INCIDENTAL, CONSEQUENTIAL, OR OTHER DAMAGES.

Special network versions of this program are available. If this program is a network version, your license is the same as the license printed above, except that you may install one copy of the program on a single file server for use on a single local area network. Under your network license you have the right to use this program on a specific number of network nodes. This means that the program is not licensed for simultaneous use by more than the number of users. SINGLE USER VERSIONS OF THIS PROGRAM ARE NOT TO BE USED ON A NETWORK.

CompareRite software was designed to perform certain designated functions, and only these functions are covered under this warranty.


Network License Addendum

If you have licensed a network version of this program, this addendum modifies the license to permit such use. If you do not agree with the terms of the original license, or this addendum, you may return the program within thirty days of receipt, for a full refund.

The network version of your program may be used in either of two configurations: Concurrent or User-ID.

Note: If you purchased a 5 User-ID network version of CompareRite, access is restricted to the five users who are assigned these user-ids. Other users on the network will not have access to the program. YOU CANNOT SET UP A 5 USER-ID NETWORK VERSION FOR CONCURRENT ACCESS.

Each configuration is shipped preset to allow simultaneous access by a certain number of users (the Permitted Number). You may use either configuration, and from time to time you may switch between them, but you may not simultaneously use both configurations. You may operate this program directly, or through another program, provided that the other program runs this one at substantially the same time as it receives a request to run it. If you wish to operate the program in another manner, you will need to contact Jurisoft for a modified license.

You may install this program on a single distribution computer (file server), from which other computers or workstations, up to the Permitted Number, may access this program for actual use. The program may not be redistributed over a network from one file server to another unless a license is purchased for the total number of file servers that have access to the program.

If you are using the program in its Concurrent version, you may allow as many people to have access to the program as you wish, provided that no more than the Permitted Number of users can run the program at any single time.

If you are using the program in its User-ID version, you may set up the Permitted Number of separate User-ID accounts, and any of these accounts may operate the program at any time, so long as each User-ID is assigned to, and used by, a specified individual or designated workstation. You may, from time to time, change these specified individuals or designated workstations.

Although the program ordinarily will not permit Concurrent or User-ID use beyond the Permitted Number, it is a violation of this license for you to operate the program using any method that you should reasonably expect will enable you to exceed the Permitted Number.

This agreement supplements, but does not replace the stand-alone program license agreement. If part of this agreement conflicts with the stand-alone agreement, the term in this agreement should be used.


About Chapter 1

This chapter gives you an introduction to the CompareRite program and its many features:

•	How CompareRite Software Works explains how CompareRite operates.

•	Welcome to CompareRite 5.0  gives a brief overview of the new look and features of CompareRite 5.0.

•	 Manual & Program Conventions defines commands, messages, and other program elements used in the manual.

•	Getting Started provides you with the steps you need to create a redline document.

•	CompareRite Software Support & Return Policies concludes the chapter.

This chapter is intended primarily for the first-time user.


How CompareRite Software Works

The CompareRite program compares an original document against a revised document and creates a third, redlined document. The redline document shows what has been moved in, added to, or deleted from, the original document. You choose how to show these changes. The program works with documents of any size.

CompareRite creates an accurate record of the changes in a document, making it easy to review revisions. You can review the complete text of your revisions in context, or simply review a revisions report.


Welcome to CompareRite 5.0

We've refined the CompareRite program to make it even easier for you to create the redline documents you need.

CompareRite 5.0 has a new "look and feel" based on the following principles:

•	Most users want to specify the names of the original and revised documents, name the redline document and go. These users seldom, if ever, want to undertake the task of reviewing all possible settings.

•	Some users, however, do want the ability to review and change settings. The program must still make access to all options available to these power users.

Following from these principles, we've streamlined the CompareRite menus. All the options and settings of CompareRite are still available. In fact, we've added valuable new options. But the menus associated with this myriad of choices are now hidden from the average user. Of course, any user can still access all redlining options by making a simple menu selection.

This streamlining was made possible by the introduction of a new feature, option sets. The systems administrator can design option sets for use by the entire firm; individuals can create personal option sets based on their own requirements. Users or the system administrator choose options once and save them to an option set. Then, rather than making multiple menu selections each time the program is run, a user can simply choose an appropriate set for the redlining task at hand.

The CompareRite 5.0 program includes the following new features:

•	Revised and simplified user interface. We provide a graphical user interface (GUI) for Windows users and a textual user interface (TUI) for DOS users. Both interfaces have the same features. A single program works for both DOS and Windows.

•	On-line help.

•	Dual word processor support. You can now compare documents created using different word processors.

•	Revisions List. You can now create and review a list of changes.

•	User specified strings. You choose what characters you want to use to surround your additions or deletions.

•	Integration with WordPerfect. Use Jurisoft DirectConnect to access CompareRite directly from WordPerfect, without exiting to DOS. Call 1-800-321-4566 to order your free copy.


Manual & Program Conventions

This section explains the conventions used in the CompareRite User Manual. Conventions define how the manual depicts commands, messages, and other program elements.

The printed  manual uses key caps to refer to keys found on your computer keyboard.  You may also be instructed to press two keys in combination. For example, from the CompareRite Main Menu, press Alt - F to select a file.

The manual indicates messages or other information displayed on your screen by printing in bold. For example, CompareRite indicates the number changes found by displaying that information to your screen, such as 23 changes found.

The manual refers to making selections from different menu levels in a specific way. Once you've made a selection from the main menu, choose from the options that display. Some options require you to pick a setting.

Finally, the two documents used to create a redline document are the original document and the revised document. It does not matter which was created first.

The document created by the CompareRite program is the redline document. This document is based on the revised document.


Getting Started

Install the CompareRite program as instructed in Chapter 2, Installation & Set Up, of the CompareRite Manual. Then follow these steps to create a redline document.

Related Topics:

Redlining Using CompareRite for Windows

Reviewing Your Comparison Using the Viewer


Redlining Using CompareRite for Windows

To create a redline document using CompareRite for Windows, follow these steps:

1	From the Windows Program Manager, double click on the CompareRite icon.

 The CompareRite Main Menu displays.

2	Click on the button associated with the Original Document field. The Select Original Document dialog box displays.

Select an original document file just as you specify any file using a Windows program; type in the filename or type of file or select the appropriate drive and directory to choose from a list of files. Or press Ctrl - R to enter the original document filename from your last session. Once you are finished, click on the OK button.

3	You return to the CompareRite Main Menu. The Original Document field contains the name of the original file you specified. Click on the button associate with the Revised Document field. Specify a revised document just as you did the original document. When you are finished, click on the OK button.

4	The CompareRite Main Menu displays. The Revised Document field contains the name of the revised file you specified. Click on the Redline document field. Note that the CompareRite program creates a default redline filename for you. If you wish to specify a different filename, type the name of the redline document, including path.

For example, to create a redline document file named REDLINE.DOC in the DOC directory on your C drive, type C:\DOC\REDLINE.DOC.

You can also click on the button associated with the Redline Document field and use the Select Redline Document dialog box to specify a redline document filename. Choose an existing filename only if you wish to overwrite that file.

When you are finished, click on the OK button.

Note: If you do not specify a redline document name, the CompareRite program will display your results to the screen.

5	The CompareRite Main Menu displays. Note the name of the option set specified in the Option Set field. This is the option set used during your last session. The options corresponding to the set display to the right of the associated button.

Note: If you are running the program for the first time, the option set field displays an option set provided by Jurisoft. If you are running the program for the first time after upgrading from an earlier version of the CompareRite program, your previous settings are included in the option set Previous option set.

To choose from a list of available option sets, click on the button associated with the Option Set field.

 A list of option sets displays.

Click on the appropriate option set name to select the set of options you wish to use. The options corresponding to the set display to the right of the associated button.

For information on creating new option sets or editing existing ones, refer to the Creating An Option Set section in Chapter 1. For a detailed description of each option, refer to About Appendix A , CompareRite Options.

6	After providing filename and option set information, click on the Compare button. If you have made changes to the option set you selected, the program prompts you to save your changes.

A status box informs you of the progress of your comparison.

Once the comparison is complete, click on the Close button.

If you did not specify a redline document filename, review your results on the screen. Refer to the section  Reviewing Your Comparison Using the Viewer  for more information on this function.

If you specified a redline document filename, retrieve and print the redline document using your word processor.


Reviewing Your Comparison Using the Viewer

If you do not specify a redline document filename before running a comparison, your results display to the CompareRite program Viewer on your screen. You can then review the text of your original or revised documents as well as a comparison of the two.

Once the comparison is complete, the Viewer screen displays.

Use the following keys and key combinations to review the text from your original and revised documents and the comparison. Note that you can only review your documents; you cannot make any changes:

Press...	To...
F1	Review the text of your original document, with deletions (or the marker used to indicate deletions) highlighted and additions not shown. The name of the original document file is displayed at the top of the screen.
F2	Review the text of your revised document, with additions highlighted and deletions not shown. The name of the revised document file is displayed at the top of the screen.
F3	Review your comparison. The comparison is formatted based on the option set you specified. The top of the screen indicates that you are viewing the comparison.
PgUp, PgDn	Move to the next or previous screen
Home	Move the cursor to the beginning of the current line of text
End	Move the cursor to the end of the current line of text
Ctrl-Home	Move to the top of the displayed document
Ctrl-End	Move to the bottom of the displayed document
Ctrl-N	Move to the next change
Ctrl-P	Move to the previous change
Ctrl-F	Search for a text string: •Use your arrow keys to move around the associated pop-up box. • Enter a text string into the FIND field. •To choose the options Ignore Case or Search Backwards, move to the option and press X. •To begin the search, move to GO and press Enter. •To repeat your previous search, press Ctrl-R from the Viewer screen.


Support & Return Policies

CompareRite—The Instant Redliner—will save you hours of time. We're confident you'll find it an indispensable tool. But before you use the program, we want to bring up an unpleasant fact of life in the software business: bugs.

Software bugs are like household bugs: often present, seldom discussed. Bugs exist because software is complicated. Not only does a program take months to write but, once written, it has to work in a dizzying variety of situations.

Every program on the market almost certainly contains bugs. The CompareRite program probably does, too. That said, don't panic. Jurisoft has tested the CompareRite program extensively and it consistently delivers accurate redline documents. If you find a bug, report it to us. We will fix it as soon as is possible.

Nevertheless, when you use any software you should protect yourself. Remember that CompareRite is only software, and doesn't possess "common sense" or a human appreciation of style. CompareRite creates logically sensible comparisons; it may not be the comparison you expect. You should scan every redline document before it leaves the offce.

We are proud of the CompareRite program. Our support policy assures you that we stand behind it.

This program is provided under the terms of a separate license agreement. Its copying, use, and sublicensing are governed by the terms of this agreement. JURISOFT MAKES NO WARRANTIES OTHER THAN THOSE PROVIDED BY THE LICENSE AGREEMENT.

If for any reason you need to return this product within 30 days of order, call (800) 262-5656 or (617) 864-6151 (in Massachusetts) for return authorization and directions.

Jurisoft accepts no responsibility for products returned without prior authorization.


Navigating the CompareRite Menu

Navigate the CompareRite menus and dialog boxes as follows:

•	Use your mouse to make selections. You can also press Alt and the letter associated with the button or option name to choose that button or option.


Option Sets

You must create at least one option set to define your word processor before using the CompareRite program. However, you will want to use option sets to create and name groups of redlining options. Users can then choose an option set rather than spend time reviewing options and making menu selections.

This section discusses how to create a new option set or modify an existing one. For more information on each of the redlining options and a list of the options included in the pre-configured option sets, refer to About Appendix A , CompareRite Options.

Related Topics:

Creating An Option Set


Creating An Option Set

To create or edit option sets, you must have read-write-create privileges to the directory specified as the global option set directory during installation.

After accessing the CompareRite program, the Main Menu displays.

From the CompareRite main menu, select the Define drop down menu.

Note: You can only work with those option sets to which you have write-access to the associated option set library directory.

Click on Option sets. The Define Option Set dialog box displays.

The left hand portion of the box lists current option sets. The currently selected option set is highlighted on accessing the box.

Highlight an option set and select a button to select, create, edit or delete an option set as follows:

New. Highlight an option set and click on NEW to create a new option set.

The Define New Option Set dialog box displays.

Type the name of the setcreating a new option set you wish to create into the Name field. The option set name may be up to 31 characters in length, and may only contain the letters A through Z, the numbers 0 through 9 or any of the characters _, ^, $, ~, !, #, %, &, - , {}, (), @, ' or `.

The option set you selected from the Define Option Sets dialog box is specified in the Based on field.

The lower portion of the dialog box provides a button for each type of option setting. For example, click on the Additions Options button to indicate how additions should be marked in the redline document. The option settings shown next to each option button reflect the settings defined by the option set indicated by the Based on field.

To create the option set you named, click on each button and make selections. Then click on SAVE to create the option set and return to the Define option set dialog box or CANCEL to return without saving your work. The table below provides an overview of available options. Refer to About Appendix A, CompareRite Options, for a detailed description of each option.

Note: If you are using the CompareRite program on a network, you can only create global option sets if you have read-write-create privileges in the global option set library directory (specified during the install process).

Use...	To define...
Additions Options	How added text is shown in the output document
	How added text appears on screen
Deletions Options	How deleted text is shown in the output document
	How deleted text appears on screen
Methods Options	Level of text comparison (pinpoint, normal, broad, programmer)
	How moved text is shown
	Characters to indicate text that is not included in the comparison
	If you wish to include footnotes in the comparison
Preferences Options	Word processor format of original document
	Word processor format of revised document and output document
	Placement of description page
	Inclusion of revision list
	Word processor specific options
Modify. Highlight an option set and click on MODIFY to edit an option set you created previously. From Windows, you can click on an option set twice.

Note: If you are using the CompareRite program on a network, you can only modify global option sets if you have read-write-create privileges in the global option set library directory (specified by running the COINST program).

The Modify Option Set dialog box displays.

The option set you selected from the Define Option Set dialog box is specified in the Name field.

The lower portion of the dialog box provides a button for each different type of option setting. For example, click on the Preferences Options button to change the word processor used to create the original and the revised document, as well as modify the contents of the output document. The option settings shown next to each option button reflect the settings currently associated with the option set you wish to modify.

To modify the option set you have selected, click on each button to make any necessary changes. Then click on SAVE to implement the changes and return to the Define option set dialog box or CANCEL to return to the Define option set dialog box without making any changes. The above table gives you a quick overview of the available options. Refer to the About Appendix A , CompareRite Options, for a detailed description of each option.

Delete. Highlight an option set and click on DELETE to delete an option set you created previously. You are prompted to confirm that you wish to delete the option set you specified.

Click on YES to delete the option set and return to the Define Option Set dialog box; click on NO to return to the Define Option Set dialog box without deleting anything.

Note: If you are using the CompareRite program on a network, you can only delete global option sets if you have read-write-create privileges in the global option set library directory (specified by running the COINST program).

Close. Highlight an option set and click on CLOSE to return to CompareRite Main Menu. The option set you selected is specified for the current CompareRite session.

Help. Click on Help for information on current menu selections.


About Chapter 2

If you have a network version of CompareRite, you can install the program on the file server in your firm and set it up so that it can be accessed by anyone on the network. To do so, run the MAKENET program as described in this chapter. Then use the NETMGR program to customize network set up for your firm.

This chapter describes network set up in detail. Read:

•	Initial Set Up for information on system requirements, creating a network version of the program, and accessing network set up,

•	 Understanding Network Set Up Options for a review of how the CompareRite network scheme works,

•	Walkthrough Exercises for a step-by-step description of network set up,

•	Override Table  and Access Table for quick reference as you choose the appropriate set up options for your firm,

•	Defining Option Set Libraries  to learn how to specify the location of personal and global option set files.

After you complete network set up, the program will be accessible by all network users. In addition, the program retains setting and report information for each user.


Initial Set Up

To install the CompareRite program on your network, follow these steps:

•	review the list of requirements,

•	create a network version of the software by running the MAKENET program on a standalone version of the product,

•	run the NETMGR program to customize network set up for your firm.

This section describes each of these steps.

Related Topics:

Requirements

Installation


Requirements

Before you start, make sure you conform to the following requirements. Note that these are in addition to those described under instructions for standalone installation. See User Manual Chapter 2, Installation & Set Up, for details:

Operating system: MS-DOS version 3.0 or above.

Network: CompareRite has been tested on the NOVELL network and under networks that run directly from DOS 3.0. If you are using a network from DOS 3.0, you must use the DOS SHARE program, included on the DOS diskette.

File access: Make certain that all program files are in a main Search directory, that is, a directory that everyone can access from their node without typing a drive or directory specifier. This directory should be available, with read-write privileges, for all your users. If that is a problem, you can make it read-only if you set up Personal Directories for your users.

Disk drive: Hard disk with a minimum of 1.5 MB of free space. Temporary files for users will require additional space; however, if you set up Personal Directories for your users, these files will not necessarily be written to the server.


Installation

To begin, install a standalone copy of the CompareRite software on your file server as described in the User Manual Chapter 2, Installation & Set Up. Then run MAKENET to create a network version of the software:

1	At the CompareRite directory prompt, type MAKENET and press Enter.

2	A message displays, prompting you to enter the drive and directory where your CompareRite program is located.

3	Enter the drive and directory information. For example, if the CompareRite program is located on the C drive in the CO5 directory, type C:\CO5 and press Enter.

4	A message displays, indicating that MAKENET is complete.

Once you have completed the MAKENET program, run NETMGR to customize network set up for your firm:

1	Make sure that you have read-write-create privileges in the CompareRite program directory, as the NETMGR program creates or amends certain files during the setup process.

Your users also need read-write privileges in the CompareRite program directory. If you do not wish to give users read-write privileges to this directory, you can set up a Personal Directory for your users, as described below. In that case you'll have to give each user read-write privileges in his or her Personal Directory.

2	Type NETMGR COMPARE from the CompareRite program directory prompt and press Enter. The opening screen of the NETMGR program displays.

Follow the guidelines below to set up CompareRite for your firm.


Understanding Network Set Up Options

You'll find some network options very straightforward, but the resulting set up requires the end-user to remember and use a user-id. Other methods make it a breeze for the user to access the program, but require considerable sophistication on the part of the network administrator.

The NETMGR program performs three functions:

•	Limits the number of users who have access to the program at any one time:

The Concurrent method limits the number of people who can access the program at one time, but does not require that access be confined to a set of predefined users.

Note: If you purchased a 5 User-ID network version of CompareRite, access is restricted to the five users who are assigned these user-ids. Other users on the network will not have access to the program. YOU CANNOT SET UP A 5 USER-ID NETWORK VERSION FOR CONCURRENT ACCESS.

The User-ID method maximizes the number of people who can access the program at one time, but requires the network administrator to assign each access point to a specific user. Creating and maintaining user-ids can be quite time consuming, especially in large firms.

Note that the ratio of available user-id nodes to concurrent nodes is 10 to 1.

•	Determines where user files should be stored:

The Personal directory set up option places each user's files in a given directory, making it possible to restrict write access to the network. Whether or not a personal directory is specified, user files have the user's id as a suffix. If no personal directory is specified, user files are written to the program directory.

Under the Concurrent method, if the personal directory is a unique personal directory for each user, the program can track users by means of a common id (SYS), as described below.

•	Identifies each user:

The program must be able to identify each user so that it can correctly assign stored information to the person who created that information. This enables the program to match to the correct user previous document selections, menu settings and personal option sets.

The program uses one or more of these options to identify users:

The user manually types in a User-ID at run-time. The program uses this id as the extension for the user files associated with that CompareRite session. This option is set up through use of the User-ID method, or by responding Yes to the prompt, Do you want your users to be able to type in a user ID?

The Environment variable set-up option tracks the user and his/her files by means of a user-id which is entered using an environment variable. The user-id is specified by placing the appropriate DOS SET command in each network node's AUTOEXEC.BAT file. To use this option, the network administrator must also supply the name of the environment variable next to the prompt user ID environment variable:. When an environment variable is used, users with that variable set will be able to access CompareRite without entering a user-id.

NOTE: Your firm can quickly use the environment variable option if your office already uses an environment variable (for example, with a network copy of WordPerfect). If an environment variable is already in place, the same environment variable can be used with a network version of any Jurisoft product.

A Common-id can be used by the program to log users if you set up CompareRite using the Concurrent method and specify a personal directory that is a unique physical location for each user (e.g., C:\, which points to each user's individual PC). All user files will have the same names and extension (SYS), since each user's files will presumably be stored in a unique location. The option is set up by responding Yes to the prompt, Can all your users use a common ID? When the program uses a common-id, all users with that personal directory can access CompareRite without entering a user-id.

NOTE: If the personal directory specified is NOT a unique physical location and users are permitted to use a common-id, users will generate files with the same names, and will thus overwrite each other's files.

Your first step in setting up CompareRite on a network is to determine whether you will use the User-ID method or the Concurrent method. Remember, however, that you cannot set up a 5 User-ID network version for concurrent access. Not all of the options described above are available under both options. Once you have selected an access method, review the appropriate set up scenario, below.

Related Topics:

What kind of firm should set up CompareRite using the User-ID method?

What kind of firm should use the Concurrent method?


What kind of firm should set up CompareRite using the User-ID method?

The User-ID method is attractive to firms with a small number of users and low turnover in personnel among those users:

•	This method doesn't require special set up on each user's PC.

•	Everyone in the firm can have access to the program at the same time.

The drawbacks of the user-id method are as follows:

•	Each user must be assigned a user-id and use that user-id to access the program.

•	The network administrator must keep track of the user-ids and enter them into a grid. This can become annoying if a significant number of people require a user-id, or if personnel turns over frequently.


What kind of firm should use the Concurrent method?

Most customers, especially those in large firms, will want to use the Concurrent method:

•	This method does not require the administration of user-ids.

•	In most cases, network administrators can use the environment variable or common-id set up option. The user then does not have to remember a user-id or enter one to access the program.


Walkthrough Exercises

Read through the walkthrough exercise associated with the access method you've selected. For additional set up information, refer to the Access Table and Override Table at the end of this chapter.

Related Topics:

Setting Up the User-ID Method

Setting Up the Concurrent Method


Setting Up the User-ID Method

Winifred is the office manager at a small law office. The five lawyers are computer literate and do most of their own work. They don't mind entering a user-id to access CompareRite. The lawyers have worked together for years and have no plans to hire additional staff.

Winifred set up WordPerfect on the network using personalized batch files, so no environment variable is currently in use. In addition, the firm has just bought a new file server with a 500 megabyte hard drive, so there is plenty of room on the network for temporary files.

As the firm purchased a 5 User-ID copy of the CompareRite program, Winifred must set up program access for use with the User-ID method.

Winifred begins by typing NETMGR COMPARE and pressing Enter from the CompareRite program directory prompt.

The NETMGR opening screen displays.

Winifred selects the User-id method. She's prompted to specify an environment variable.

Since Winifred's firm does not use an environment variable, Winifred leaves the environment variable option blank.

This means that users will be required to enter a user-id each time they access the program.

Winifred would specify an environment variable if she didn't want users to be required to enter a user-id to access the program. Of course, this would mean more work for Winifred, as she would have to include the SET command in the AUTOEXEC.BAT file on each user's PC.

(Technical note: A network administrator might select the user-id method and then specify an environment variable in order to restrict access to only those users whose environment variable is set to an id included in the user-id grid.)

Winifred presses Enter to continue to the user-id grid screen.

Since Winifred has a 5 user-id copy of the program, the grid screen provides 5 user-id boxes.

Winifred creates a user-id for five network nodes by entering the three initials of the five lawyers in the firm.

(Technical note: If you specified an environment variable, each user-id must match a user-id included in the SET command on a user PC. The user-id can be any one to three letter or number combination.)

Winifred notes the personal directory option at the bottom of the grid screen. Winifred could use the personal directory option to save space on, or restrict write access to, the network drive. She could press PgDn to specify a personal directory for the user-id she just created. She would then enter a directory name for that user, for example, C:\CO5. The user files associated with that ID would then be written to the C:\CO5 directory on the user's PC, rather than to the program directory on the network drive.

Because she is using the User-ID method, Winifred could specify personal directories with different names for each user.

Winifred completes the five user-id boxes, then presses Esc to create the user-ids she specified.

The CompareRite program is now ready for use by her firm.


Setting Up the Concurrent Method

Pat is the MIS manager at Big, Big & Huge. The firm has 200 people who need access to CompareRite. Since the firm already requires each person to use passwords for other applications, Pat's boss has requested that no passwords be required to access CompareRite.

Pat decides to use the Concurrent method.

Pat types NETMGR COMPARE and presses Enter from the CompareRite program directory prompt.

The NETMGR opening screen displays.

Pat selects the Concurrent method and the concurrent setup options screen displays.

The program must use one or more of the options listed to track concurrent users.

Pat presses Enter to move from one option to the next:

•	User-ID Environment variable. The program uses the user-ids supplied by the environment variable to track users.

Since the environment variable USERNAME is already in use at Big, Big & Huge (the command SET USERNAME=xxx is in the AUTOEXEC.BAT file on each user's PC), Pat types in USERNAME next to the User-ID Environment Variable option.

Note: CompareRite only uses the first three letters of an environment variable setting.

•	Personal directory for all users. Under the concurrent method, each user's personal directory must have the same name. Pat could create an area for each user on the network with the same name from each node's point of view (i.e., J:\) or create a directory on each user's hard disk for this purpose (i.e., C:\CO5), which would save space on the network.

(Technical note: Pat could have chosen a network directory which does not point to a unique location for each user (e.g., Z: on a Novell network), but then Pat would be unable to make use of the common-id option.)

If Pat does not specify a personal directory, all user temporary files will be written to the CompareRite program directory.

Since Pat is a crackerjack network administrator, a special directory for temporary files (called C:\TEMP) has already been created on each user's PC. Pat enters C:\TEMP as the personal directory for all users.

Pat has set up CompareRite using both the environment variable and personal directory options. This enables users to access the program without typing in a user-id and saves space on the network drive, as all user files will be written to the hard disk at each network node.

If Pat did not specify a user-id environment variable, the network would have to be set up to log users by utilizing a common id or by permitting users to type in a user-id when accessing the program.

After Pat finishes moving through all options, prompts display regarding the use of a common id and/or user-ids.

Since the network set up at Big, Big & Huge will use an environment variable to track users, Pat ponders the purpose of these prompts.

The answers to these questions determine how the network will handle users who do not have an environment variable and/or a personal directory on their PC:

•	If all PCs have the personal directory specified under the Personal directory for all users option and this directory points to different physical locations, Pat can respond Yes to the prompt Can all your users use a common ID? The result will be that even users without an environment variable set will only have to type CompareRite to access the program. With the common-id set, the program will name all users who do not have an environment variable SYS. This only works when the personal directory points to different physical locations for each user, since all user files will have the suffix SYS and be stored in the personal directory.

•	If all PCs have the personal directory specified under the Personal directory for all users option, but the directory is shared by some users, Pat should respond No to the prompt Can all your users use a common ID? Then, when prompted Do you want your users to be able to type in a user-ID? Pat should respond Yes to permit access to the program even to users without an environment variable. These users can enter any three letter user-id to access the program. The program will write these user files to the personal directory, using the user-id entered to keep track of them.

(Technical note: A PC must have the personal directory specified under the Personal Directory for All Users option in order to have access to CompareRite.)

Pat responds No to both prompts, thereby requiring users to have an environment variable in order to have access to the program.

(Technical note: If Pat decided not to specify a personal directory, only the Do you want your users to be able to type in a user-ID? prompt would display. Pat would have to respond Yes to this prompt to allow access to users without an environment variable. These users would then enter any three letter user-id to access the program. The program would write user files to the program directory and track them using the user-id entered.)

On completing these prompts and pressing Enter to return to the directory prompt, Pat chuckles at how easy it was to set up CompareRite on a network. "I thought this would take me all day," the MIS manager muses, "I guess I have time to have lunch with my friend today after all."


Override Table

If the network administrator (NA) uses more than one set-up option, use this table to determine which option takes precedence.

If the NA uses...	And...	Then...
User-ID method	Environment variable	CompareRite will use the first three letters of the environment variable. These three letters must match a user-id specified in the grid. If the environment variable does not exist on that PC, the user must type in the user-id.
Concurrent method	Environment variable as well as user-id entered manually by user	User will be prompted to enter a user-id if environment variable has not been set on that user's PC.
Concurrent method	Environment variable, personal directory and common-id	CompareRite uses the environment variable. If no environment variable, then common-ID (SYS) is used.
Concurrent method	Environment variable, personal directory, NO common-id	User files have the three letter extension specified in the environment variable. Users without the environment variable must manually enter any user-id (if this is permitted).
Concurrent method	Common-ID as well as user-id entered manually by user	This is an impossible combination. Once you answer yes to the common-id prompt, manual user-id prompt isn't given as an option.
Concurrent method	Personal directory and no common-id; users permitted to enter user-ID manually.	Users can use any three-letter combination. User files with that extension will be written to the personal directory. Users without that personal directory will not be permitted to run the program.


Access Table

First determine who needs access to the program. Then use this table to determine which set up options to use.

EV = Environment Variable

PD = Personal directory

C-ID = Common ID

U-ID = User can type in ID

Method	Set-up Options				Who has access?
	EV	PD	C-ID	U-ID
User-ID			N/A	N/A	Users assigned a user-id by the network admin. Users must enter this id to access the program.
User-ID	X		N/A	N/A	Users assigned a user-id by the network administrator which matches the user-id specified in the env. variable. If env. variable is not set up, user can type in a user-id specified by the network admin.
User-ID	X	X	N/A	N/A	Users assigned a user-id by the network administrator which matches the user-id specified in the env. variable. Personal dir. must exist. If env. variable is not set up, user can type in a user-id specified by the network admin.
User-ID		X	N/A	N/A	Users assigned a user-id by the network admin. Users must enter this id to access the program. Personal dir. must exist.
Concurr				X	Any user can type in any three letter id.
Concurr	X				Users with PCs set up with that environment variable.
Concurr	X			X	Users with PCs set up with an environment variable; all others must type in any three letter id.
Concurr		X	X		Users with the personal directory specified.
Concurr		X		X	Users with the personal directory specified; must type in any user-id.
Concurr	X	X	X		Users with the personal directory specified. (Files associated with users with an env. variable will have that user-id as a suffix; files associated with users without an env. variable will have SYS as a suffix.)
Concurr	X	X		X	Users with PCs set up with that environment variable; all others must type in any three letter id. ALL users must have the personal directory


Defining Option Set Libraries

Once you have completed network installation and set up, run the COINST program to specify the location of option set libraries.

The network version of the CompareRite program enables you to create two separate libraries of option sets. Each library can contain up to 26 different option sets. You specify the drive and directory location of the libraries.

We recommend that you create a global option set library for use by all users on the network, and a personal option set library to enable individuals to create their own option sets for their exclusive use:

•	The global option set library should be located in a drive and directory which is accessible by all users. We suggest that you restrict user access to these files to read-only. Users will then be able to use, but not modify or delete, global option sets.

•	The personal option set library can be located in the personal directory (as specified during the NETMGR program) or the program directory.

To run COINST to specify the location of option set libraries, follow these steps:

1	From the CompareRite program directory prompt, type COINST and press Enter.

2	You are prompted Do you want to create a Global Option Set Library? (Y/N):

•	Press Y to create a global option set library. You are prompted to provide the full pathname of the option set library name and location. For example, to create an option set library file name GLOBAL.OSL in the CompareRite program directory CO5 on the network drive I, type I:\CO5\GLOBAL.OSL and press Enter.

Note that the CompareRite program will not warn you if you specify an invalid path, nor if this directory is not accessible by your users.

•	Press N if you wish your users to have access to only one option set or personal option sets.

3	You are prompted Do you want your users to have a Personal Option Set Library? (Y/N):

•	Press Y to create a personal option set library for each network user. You are prompted to provide the full pathname of the option set library name and location. Specify either the personal directory or the CompareRite program directory. For example, to create an option set library file name PERSONAL.OSL in each user's personal directory (specified as part of the MAKENET program), type C:\TEMP\PERSONAL.OSL, (where TEMP is the personal directory name specified during MAKENET) and press Enter.

If you specify the personal directory as the personal option set library location, the CompareRite program stores the program file PERSONAL.OSL in that directory.

If you specify the CompareRite program directory as the personal option set library location, the CompareRite program stores the program file PERSONAL.xxx, where xxx is each user's user-id, in the program directory.

•	Press N if you wish your users to have access to only one option set or only global option sets.

4	The CompareRite program displays the COMPARE.INI file, modified to include the option set libraries you specified. You are prompted Is this what you want (Y/N):

•	Press N if you wish to make changes. The program displays you with the necessary prompts to specify the global and personal option set library locations.

•	Press Y to modify the program COMPARE.INI file and exit the COINST program.

If you specified a global option set library, you (or any user with read-write-create privileges to the directory you specified) can create, modify or delete global option sets. Anyone with read-access to this directory can use the option sets.

If you specified a personal option set library, each  user with read-write-create privileges to the can create, modify or delete global option sets for his or her individual use.

If you specified neither a global option set library nor a personal option set library, users will have access to only one option set (included in the option set list as OPTION SET), located in the CompareRite program directory.

To change the name or location of either option set library, run the COINST program again or edit the COMPARE.INI file as described in Customizing the Initialization File.


About Chapter 3

This chapter describes several advanced CompareRite program functions. Read this chapter to learn more about these features:

•	Read the section Custom Help  to learn how to create a custom help screen for your users.

•	The section Customizing the Initialization File  describes how to tailor the COMPARE.INI file to specify default document directories, change the location of your global and personal option set libraries or personalize your CompareRite menus.


Custom Help

Version 5.0 of the CompareRite program provides an optional user defined help file. To create this file, use an ASCII editor (such as DOS EDIT) to create a file with the information you wish to provide to your users. This file can have a maximum length of ten eighty character lines. Include the path and filename of this file in the COMPARE.INI file (see Customizing the Initialization File). Users can then retrieve this information by choosing Custom from the Help menu, accessed from the CompareRite main menu.


Customizing the Initialization File

The COMPARE.INI file is a CompareRite program file containing information pertaining to your CompareRite program set up. Most of the data in this file is default information or information you provide during the set up process.

To display the COMPARE.INI file, retrieve the file using an ASCII editor, such as the DOS EDIT command or the Windows Notepad.

The COMPARE.INI enables you to modify the following information:

BANNER1	=

BANNER2	=

The CompareRite program Main Menu includes two lines of text at the bottom of the screen. In the Windows version, the default text is Jurisoft copyright information. In the DOS version, these two lines of banner text provide information on navigating the Main Menu.

You can change these two lines of text to include any information you want to display on the Main Menu screen. Simply use your ASCII editor to delete the existing text and substitute the text you want.

OSL1	=

OSL2	=

These lines indicate the drive and directory location, as well as the filename, of the option set libraries. The default set up for standalone users is a single option set library, located in the CompareRite program directory. Standalone users can edit the COMPARE.INI file to create a second option set library.

The CompareRite program obtains OSL1 and OSL2 information for network users from the COINST.  program. The system administrator can edit the COMPARE.INI file to change the drive and directory location or filename of the global option set library or the personal option set library. The information associated with the global option set library is stored as OSL1; the personal option set library information is OSL2.

PATH_F1	=

PATH_F2	=

PATH_F3	=

Use these lines to specify default document directories. PATH_F1 is the default document directory for the original document; PATH_F2 is the default document directory for the revised document; PATH_F3 is the default document directory for the redline document. Once you have specified default document directories, you can simply enter a filename into a document field and the CompareRite program will provide the associated pathname.

HELPFILE	=

This line provides the drive and directory location, as well as filename, of any custom help file you choose to create. Refer to the section Custom Help  for additional information.


About Appendix A

This chapter describes the redlining options available through the CompareRite program. Use these options to specify format and information you wish to include in your redline document. For example, the redlining settings you choose determine how deletions and additions will be shown and whether or not your report will include a list of changes.

To create a redline document, you'll generally simply select a ready-made set of options from a list you access from the Main Menu. This option set defines the default settings that the CompareRite program will use when creating your redline document.

Refer to this appendix to review each redlining option and its associated settings. This will make it easier for you to select the appropriate option set and retrieve the information you need.

See Also

Preferences Options

Methods Options

Deletions Options

Additions Options

For more information on Option Set Set Up, refer to Creating An Option Set


Additions Options

To access the options associated with additions, select Additions from the Main Menu.

Use the settings associated with addition options to specify how additions will be shown in your output document.

An addition is defined as text which is included in the revised document, but not in the original document.

Note: Your settings may vary, depending on the word processor you specify.

Related Topics:

Changed Text

Surrounding Characters

Appearance In Document

Appearance On Screen


Appendix A. CompareRite Options - Additions Options - Changed Text
Changed Text

You must show the complete text of additions in the redline document.


Appendix A. CompareRite Options - Additions Options - Surrounding Characters
Surrounding Characters

Specify the characters, if any, that will mark the beginning and end of a section of added text.

For example, if you selected curly braces, an addition might look like this:

Here is the original sentence. {This sentence was added to the revised document.}

You may specify your own surrounding characters, none at all, or choose any of the following sets of characters:

[ ]	{ }	\ \	" "	< >

Make sure you do not select the same set of characters for additions as you do for deletions.


Appendix A. CompareRite Options - Additions Options - Appearance In Document
Appearance In Document

Specify how you wish added text to appear in the output document.

For example, if you selected underlining, an addition might look like this:

Here is the original sentence. This sentence was added to the revised document.

Make sure you do not select the same setting for the appearance of additions as you do for deletions.

Note: Your settings will vary, depending on the word processor you specify.

For example, if you have specified WordPerfect as your word processor, you may choose any of the following formats or no special format at all:

Bold

Underline

Bold-Underline

Strikethrough

Redline

Double Underline

Bold + Double Underline

Italics


Appendix A. CompareRite Options - Additions Options - Appearance On Screen
Appearance On Screen

Specify how you wish added text to appear on the screen. For example, if you selected inverse, additions will be displayed on a light background with white characters.

Your redline document will only appear on the screen if you do not specify a redline document filename.

Make sure you do not select the same setting for the appearance of additions as you do for deletions.

You may choose any of the following formats:

White	Red	Yellow

Bright White	Bright red	Brown

Inverse	(light background, white characters)

Blue  	(underline on most monochrome monitors)

Bright Blue 	(bright underline on most monochrome monitors)


Deletions Options

To access the options associated with deletions, select Deletions from the Main Menu.

Use the settings associated with deletion options to specify how deletions will be shown in your output document.

A deletion is defined as text which is included in the original document, but not in the revised document.

Note: Your settings may vary, depending on the word processor you specify.

Related Topics:

Changed Text

Surrounding Characters

Appearance In Document

Appearance On Screen


Appendix A. CompareRite Options - Deletions Options - Changed Text
Changed Text

Specify how you wish to show deletions in the redline document. Choose between these options:

Full Text

This setting includes the complete text of the deletion in the redline document.

Use this setting to show precisely what was deleted from the original document, as well as to gain the best understanding of how CompareRite created the redline document.

Replace by ^

This setting shows where text was deleted from the original document by replacing it with the carat symbol (^).

Use this setting when you wish to create a redline document closely resembling the revised document.

Do NOT use this setting if you need to confirm that specific text was deleted from the original document.

Replace by #

This setting shows where text was deleted from the original document by replacing it with the pound sign (#).

Use this setting when you wish to create a redline document closely resembling the revised document.

Do NOT use this setting if you must confirm that specific text was deleted from the original document.

No Text

This setting does not show where text was deleted from the original document.

Use this setting when you wish to create a redline document which matches the revised document.

Do NOT use this setting if you must confirm that specific text was deleted from the original document.

Text at End

This setting replaces each deletion from the original document with a number in the revised document. A corresponding list of the full text of deletions is included at the end of the redline document.

Use this setting when you wish to create an output document closely resembling the revised document, but also need to proof the full text of the deletions.

Abbreviated text

This setting shows a few words of text from each deletion. For example, the deleted sentence The cat sat in a huff on the mat is shown as The cat sat ... on the mat.

Because the redline document will show several words from the beginning and end of the deletion, at least six words must be deleted before text will be abbreviated at all.

Use this setting to get a suggestion of what was deleted, without taking up the space of showing the full text.


Appendix A. CompareRite Options - Deletions Options - Surrounding Characters
Surrounding Characters

Specify the characters, if any, that will mark the beginning and end of a section of deleted text.

For example, if you selected backslashes, a deletion might look like this:

Here is a sentence common to both original and revised documents. \This sentence was deleted from the revised document.\

You may specify your own surrounding characters, none at all, or choose any of the following sets of characters:

[ ]	{ }	\ \	" "	< >

Make sure you do not select the same set of characters for deletions as you do for additions.


Appendix A. CompareRite Options - Deletions Options - Appearance In Document
Appearance In Document

Specify how you wish deleted text to appear in the redline document.

For example, if you selected strikethrough, a deletion might look like this:

Here is a sentence common to both original and revised documents. This sentence was deleted from the revised document.

Make sure you do not select the same setting for the appearance of deletions as you do for additions.

Note: Your settings will vary, depending on the word processor you specify.

For example, if you have specified WordPerfect as your word processor, you may choose any of the following formats or no special format at all:

Bold

Underline

Bold-Underline

Strikethrough

Redline

Double Underline

Bold + Double Underline

Italics


Appendix A. CompareRite Options - Deletions Options - Appearance On Screen
Appearance On Screen

Specify how you wish deleted text to appear on the screen. For example, if you selected bright blue, deletions will be displayed as bright blue characters.

Your redline document will only appear on the screen if you do not specify a redline document filename.

Make sure you do not select the same setting for the appearance of deletions as you do for additions.

Choose any of the following formats:

White	Red	Yellow

Bright White	Bright red	Brown

Inverse 	(light background, white characters)

Blue	(underline on most monochrome monitors)

Bright Blue	(bright underline on most monochrome monitors)


Methods Options

To access the options associated with comparison methods, select Methods from the Main Menu.

Use the settings associated with method options to specify:

•	Moves. Use the Moves option if you wish to track text moved from one spot in the original document to another in the revised. Note that CompareRite only indicates if larger chunks of text, such as paragraphs, have been moved.

•	Precision. Use the Precision option to select how changes will be shown. For example, for some purposes you may be interested in focusing on changes in large chunks, whereas at other times you may wish to highlight smaller changes.

•	Skip text characters. Use the Skip text characters option to mark text you wish to exclude from the comparison.

•	Compare Notes. Use the Compare Notes option to include footnotes in the comparison. If you specify WordPerfect or Word for Windows as your word processor, CompareRite will also find changes in headers and footers.

The remainder of this section reviews each of these options in more detail.

Related Topics:

Moves

Precision

Skip Text Characters

Compare Notes


Moves

Use this option if you wish to show that a paragraph or more of text from the original document has been moved to a different spot in the revised document.

Moves are marked on a paragraph basis. This means that if you have moved several sentences from within one paragraph to another, they will not be shown as moves. In addition, if, for example, three consecutive paragraphs are moved, each paragraph will be separately marked as moved.

If you choose not to show moves in the redline document, moved text will be shown has having been deleted from its location in the original document and added to its new location in the revised.

Note that moved text is shown as normal text in the new location. This enables CompareRite to show minor changes that have been made to the moved text. If, however, a paragraph is moved and then highly edited, CompareRite will consider it as new, rather than moved, text.

Choose from the following settings:

Do not show moves

Moved text shown as deleted from its location in the original document and added to its new location in the revised.

Show moves

A numbered marker (for example, *1) indicates the location of moved text in the original document.

Text is shown in its entirety as normal text in its new location in the revised. A corresponding numbered marker (for example, ** 1) is marked as added text in the new location.

Show moves in both locations

Moved text is shown as deleted from its location in the original document, and as normal text at its new position in the revised document. The text is numbered in both locations (for example, original location is marked * 1 and the new location as ** 1). The number marker is marked as added text in the new location.


Precision

Indicate what you wish to be shown as a change in your output document.

If you have ever manually redlined a document, you are familiar with the issues associated with redlining style. Some readers of redlined documents want to know if a sentence from the original and the corresponding sentence in the revised document have even one word in common. Others are not as interested in the fine points, and are content to know simply that a sentence has been changed.

The comparison style setting enables you, as much as possible, to create redline documents using the style appropriate to your office or audience. The pinpoint method shows changes on the most micro level; the broad method on the most macro. Normal falls somewhere in between.

Programmer style is intended only for comparing revisions of source code.

Each description includes an illustration of how each setting shows a comparison of the following two paragraphs:

ORIGINAL

Despite words contained in this document that say other things, if the leased premises ever become governed by laws that control the maximum rental price of apartments, the Lessee shall not pay more than the maximum rent allowed under such applicable rent control laws or other laws regulating rents.

REVISED

Notwithstanding anything contained herein to the contrary, if the leased premises are or become subject to rent control laws or other laws regulating rents, the Lessee shall pay not more than the maximum rent allowed under such applicable rent control laws or other laws regulating rents.

Pinpoint

CompareRite does not combine most changes.

For example, the redlined document of the above paragraphs reads:

[Despite words] Notwithstanding anything contained [in this document that say other things] herein to the contrary, if the leased premises [ever] are or become [governed by laws that control the maximum rental price of apartments] subject to rent control laws or other laws regulating rents, the Lessee shall pay not more than the maximum rent allowed under such applicable rent control laws or other laws regulating rents.

Redlined documents created using this setting show changes in many small segments.

Normal

CompareRite combines changes which have moderately few words between them.

For example, the redlined document of the above paragraphs reads:

[Despite words contained in this document that say other things] Notwithstanding anything contained herein to the contrary, if the leased premises [ever become governed by laws that control the maximum rental price of apartments] are or become subject to rent control laws or other laws regulating rents, the Lessee shall pay not more than the maximum rent allowed under such applicable rent control laws or other laws regulating rents.

Redlined documents created using this setting show changes in an average number of medium segments.

Broad

CompareRite combines changes which have a larger number of dissimilar words between them.

For example, the redlined document of the above paragraphs reads:

[Despite words contained in this document that say other things, if the leased premises ever become governed by laws that control the maximum rental price of apartments] Notwithstanding anything contained herein to the contrary, if the leased premises are or become subject to rent control laws or other laws regulating rents, the Lessee shall pay not more than the maximum rent allowed under such applicable rent control laws or other laws regulating rents.

Redlined documents created using this setting show changes in an small number of large segments.

Programmer source code

Use this setting to compare versions of source code, for example:

begin (*initialize screen set up important variables*)

Answer := false;

EndOfDir := false;

ScreenDestroyed := false;

FileBegin := true;

i := 4;	initialize past header list

while( IsDirChar( DirStr[ j i ] ) ) do i := succ(i);

end;


Skip Text Characters

Use this option to mark text you wish to exclude from the comparison.

To streamline the review of your redline document, you may at times wish to exclude certain portions of your documents from the redlining process.

Examples of the kind of text you might want to exclude from the comparison include:

•	Lists from the original document which have been alphabetized or otherwise reorganized in the revised document. Exclude this text from the comparison to spare yourself a line-by-line review of text which has been reorganized but otherwise unchanged.

•	Large sections, such as entire chapters, which have been added to, or deleted from, the revised document. Review of such text is unnecessary, as you know the entire section has been added or deleted.

To exclude text from the comparison, use skip text characters to mark the beginning and end of the passage to be excluded from the comparison. If the text appears in both the original and the revised documents, you must mark the text in each document.

In the redline document, skipped text is shown as follows:

•	Any text marked with skip text characters in the revised document is included in the redline document as normal text.

•	Any text marked with skip text characters in the original document is excluded from the redline document. The words Skipped Text Deleted appear in its place, formatted as a deletion. Note that, if you indicate deletions as a character, only this character (such as ^) is shown.

After you have completed the comparison, remember to remove the characters from your documents using your word processor.

Use any of the following skip text character pairs or none at all:

||	@@	//	\\


Compare Notes

Use this option to redline changes to footnotes.

At the end of the redlined document, a separate section shows the footnotes and redlines any changes. The footnotes are listed and numbered in the order in which they are found in the document.

The CompareRite program will also compare the headers and footers found in WordPerfect and Word for Windows word processor files. A separate section at the end of the redline document shows these changes.

Depending on your footnote numbering scheme, the CompareRite program's numbering of your footnotes may not always be the same as the way the numbers appear in your document. For example, if you have numbered the fourth footnote in your document number 1, CompareRite would still consider this footnote as the fourth footnote. (If, however, you are using WordPerfect, CompareRite will indicate the correct footnote number or character.)

Any footnotes you see in the body of the CompareRite draft will be the same as the footnotes in your revised document.


Preferences Options

To access the options associated with your word processor and with the organization and contents of your redline document, select Preferences from the Main Menu.

Use the settings associated with preferences options to specify:

•	Word processor. Use the Word processor option to specify the word processor used to create the original and revised documents. Note that you can compare documents created using different word processors, but that the redline document will always be in the same word processor format as the revised document.

•	Description page. Specify if you wish to include a description page in the redline document. The page indicates the filename and path of your documents, as well as how additions and deletions are shown.

•	Revision list. Specify if you wish to include a revision list as part of your redline document. This list provides an abstract of the changes you made to the original document.

•	Output options. Use this option to specify settings specific to the word processor you selected for your revised/redline document.

This section reviews each of these options in more detail.

Related Topics:

Word Processor

Description Page

Revision List

Output Options


Word Processor

Use this option to specify the word processor format of your original and revised/redline document.

Special note to DisplayWrite users: You must convert DisplayWrite 5 documents to DisplayWrite III or IV format (or DCA) before using them with the CompareRite program. If you are using DisplayWrite III, you must use a .TXT extension when naming redline documents.

Special note to MultiMate users: CompareRite handles MultiMate documents through version 3.x. Convert MultiMate version 4 documents (with a DOX extension) to MultiMate 3 documents (with a DOC extension) before comparing. Also, CompareRite does not compare MultiMate footnotes.

Special note to WordPerfect 6 and Word for Windows users: You must fully save your documents. CompareRite cannot compare fast saved documents.

Special note to WordStar users: CompareRite 5.0 reads files created using versions 3.3-6.0.

See also the section on Output Options  for information on settings specific to your word processor.


Description Page

Use this option to specify if you wish to include a description page as part of your redline document. The description page tells you which files CompareRite used to create the redline document, as well as how additions and deletions are shown.

Choose from the following settings:

No description page

No description page is included in the redline document.

Include at beginning

The description page is the first page of the redline document.

Include at end

The description page is the last page of the redline document.


Revision List

Use the Revision List option to include a summary list of the changes made to your original document.

You can choose one of two types of lists or no revision list at all. The short form changes list provides a one line summation of each change. The long form changes list shows the entire text of each change.

Each revision list provides information on the location of each change and the type of change. In addition, the long form list provides context from pertinent paragraphs to make it easier to identify each change.

Each list indicates the page and paragraph location of each change in both the original and revised document. For example, the notation [2:1 3:2] indicates that the changed text is located on page two, paragraph one of the original document, and page three, paragraph two of the revised document.

The revision list provides information on the type of each change. All additions, deletions and substitutions of new text for old are called changes. If every occurrence of a particular word, phrase or sentence has been changed in the same way in a given paragraph, the change is reported once as changed all. Added or deleted paragraphs are reported as added or deleted paragraphs. Corresponding location information for such paragraphs indicate the actual location of the paragraph in the document in which the paragraph is included, and the location of the paragraph immediately prior to the position of the missing paragraph in the document in which the paragraph is not included.

Moved paragraphs are included twice in the list of changes; once to indicate where the paragraph was moved from, and a second time to indicate where the paragraph was moved to. In both instances, the location information represents the proper position of the moved paragraph in each document.


Output Options

Use this option to specify settings specific to the word processor you selected for your revised/redline document.

Your settings will vary, depending on your word processor selection.

Ami Pro

No special output options are associated with Ami Pro.

ASCII

Paragraph boundary. Indicate the convention used to separate one paragraph from the next. Choose from every return, two returns and any return followed by space, tab or return.

Begin/End User Defined. As ASCII does not have standard means of indicating formatting, you must use the setting associated with ASCII output options to specify the character strings which will begin and end each addition and deletion. Refer to your printer manual to learn which control codes are used by the printer to define underline and bold formatting.

Then specify them as follows:

To specify a character, type its ASCII code number by holding down Alt and typing the number on the numeric keypad. For example, to type an asterisk (ASCII 42), press Alt and type 42 on the numeric keypad. The character appears on the line.

Many characters can be entered directly. For example, type A to enter it.

Press Alt and 13 on the numeric keypad to specify a return.

Press Alt and 8 on the numeric keypad to specify a backspace.

Press Alt and 27 on the numeric keypad to specify an escape sequence.

DCA/RevisableFormText

Strikeout character. Use this option to define what will be used as a strikeout character if you choose to indicate changes using overstrike characters. Specify dash, forward slash or backward slash.

DisplayWrite 3/4

Strikeout character. Use this option to define what will be used as a strikeout character if you choose to indicate changes using overstrike characters. Specify dash, forward slash or backward slash.

MS Word (DOS)

Font for Additions/Deletions. If you are using a printer that supports multiple fonts, you can show additions in one font and deletions in another. CompareRite prints the addition or deletion in the specified font and reverts to the base font for the text which follows. Font numbers correspond to the font groups listed in the Microsoft Word manual, but use the following table as a guide:

0:	Do not change fonts

1-15:	Modern a through p

16-32:	Roman a through p

33-40:	Script a through h

41-48:	Foreign a through h

49-56:	Decor a through h

57-64:	Symbol a through h

Revision marks. Specify whether you wish to include revision marks in your redline document, and, if so, where they are to appear. If you choose to use revision marks, they appear in addition to any text format you selected under Additions Options. Specify no revision marks, revision marks on left side, revision marks on right side or revision marks on alternating sides.

MS Word (Windows)

No special output options are associated with Word for Windows.

MultiMate

No special output options are associated with MultiMate.

OfficeWriter

No special output options are associated with OfficeWriter.

WordPerfect 4.x to 5.x

Redline mark additions/ deletions. If you use WordPerfect 4.2, CompareRite marks additions or deletions with change bars if you choose the corresponding setting. If you use WordPerfect 5.x, CompareRite redlines your additions and deletions in addition to any formatting you selected under addition and deletion options.

WordPerfect 6.0

No special output options are associated with WordPerfect 6.0.

WordStar

Right margin column. Prior to version 4.0, WordStar did not record margin settings within documents. Thus, you must use this option to provide CompareRite with a right margin setting for the redline file. CompareRite uses the .RM (right margin) and .RR (embedded ruler line) commands associated with this number.

XyWrite

User mode #1/#2. Specify a XyWrite mode to define your printout format for additions and deletions. For example, if you wish additions to appear in superscript mode (MDSU) and deletions to appear in normal redline delete mode (MDDN, available in XyWrite III+), define user mode #1 as SU and user mode #2 as DN. Then select these modes from the Additions and Deletions Options. Note that you do not include the MD prefix when defining a mode. Instead, give only the two letter suffix (such as SU or DN) which defines the mode.


About Appendix B

You'll generally have no problems using the CompareRite program. But if you do, use this chapter for assistance.

•	If you are experiencing difficulties creating a redline document, refer to the section Program Troubleshooting

•	If you have created the redline document but do not understand the comparison it has created, refer to Redline Document.

If you require additional assistance, call Customer Support. Calling Customer Support describes what information to have on hand before calling Mead Data Central Customer Support at (800) 543-6862.


Program Troubleshooting

Although the CompareRite program creates most redline documents without any difficulty, you may occasionally experience a problem.

If the CompareRite program is unable to complete a comparison, try the following:

•	Check each document for unknown codes or garbled text.

•	Use your word processor to retrieve the original and revised files and save them again.

•	Use your word processor to split the documents into smaller portions and compare these subdocuments.

•	Check to make sure you have sufficient memory and hard disk space.

If you encounter an error message indicating that the program is unable to run to completion, consult these tables for possible causes and remedies:

Error #	Message	Try the following...
-1	Can't find initialization file.	Program cannot locate the COMPARE.INI file. Check the program directory.
-102	Can't allocate memory.	Insufficient memory to run the program. Free memory, try again.
-103	Can't open file: xxx	Check access rights to file xxx.
-104	Can't read file: xxx	Check access rights to file xxx.
-105	Can't write file: xxx	Check access rights to file xxx.
-106	Invalid word processor	Word processor you specified does not match document type.
-107	Can't launch: xxx	Insufficient memory to run the program. Free memory, try again.
-108	Can't read/seek file:xxx	Check access rights to file xxx.
-109	Bad serial number.	Your license is invalid. Call Customer Service.
-110	Can't access file: xxx	Check access rights to file xxx.
-111	No next available.	No network nodes of the program are currently available. Try again.
-112	No ID given.	Your network set up requires you to enter a three character user-ID. Contact your system administrator.
-113	Bad NetID: xxx	You have specified an invalid user-ID. Contact your system administrator.
-114	Exceeded maximum concurrent users.	No network nodes of the program are currently available. Try again.
-115	Invalid path: xxx	Specified path does not exist. Correct your path statement.
-117	Can't add string to list: xxx	Insufficient memory to run the program. Free memory, try again.
-118	Not enough space for string.	Insufficient memory to run the program. Free memory, try again.
-120	Not enough memory for message box.	Insufficient memory to run the program. Free memory, try again.
-122	File is in use: xxx	You have tried to access a non-shareable file which is in use. Change the file access to shareable.
-123	Not enough memory to run.	Insufficient memory to run the program. Free memory, try again.
-127	No system memory or corrupt EXE.	Check available memory.Re-install the program.
-128	Can't find file to launch.	Re-install the program.
-129	Not enough memory to launch program.	Insufficient memory to run the program. Free memory, try again.
-1101	Command line switch too long: xxx	Check your command line for typographical errors.
-1102	Command line switch duplicated: xxx	Check your command line for typographical errors.
-1103	Command line switch unknown: xxx	You have specified an invalid command line switch. Check your batch file or command line.
-1104	Command line switch has multiple arguments: xxx	Check your command line for typographical errors; you may have mismatched quote marks.
-1105	Command line switch has illegal argument(s).	Check your command line for typographical errors.
-1111	Command line open listfile failed.	Couldn't open @FILE. Check file access rights.
-1112	Command line read listfile failed.	Couldn't read @FILE. Check file access rights.
-1114	Command line listfile contains another listfile.	You have nested a file within your listfile. This is not permitted.
-1600	Can't find message file: xxx	Check that file COMPARE.MSG is in the program directory.
-2001	Can't open COMPARE.VVD	Check access rights; you need read-access to program directory.
-2004	Can't allocate form memory: xxx	Insufficient memory to run the program. Free memory, try again.
-2012	Can't allocate memory file.	Insufficient memory to run the program. Free memory, try again.
-2013	Can't access compare.vvd file.	Check file access rights.
-2101	Can't read original file: xxx	Check file access rights.
-2102	Can't read revised  file: xxx	Check file access rights.
-2103	Can't write output file: xxx	Check file access rights.
-2104	Can't write viewer file: xxx	Check file access rights.
-2105	Can't read viewer file: xxx	Check file access rights; you need read-access to a directory.
-2106	Can't launch: xxx	Insufficient memory to run the program. Free memory, try again.
-2107	Must specify either 0 or 2 files on command line.	Your command line is missing either the original or revised document filename.
-2108	Must specify two input files.	Your command line is missing either the original or revised document filename.
-2109	Ctl_B allowed only in output file field.	You cannot use Ctrl-B in the original or revised doc fields.
-2110	Must first have file 1 specified.	You must specify a file before using Ctrl-P.
-2111	Can't overwrite input files.	You cannot give the redline doc file the same name as the original or revised document file.
-2200	Can't open option set: xxx	The CompareRite program cannot open the option set xxx you specified. Check to ensure that you have proper access rights to this file.
-2504	Not enough room on disk.	Your disk is full. Free up space on the disk and try again.
-2506	File size 0.	You have specified a file which is 0 bytes in size. Check the file.
-2507	Need 460K free memory to run engine.	Insufficient memory to run the program. Free memory, try again.
-2508	Failed malloc in engine.	Insufficient memory to run the program. Free memory, try again.
-2509	Unable to open temp file.	Check file access rights.
-2510	Unable to open temp file.	Check file access rights.
-2511	Unable to open temps file.	Check file access rights.
-2512	Reversal in changes list.	Call Customer Service.
-2513	File too complex.	File is too complex to compare. Try splitting into smaller docs.
-2514	Unable to write file.	Check access rights.
-2519	Too many changes found.	Your document has exceeded the change limitation of the CompareRite program. Split the document into smaller subdocuments and compare.
-2520	Paragraph size too big > 65000.	Your paragraph has exceeded the 65000 character limit. Split into smaller paragraphs and compare.
-2524	Not a DCA file.	Word processor you specified does not match document type.
-2528	Not a DCA file.	Word processor you specified does not match document type.
-2540	Not a MW file.	Word processor you specified does not match document type.
-2550	Improper WordPerfect file.	Word processor you specified does not match document type.
-2560	Improper WordStar format.	Word processor you specified does not match document type.
-2570	DisplayWrite file too complex.	File is too complex to compare. Try splitting into smaller docs.
-2571	DisplayWrite file write error.	Check file access rights.
-2572	Not a DisplayWrite file.	Word processor you specified does not match document type.
-2580	Not a MultiMate file.	Word processor you specified does not match document type.
-2581	MutiMate file too big.	File is too big to compare. Try splitting into smaller docs.
-2590	Not an OfficeWriter file.	Word processor you specified does not match document type.
-2595	Exceeded demo version page limit.	You are running a demo version of the CompareRite program and have exceed the 2 page limit.
-2600	Improper XyWrite file.	Word processor you specified does not match document type.
-2602	Improper Word for Windows file.	Word processor you specified does not match document type.
-2603	Either WW Gloss, Template or FS Document.	You have tried to compare a file which is not a document file.
-2604	Word for Windows file too large to create.	Formatting of your document is too complex. Try to remove some complex formatting codes before comparing.
-2606	Bad Index Value.	Call Customer Service.
-2608	To many footers to handle.	Your document has exceeded the footer limitation of the CompareRite program. Split the document into smaller subdocuments and compare.
-2608	To many headers to handle.	Your document has exceeded the header limitation of the CompareRite program. Split the document into smaller subdocuments and compare.
-2610	Unrecognized word processor.	Word processor you specified does not match document type.
-2611	Too many changes. Split and recompare.	Your document has exceeded the change limitation of the CompareRite program. Split the document into smaller subdocuments and compare.
-2612	Bad index error.	Call Customer Service.
-2613	Runtime error.	Call Customer Service.
-2619	Too many AmiPro frames.	File too complex to compare. Try splitting into smaller docs.
-2620	Too many AmiPro styles.	File too complex to compare. Try splitting into smaller docs.
-2621	Unknown AmiPro command.	File contains bad data. Retrieve using your word processor and save again.
-2622	Past end of AmiPro file.	Retrieve file using your word processor and save again.
-2623	Unable to read file.	Check access rights.
-2624	Unable to open file.	Check access rights.
-2625	Unable to send file.	Check access rights.


Redline Document

If you have trouble reading and understanding your redline document, consult this table to identify your problem and possible solutions:

Problem	Explanation/Solution
Text is improperly formatted.	Use your word processor to repaginate the redline document before printing.
Deleted text has lost its formatting.	The redline document is based on the revised document, and therefore does not include formatting for deleted text.
Tables and lists do not compare properly.	CompareRite does not support comparison of text in tables and may give erratic results for lists. Use skip text around these items and redline them manually.
Cannot find text deleted from the original document in the redline document.	Run the comparison showing the full text of deletions.
DisplayWrite files are not comparing properly.	• Compress and repaginate.  • Save as DCA/RFT file, then run program and convert back to DisplayWrite format. • In order to generate a DisplayWrite 3 format file, you must give the output filename a .TXT extension. It will otherwise write to DisplayWrite 4 format.
CompareRite is not showing changes to MultiMate footnotes.	CompareRite does not support footnote comparison for MultiMate documents.


Calling Customer Support

If you should encounter any difficulty, help is just a phone call away. Call Mead Data Central Customer Support at  (800) 543-6862 (in Canada, call (800) 553-3685). Technical support representatives familiar with the CompareRite program are available from 9am to 8pm EST, Monday through Friday.

We'll be able to help you most efficiently if you do the following:

•	Review the list of common mistakes and error messages. You may be able to correct the problem yourself if one of them applies to your situation.

•	Jot down what you were doing when the problem occurred. If you're sure you won't lose any data, try and replicate the problem.

•	Be at your computer and have the program running.

•	Be ready to provide your program serial number and version number.

(To obtain this information, look under About  from the CompareRite program's Main Menu or refer to your program diskettes.)


About Appendix C

This appendix provides an overview of the option sets created at Jurisoft for your use. Both option sets assume that both your original and revised documents were created using WordPerfect:

•	Use the option set Personal 1 or Global 1 to show the full text of your deletions. The redline document shows moved text as having been deleted from its location in the original document and added to its new location in the revised.

•	Use the option set Personal 2 or Global 2 to replace text deleted from the original document with the carat symbol (^). A numbered marker (for example, *1) indicates the location of moved text in the original document. Text is shown in its entirety as normal text in its new location in the revised. A corresponding numbered marker (for example, ** 1) is marked as added text in the new location.

For more information on the options included in these option sets, refer to About Appendix A CompareRite Options.

Option	Personal/Global 1	Personal/Global 2
Additions	Full Text	Full Text
	No surrounding characters	No surrounding characters
	Bold printout format	Bold/double-underline printout format
	Bright white screen format	Bright white screen format
Deletions	Full Text	Carats
	No surrounding characters	No surrounding characters
	Strikethrough printout format	Carat printout format
	Yellow screen format  (inverse for monochrome monitors)	Yellow screen format  (inverse for monochrome monitors)
Method	Normal comparison style	Normal comparison style
	Do not specially show moves	Highlight moves
	Do not skip text	Do not skip text
	Compare text and footnotes	Compare text and footnotes
Preferences	WordPerfect 5.x	WordPerfect 5.x
	Include description page	Include description page
	Do not redline mark additions	Do not redline mark additions
	Do not redline mark deletions	Do not redline mark deletions


Main Window

Help Button

Hitting HELP calls the Help menu for information general to this program.

Okay Button

Hitting OK exits this form after saving your selections.

Cancel Button

Hitting CANCEL exits this form without saving your selections.

Original Document

Type the name of the original file.

Type Ctrl-R to retype the name of the previous file you entered here.

Type Ctrl-P to retype the path of the previous file you entered here.

Revised Document

Type the name of the revised file.

Type Ctrl-R to retype the name of the previous file you entered here.

Type Ctrl-P to get the path of the original document.

Redline Document

Type the name of the file where you will store the comparison, or leave this

answer blank if you want to examine your results with the CompareRite Viewer.

Type Ctrl-R to retype the name of the previous file you entered here.

Type Ctrl-P to get the path of the original document.

Type Ctrl-B to build a name based on the working document name.

Compare Button

Hitting COMPARE starts the actual comparison process.

Exit Button

Hitting EXIT exits this program.

Option Set Button

Hitting OPTIONS lets you select an Option Set for your comparison.

Option Sets define how you want your comparison to look.

Hitting OPTIONS also lets you Create, Modify, or Delete Option Sets.

Additions Button

Hitting ADDITIONS lets you specify the appearance of added text.

Deletions Button

Hitting DELETIONS lets you specify the appearance of deleted text.

Methods Button

Hitting METHODS lets you specify how you want CompareRite to compare files.

Preferences Button

Hitting PREFERENCES lets you change your word processor and related settings

and select revision lists and description pages.


Appearance of Additions Dialog Box

Select these buttons to specify the appearance of added text.

Use your arrow or tab keys to move among the buttons.

Hit the ENTER key to select a button.

For help to select the the characters you wish to surround added text, see Surrounding Characters.

For help to select how added text should appear in your word processor file, see Appearance In Document

For help to select the color the CompareRite Viewer will use for added text, see Appearance On Screen


Appearance of Deletions Dialog Box

Select these buttons to specify the appearance of deleted text.

Use your arrow or tab keys to move among the buttons.

Hit the ENTER key to select a button.

For help to select  what you wish to see in place of deleted text, see Changed Text.

For help to select the characters you wish to surround deleted text, see Surrounding Characters.

For help to select how deleted text should appear in your word processor file, see Appearance In Document.

For help to select what color the CompareRite Viewer will use for deleted text, see Appearance On Screen


Methods Dialog Box

Select these buttons to specify how you want CompareRite to compare files

Use your arrow or tab keys to move among the buttons.

Hit the ENTER key to select a button.

For help to select the comparison style or precision you wish to use, see Precision.

(NOTE: You should only choose SOURCECODE if you are a programmer comparing two source code files)

For help to select how CompareRite should show moved text, see Moves

For help to compare notes, see Compare Notes

For help  to skip a section of text, see Skip Text Characters


Preferences Dialog Box

Select these buttons to change your word processor or to change the other

basic selections that you see on this screen.

Use your arrow or tab keys to move among the buttons.

Hit the ENTER key to select a button.

For help to select the the word processor you want to use for your Original, Revised, or Redline output document, see Word Processor

For help to indicate whether your redlined document printout should contain a cover page, see Description Page.

For help on output options, see Output Options.


Define Option Sets Dialog Box

Option Sets define how you want your comparison to look.  You may

define how additions, deletions look, the methods used in the comparison,

and various word processor preferences.

For help to create a new Option Set based on the existing Option Set you selected, see Creating An Option Set

For help to  edit an Option Set, see Creating An Option Set

For help to delete an Option Set, see Creating An Option Set

Close Button

This just exits this window.  Any saving of data has already occurred.


Save Modify Option Set

This saves your Option Set to your Option Set Library.