Delphi 5 for Professionals/DELPHI5.iso/AddOns/Components/CODESITE/README.TXT

Text File | 1998-08-04 | 11.6 KB | 325 lines

========================================
== WELCOME TO CODESITE - VERSION 1.1! ==
========================================

========
CONTENTS
================================================================================
  Minimum system requirements
  Installing CodeSite
  The CodeSite Interface Unit
  The CodeSite Interface Packages
  Using CodeSite within CodeRush
  Uninstalling CodeSite
  What's New in Version 1.1
  Contacting Raize Software Solutions


===========================
MINIMUM SYSTEM REQUIREMENTS
================================================================================
CodeSite requires:
  - Delphi 1, 2, 3, 4, or C++Builder 3
  - 2 MB of disk space
  - CodeRush specific features require CodeRush from
    Eagle Software to be installed


===================
INSTALLING CODESITE
================================================================================
CodeSite is distributed as a self extracting executable file. The installation
disk (if applicable) contains three files:  this readme file, a text file
describing the licensing agreement, and the Setup.exe program which is used
to install CodeSite.

To install CodeSite, simply run the Setup.exe program and follow the
instructions that appear on the screen.

ATTENTION CODESITE 1.0 USERS!
It is highly recommended that you uninstall CodeSite v1.0 before
installing CodeSite v1.1.

IMPORTANT: All versions of Delphi and C++Builder must be shut down
           before installing CodeSite.


After installing CodeSite onto your system, you will find several Lib folders
within the installation folder (e.g. C:\Raize\CodeSite\Lib4). Each Lib folder
corresponds to a version of Delphi or C++Builder, and contains the CodeSite
Interface unit compiled for the appropriate version of Delphi or C++Builder.

C++Builder 3 Users
------------------
The installation program automatically adds the appropriate Lib folder to your
*Delphi* search paths.  However, C++Builder 3 users must manually add the
CodeSite\LibBCB3 folder to the Include path and Library path located in the
Project|Options dialog box on the Directory/Conditionals page. For example,

Include path: $(BCB)\include;$(BCB)\include\vcl;C:\Raize\CodeSite\LibBCB3
Library path: $(BCB)\lib\obj;$(BCB)\lib;C:\Raize\CodeSite\LibBCB3


===========================
THE CODESITE INTERFACE UNIT
================================================================================
In order to send messages to the CodeSite viewer, you must include the
RzCSIntf unit in each module that will be sending messages.

Delphi Users
------------
Add RzCSIntf to a module's interface or implementation uses clause.


C++Builder 3 Users
------------------
Add the following lines to each module:

#include "RzCSIntf.hpp"
#pragma link "RzCSIntf.obj"



===============================
THE CODESITE INTERFACE PACKAGES
================================================================================
The RzCSIntf unit is also available in a runtime package format for use
in Delphi 3, Delphi 4, and C++Builder 3.

Delphi 3 Users
--------------
The RzCSIntf unit is available in the CS11I30.dpl runtime package,
which has been installed into your Windows system folder
(e.g. C:\Windows\System or C:\WinNT\System32).  In addition, the
CS11I30.dcp file is located in the CodeSite\Lib3 folder.  If you
wish to send CodeSite messages from within your own packages, then
you will need to add the CS11I30 runtime package to your package's
requires clause.

Delphi 4 Users
--------------
The RzCSIntf unit is available in the CS11I40.bpl runtime package,
which has been installed into your Windows system folder
(e.g. C:\Windows\System or C:\WinNT\System32).  In addition, the
CS11I40.dcp file is located in the CodeSite\Lib4 folder.  If you
wish to send CodeSite messages from within your own packages, then
you will need to add the CS11I40 runtime package to your package's
requires clause.

C++Builder 3 Users
------------------
The RzCSIntf unit is also available in the CS11I35.bpl runtime package,
which has been installed into your Windows system folder
(e.g. C:\Windows\System or C:\WinNT\System32).  In addition, the
CS11I35.bpi file is located in the CodeSite\LibBCB3 folder.  If you
wish to send CodeSite messages from within your own packages, then
you will need to add the CS11I35 runtime package to your package's
requires clause.


==============================
USING CODESITE WITHIN CODERUSH
================================================================================
CodeRush, simply put, is a turbo charger for the Delphi 3 IDE created by
Eagle Software (http://www.eagle-software.com).  When installed, it
transforms the Delphi 3 code editor into a high-performance development
system that allows you to write code faster than ever before.

CodeSite integrates seamlessly into the CodeRush environment by providing
the following features:

  CodeSite Panel Plug-in
    This plug-in allows CodeSite messages to be viewed directly
    from within the Delphi IDE.

  CodeSite Message Expert Plug-in
    This expert provides a point-and-click interface for
    constructing CodeSite messages.

  CodeSite Keyboard Templates
    Enter CodeSite message statements with just a few keystrokes
    by using one of the 25 CodeSite specific keyboard templates.

Plus, toolbar buttons providing access to both the CodeSite Panel and CodeSite
Message Expert have been installed into the "CodeSite" button category. To add
these buttons to the CodeRush toolbar, use the Buttons page of the CodeRush
Options dialog.

IMPORTANT NOTE:
When adding new buttons to CodeRush, it is recommended that you close all
editor windows and access the CodeRush Options dialog box via the
CodeRush|Options... menu item.


=====================
UNINSTALLING CODESITE
================================================================================
To remove CodeSite from your computer, follow the directions below.


For Windows 95 and Windows NT 4.0 Users:
----------------------------------------
Open the Add/Remove Programs icon from the Control Panel. Next, select the
"CodeSite v1.0" entry from the list of installed programs, and then
click the Add/Remove button.


For Windows 3.1 and Windows NT 3.51 Users:
------------------------------------------
Run the Unwise.exe program located in the CodeSite installation
folder (e.g. C:\Raize\CodeSite), and follow the instructions
that appear on the screen.


==========================
WHAT'S NEW IN VERSION 1.1?
================================================================================

Integrated Delphi 4 Support
---------------------------
Although the CodeSite v1.0 Update for Delphi 4 has been available for some
time on our web site, with version 1.1, Delphi 4 support is now integrated
into the base installation program.


C++Builder 3 support
--------------------
This version of CodeSite also introduces C++Builder 3 support. After the
install, a LibBCB3 folder is created that contains the necessary files
to access the CodeSite object from within your C++Builder modules.

As noted earlier, in order to access the CodeSite object in your C++Builder
modules, you must add the following two lines to your module:

  #include "RzCSIntf.hpp"
  #pragma link "RzCSIntf.obj"


New Runtime Package Names
-------------------------
Because CodeSite supports Delphi 3, Delphi 4, and C++Builder 3, it was
necessary in this version to create a new naming convention for the
CodeSite Interface runtime package.  All package names start with "CS"
to represent CodeSite, followed by "11" to represent version 1.1.
Next, comes "I", which represents Interface.  The last two digits of
the package name depend on the version of VCL the package depends on:

Compiler    VCL Version    Package Name
Delphi 3    Vcl30.dpl    CS10I30
C++Builder 3    Vcl35.bpl    CS10I35
Delphi 4    Vcl40.bpl    CS10I40


New CodeSite Object Methods and Properties
------------------------------------------
Three new methods and one new property have been added to the
CodeSite object:

procedure SaveLogFile( const FileName: string );

This method allows a developer to automatically instruct the
CodeSite Viewer to save a log file containing all messages
currently in the viewer.  The parameter to this method should
be a complete path and reference a filename with a '.csl'
extension.  For example,

  CodeSite.SaveLogFile( 'C:\Raize\CodeSite\Logs\Sample.csl' );

Please note that the path to the log file must exist. That is,
the SaveLogFile method does not create the directory tree if
the path is not valid.


procedure SendDateTime( const Msg: string; Value: TDateTime );
procedure SendDateTimeEx( MsgType: Integer; const Msg: string;
                          Value: TDateTime );

These two methods allow a developer to send a TDateTime value
to the CodeSite Viewer. The format of the date and time value
is controlled by the DateTimeFormat property (see below).

property DateTimeFormat: string;

This property allows a developer to control the appearance of
date and time values in the CodeSite Viewer.  This property
used used by the SendDateTime and SendDateTimeEx methods.


CodeSite Viewer Enhancements
----------------------------
The CodeSite Viewer now has an option on the Edit menu which
allows a user to reset the indent level. The indent level is
manipulated through calls to EnterMethod and ExitMethod.  If
a problem occurs in a program it is possible that the necessary
ExitMethod calls to decrement the indent level may not be
executed.  As a result, the indent level may be an inappropriate
value for the next run.  The Reset Indent Level command resets
the indent level back to 0.

All panes in the view now implement thumb tracking when scrolling.
That is, the contents of the pane are updated as thumb of scrollbar
is moved.

Cut, Copy, and Paste operations (i.e. Ctrl+X, Ctrl+C, and Ctrl+V)
now work correctly in the popup edit window displayed when editing
an item in the message list.

The user interface of the 16-bit version of the CodeSite Viewer
when running under Windows 3.X has been cleaned up. Specifically,
extra lines in the CodeSite toolbar and status bar have been removed.


CodeSite Message Expert Settings
--------------------------------
The CodeSite Message Expert provides a point-and-click interface
for constructing CodeSite messages when using CodeRush. With this
version, the expert remembers the last set of selected options and
restores these options the next time the expert is displayed.
Also, note that expert settings are persistent across Delphi sessions.



=========================================
CONTACTING RAIZE SOFTWARE SOLUTIONS, INC.
================================================================================

For technical support send email to:

  [e-mail]

or post a message to the following newsgroups:

  raize.public.codesite.install
  raize.public.codesite.support

These newsgroups are available on the news.shoresoft.com news server.


For more information about CodeSite or other Raize Software Solutions
products, point your web browser to the Raize web site at:

  http://www.raize.com

Or, send email to:

  [e-mail]



Raize Software Solutions, Inc.
2111 Templar Drive
Naperville, IL 60565
U.S.A.

Phone:    [phone]
Fax:    [phone]


----------------------------------------------------------------

 Unless otherwise noted, all materials provided in this release
 are Copyright ⌐ 1998 by Raize Software Solutions, Inc.

----------------------------- END ------------------------------