Menu
▾
▴
[JVCL-Checkins] CVS: dev/JVCL3 changelog.txt,1.16,1.17 install.htm,1.3,1.4 readme.htm,1.4,1.5
|
From: Peter T. <pe...@us...> - 2003-08-19 09:55:39
|
Update of /cvsroot/jvcl/dev/JVCL3
In directory sc8-pr-cvs1:/tmp/cvs-serv30053/JVCL3
Modified Files:
changelog.txt install.htm readme.htm
Log Message:
- Documentation updates
Index: changelog.txt
===================================================================
RCS file: /cvsroot/jvcl/dev/JVCL3/changelog.txt,v
retrieving revision 1.16
retrieving revision 1.17
diff -C2 -d -r1.16 -r1.17
*** changelog.txt 17 Aug 2003 19:04:56 -0000 1.16
--- changelog.txt 19 Aug 2003 09:55:35 -0000 1.17
***************
*** 26,30 ****
* JvMovableBevel.TJvScrollTextDirection -> renamed to TJvBevelScrollTextDirection
// peter3
!
2003-07-29:
- Renamed properties and events in TJvImageSquare:
--- 26,33 ----
* JvMovableBevel.TJvScrollTextDirection -> renamed to TJvBevelScrollTextDirection
// peter3
!
! 2003-08-01:
! - Added converted UTF components donated by UIB (now called JvTimeFramework)
!
2003-07-29:
- Renamed properties and events in TJvImageSquare:
***************
*** 32,39 ****
--- 35,44 ----
OnEnter -> OnMouseEnter
OnExit -> OnMouseLeave
+
2003-07-28:
- Removed JVCL components from (mainly) design-time forms to minimize inter-package dependencies. When writing
property editors for components in the future, please try to keep the number of JVCL components used as low
as is absolutely possible (TODO: put this in the docs as well).
+
2003-07-25:
- TJvThreadTimer
***************
*** 192,197 ****
--- 197,204 ----
* All resources (.res and .dcr) are now located in \resources folder
* All INC and common files are now located in \common
+
2003-06-15:
- Added a first set of d7 packages
+
2003-06-12:
- Created new dev subfolder on SF for the files (jvcl/dev/JVCL3)
Index: install.htm
===================================================================
RCS file: /cvsroot/jvcl/dev/JVCL3/install.htm,v
retrieving revision 1.3
retrieving revision 1.4
diff -C2 -d -r1.3 -r1.4
*** install.htm 28 Jun 2003 20:24:02 -0000 1.3
--- install.htm 19 Aug 2003 09:55:35 -0000 1.4
***************
*** 7,14 ****
<h2>Installation Notes for JVCL</h2>
<h3>
<hr >
- </h3>
<h3>Current version</h3>
! <p>The current version of JVCL is 3.00</p>
<h3>Supported compiler versions</h3>
<p>The following compilers are supported by the JVCL:</p>
--- 7,14 ----
<h2>Installation Notes for JVCL</h2>
<h3>
+ </h3>
<hr >
<h3>Current version</h3>
! <p>The current version of JVCL is 3.00, released on YYYY-MM-DD</p>
<h3>Supported compiler versions</h3>
<p>The following compilers are supported by the JVCL:</p>
***************
*** 18,57 ****
<li>Delphi 7</li></ul>
<p> </p>
<h3>Uninstalling previous versions of JVCL</h3>
! <p>If you have a previous version of the JVCL installed, you must remove it
completely along with the JCL before installing this version. To remove a
previous installation, proceed as follows:</p>
<ol>
! <li>Start Delphi/BCB, open the packages page by selecting Component|Install
! Packages.</li>
! <li>Select each of the JCL / JVCL packages in the list and click the "Remove"
! button</li>
! <li>Open Tools|Environment Options|Library and remove all library paths
! pointing to JVCL and JCL folders. </li>
! <li>Repeat step 1 to 3 for every version of Delphi/BCB you have installed</li>
! <li>Browse to the folder where your bpl and dcp files are located (default is
! ($DELPHI)\Projects\Bpl). Delete all of the files related to JVCL and JCL</li>
<li>Delete or rename the top folder where JCL and JVCL is installed.</li>
! <li>Start regedit (click Start|Run, type regedit.exe and hit Enter). Open the
! key <font face="Courier New"
! size="2">HKEY_CURRENT_USER\Software\Borland\<compiler>\<version>\Palette</font>
and delete all name/value items in the list related to JVCL. (<compiler>
! is either "Delphi" or "C++Builder", <version> is the version of
! Delphi/BCB you have installed).</li></ol>
<h3>Getting required packages</h3>
! <p>JVCL requires that you also install the latest version of JCL (JEDI Code
! Library). You can get the latest vesion of JCL from this location: XXXXX.</p>
<h3>Manual install</h3>
<p>Start by unpacking the JVCL and JCL zip files into a folder of your own
choice. Make sure your zip extractor is set to maintain folder structure or all
! files will be put into the same folder (<strong>not </strong>what you want!).
</p>
<p>Since JVCL assumes that the JCL is installed in the same base folder as JVCL,
! the JCL and JVCL folders must be created as siblings, i.e after installation,
! your folder structure should look like this:</p>
! <p><font face="Courier New" size="2">JEDI<br> JCL<br> <JCL
! subfolders><br> JVCL<br> <JVCL
subfolders><br></font></p>
! <p><font face="Courier New" size="2"> </p></FONT>
</body>
</html>
--- 18,92 ----
<li>Delphi 7</li></ul>
<p> </p>
+ <div class="InfoField">
+ The term "Delphi" is used to refer to the IDE but the same instructions are applicable to C++Builder
+ and Kylix in most circumstances. When that is not the case, it is noted in the text.
+ </div>
<h3>Uninstalling previous versions of JVCL</h3>
! <p>If you have a previous version of the JVCL installed (i.e 2.10 or earlier), you must remove it
completely along with the JCL before installing this version. To remove a
previous installation, proceed as follows:</p>
<ol>
! <li>Start Delphi, open the packages page by selecting <b>Component - Install
! Packages</b>.</li>
! <li>Select each of the JCL / JVCL packages in the list and click the <b>Remove</b> button</li>
! <li>Open <b>Tools - Environment Options - Library</b> and remove all library paths pointing to JVCL and JCL folders. </li>
! <li>Repeat step 1 to 3 for every version of Delphi you have installed</li>
! <li>Browse to the folder where your bpl and dcp files are located (default is ($DELPHI)\Projects\Bpl). Delete all of the files related to JVCL and JCL</li>
<li>Delete or rename the top folder where JCL and JVCL is installed.</li>
! <li>Start regedit (click <b>Start - Run</b>, type "regedit.exe" and hit <b>Enter</b>). Open the
! key <font face="Courier New" size="1">HKEY_CURRENT_USER\Software\Borland\<compiler>\<version>\Palette</font>
and delete all name/value items in the list related to JVCL. (<compiler>
! is either "Delphi" or "C++Builder", <version> is the IDE version you have installed). </li>
! </ol>
<h3>Getting required packages</h3>
! <p align="left">JVCL requires that you also install the latest version of JCL (JEDI Code
! Library). Instructions on where to download JCL can be found on this page: <a href="http://jcl.sourceforge.net">http://jcl.sourceforge.net</a>.</p>
<h3>Manual install</h3>
<p>Start by unpacking the JVCL and JCL zip files into a folder of your own
choice. Make sure your zip extractor is set to maintain folder structure or all
! files will be put into the same folder (<b>not</b> what you want!).
</p>
<p>Since JVCL assumes that the JCL is installed in the same base folder as JVCL,
! the JCL and JVCL folders must be created as siblings, i.e the folder structure should look like this:</p>
! <p><font face="Courier New" size="2">JEDI<br> JCL<br> <JCL
! subfolders><br> JVCL<br> <JVCL
subfolders><br></font></p>
! <p>Start Delphi, open the package group file (bpg) for your version of Delphi
! that is located in the jvcl\packages folder. Next, go to <b>Tools - Environment
! Options - Library - Library Path</b> and add the paths to JCL\source, JVCL\run and
! JVCL\common to the list of library paths.</p>
! <p> </p>
! <p>Select <b>Project - Build All Projects</b> from the Delphi menu. Go get a cup
! of coffee (this takes a while). After Delphi has compiled all the packages, open
! the <b>Project Manager</b> (Ctrl+Alt+F11) and right-click each of the packages
! ending with D?D (where ? is the version number, "5" for Delphi 5,
! "6" for Delphi 6 etc) and select "<b>Install</b>" from the
! pop-up menu. Although you can skip installing some of the packages, we still
! recommend that you install all of them the first time. You can later remove some
! of them on a project by project basis or permanently if you never use the
! components in the package and the package isn't required by another installed
! package.</p>
! <p> </p>
! <p>If you have several versions of Delphi/BCB installed, you will have to go
! through these steps for each version, the only difference being the bpg file you
! load into the IDE.</p>
! <p> </p>
! <p> </p>
! <div class="InfoField">
! When closing a package, Delphi will prompt you to save the changes to the package. You can answer "No" to this question since it only updates
! the dof files
! </div>
! <h3><font size="2">Reinstalling and updating</font></h3>
! <p>To reinstall or update a package, use the same approach as in the <b>Manual
! Install</b> section above with the following additions:</p>
! <ul>
! <li>In Delphi 5, uninstall all affected JVCL packages before rebuilding.
! Delphi 5 has a problem updating already installed packages, especially when
! the package have dependencies. Delphi 6 and Delphi 7 handles this better but
! you are recommended to remove them anyway since it minimizes the probability
! of errors. To uninstall, select <b>Component - Install Package</b>, select the JVCL
! package in the list and click the <b>Remove</b> button. Click <b>OK</b> to close the
! dialog (if you click Cancel the package will not be removed).</li>
! </ul>
</body>
</html>
Index: readme.htm
===================================================================
RCS file: /cvsroot/jvcl/dev/JVCL3/readme.htm,v
retrieving revision 1.4
retrieving revision 1.5
diff -C2 -d -r1.4 -r1.5
*** readme.htm 12 Jul 2003 00:27:16 -0000 1.4
--- readme.htm 19 Aug 2003 09:55:35 -0000 1.5
***************
*** 69,73 ****
<th>Description</TH>
<th>Contains</TH>
! <th>Required JVCL packages (design-time)</TH></TR>
<tr>
<td>JvCore</TD>
--- 69,73 ----
<th>Description</TH>
<th>Contains</TH>
! <th>Required JVCL packages (required by design-time package)</TH></TR>
<tr>
<td>JvCore</TD>
***************
*** 76,80 ****
<td>
<p>Core support units</P>
! <p>TJvJVCLAboutComponent</P></TD>
<td>none</TD></TR>
<tr>
--- 76,81 ----
<td>
<p>Core support units</P>
! <p>TJvJVCLAboutComponent<br>
! TJvContextProvider</P></TD>
<td>none</TD></TR>
<tr>
***************
*** 604,608 ****
<p>TJvWizardRouteMapSteps</P></TD>
<td>JvCore (if UseJVCL is defined, which it is by
! default)</TD></TR></TABLE></P>
<h4>New components added</H4>
<p>The following new components and libraries has been
--- 605,622 ----
<p>TJvWizardRouteMapSteps</P></TD>
<td>JvCore (if UseJVCL is defined, which it is by
! default)</TD></TR>
! <tr>
! <td>JvTimeFramework</TD>
! <td>Set of PIM components formerly known as UIL Time Framework 2.0</TD>
! <td>
! TJvTFAlarm<br>
! TJvTFScheduleManager<br>
! TJvTFGlanceTextViewer<br>
! TJvTFMonths<br>
! TJvTFWeeks<br>
! TJvTFDays<br>
! TJvTFUniversalPrinter<br>
! TJvTFDaysPrinter</TD>
! <td>JvCore (if UseJVCL is defined, which it is by default)</TD></TR></TABLE>
<h4>New components added</H4>
<p>The following new components and libraries has been
***************
*** 611,631 ****
<li>The Globus Library
<li>Jans Delphi Components
! <li>The UIB Components
<li>Print Preview components
<li>Validators and Error Provider components
! <li>K Wizard component and RouteMaps</LI></UL>
<p> </P>
<h4>Components deprecated, renamed or removed </H4>
! <p>The following components have been removed or are
! renamed or are deprecated (i.e they will most likely disappear in the near
future) since JVCL 2.10:<br></P>
<h5>Removed</H5>
<p>TJvBreatheSkin, TJvCommandEdit, TJvCoupler, TJvCPUUsage,
TJvHighLighter, TJvMemoryInfos, TJvMousePositionner, TJvNagScreen,
TJvPerforated, TJvPopupMemo,TJvAutoSave, TJvRegAuto, </P>
<p> </P>
<h5>Renamed</H5>
<p>The following units and classes have been renamed in
this version:</P>
<table>
<tr>
--- 625,654 ----
<li>The Globus Library
<li>Jans Delphi Components
! <li>The UIB Interbase/Firebird Database Components
<li>Print Preview components
<li>Validators and Error Provider components
! <li>K Wizard component and RouteMaps</LI>
! <li>UIL Time Framework 2.0</LI>
! <li>TJvXMLDatabase</LI>
! <li>TJvMouseGesture</LI>
! <li>TJvAVICapture</LI>
! <li>TJvBlinkingLED</LI></UL>
<p> </P>
<h4>Components deprecated, renamed or removed </H4>
! <p>The following components have been removed, renamed or are deprecated (i.e they will most likely disappear in the near
future) since JVCL 2.10:<br></P>
<h5>Removed</H5>
+ <blockquote>
<p>TJvBreatheSkin, TJvCommandEdit, TJvCoupler, TJvCPUUsage,
TJvHighLighter, TJvMemoryInfos, TJvMousePositionner, TJvNagScreen,
TJvPerforated, TJvPopupMemo,TJvAutoSave, TJvRegAuto, </P>
+ </blockquote>
<p> </P>
<h5>Renamed</H5>
+ <blockquote>
<p>The following units and classes have been renamed in
this version:</P>
+ </blockquote>
+ <p> </P>
<table>
<tr>
***************
*** 919,924 ****
<ul>
<li>All files have a "Jv" prefix (capital "J", lower
! case "v") and we use "Camel Casing" for the file name
! (LikeThisForExample.pas).
<li>All files have an extension in all lower case
letters.
--- 942,946 ----
<ul>
<li>All files have a "Jv" prefix (capital "J", lower
! case "v") and we use "Camel Casing" for the file name (JvLikeThisForExample.pas).
<li>All files have an extension in all lower case
letters.
***************
*** 930,941 ****
database components could be named "JvDBControls.pas" whereas a unit
containing a TJvEditor control would be named "JvEditor.pas".
! <li>All image files are in all UPPER CASE</LI></UL>
<p> </P>
<p><strong>Using the word "Form" in
filenames</STRONG></P>
<p>All forms (units with DFM's) are suffixed with the
! word "Form" regardless of if whether they contain a dialog or a form. The word
"Form" can also be used as a prefix if the component in the unit is acting
! upon a form without being one itself (i.e JvFormMagnet) </P>
<p> </P>
<p><strong>Using the word "Dialog"
--- 952,964 ----
database components could be named "JvDBControls.pas" whereas a unit
containing a TJvEditor control would be named "JvEditor.pas".
! <li>All image file names are in ALL UPPER CASE (TJVALARM.BMP)</LI>
! <li>All include file names are in ALL UPPER CASE (JVCL.INC)</LI></UL>
<p> </P>
<p><strong>Using the word "Form" in
filenames</STRONG></P>
<p>All forms (units with DFM's) are suffixed with the
! word "Form" regardless of whether they contain a dialog or a form (i.e JvDualListForm.pas). The word
"Form" can also be used as a prefix if the component in the unit is acting
! upon a form without being one itself (i.e JvFormMagnet.pas) </P>
<p> </P>
<p><strong>Using the word "Dialog"
***************
*** 943,947 ****
<p>The word "Dialog" in a unit name signifies that the
unit contains a component that has no UI at designtime but shows a form or
! dialog at run time (like the TOpenDialog et al). At the moment, "Dlg" and
"Dlgs" are accepted but their use is discouraged. </P>
<p> </P>
--- 966,970 ----
<p>The word "Dialog" in a unit name signifies that the
unit contains a component that has no UI at designtime but shows a form or
! dialog at run time (i.e JvObjectPickerDialog.pas). At the moment, "Dlg" and
"Dlgs" are accepted but their use is discouraged. </P>
<p> </P>
***************
*** 949,953 ****
and "Consts" in filenames</STRONG></P>
<p>The words "Const" and "Consts" are only used in units
! that contains just type, resourcestring and const declarations and no code.
</P>
<p><strong></STRONG> </P>
--- 972,977 ----
and "Consts" in filenames</STRONG></P>
<p>The words "Const" and "Consts" are only used in units
! that contains just type, resourcestring and const declarations and no code (i.e
! JvConsts.pas).
</P>
<p><strong></STRONG> </P>
***************
*** 955,959 ****
and "Utils" in filenames</STRONG></P>
<p>The word "Util" and "Utils" are only used in units
! that contains support routines and classes of more general use. Classes in
util type units should never be installable. </P>
<p> </P>
--- 979,984 ----
and "Utils" in filenames</STRONG></P>
<p>The word "Util" and "Utils" are only used in units
! that contains support routines and classes of more general use (i.e
! JvJVCLUtils.pas). Classes in
util type units should never be installable. </P>
<p> </P>
***************
*** 963,968 ****
same base name as the component they are primarily used to edit and an
"Editor" or "Editors" suffix, i.e a property editor unit for the
! TJvBehaviorLabel should be called either "JvBehaviorLabelEditor" or
! "JvBehaviorLabelEditors". </P>
<p>The base name for the unit is controlled by the name
of the component the editor(s) were meant for: if all editors are for the same
--- 988,993 ----
same base name as the component they are primarily used to edit and an
"Editor" or "Editors" suffix, i.e a property editor unit for the
! TJvBehaviorLabel should be called either "JvBehaviorLabelEditor" or "JvBehaviorLabelEditors". </P>
! <p> </P>
<p>The base name for the unit is controlled by the name
of the component the editor(s) were meant for: if all editors are for the same
***************
*** 972,975 ****
--- 997,1001 ----
components) or according to it's general data type (i.e "JvDateEditors"
contains editors used to edit date related properties). </P>
+ <p> </P>
<p>It doesn't matter (name wise) if a unit contains
property, component or any other types of editor. They are all named the same
***************
*** 981,990 ****
an appropriate name with a "Editor" suffix but the name of the form will not
change. </P>
! <p>Adding editors to forms is discouraged. We try to keep
! editors in their own unit, preferably one editor per unit. Editor units can
! contain their own Register procedure but this is also discouraged. The
! Register procedure should optimally only be present in specific "Reg" files
! for a package. This minimizes confusion and clutter and maximizes reuse, loose
! coupling and simplifies maintenance and restructuring. </P>
<p><strong></STRONG> </P>
<p><strong>Registration
--- 1007,1018 ----
an appropriate name with a "Editor" suffix but the name of the form will not
change. </P>
! <p> </P>
! <p>Adding design editors to form units is discouraged. We try to keep
! editors in their own unit, preferably one editor per unit. Editor units should
! not
! contain their own Register procedure. The
! Register procedure should only be present in specific "Reg" files
! for a package (see below). This minimizes confusion and clutter and maximizes reuse, loose
! coupling and simplifies maintenance and future restructuring. </P>
<p><strong></STRONG> </P>
<p><strong>Registration
***************
*** 992,999 ****
<p>Each design package have it's own registration unit
with a Register procedure. The unit is named with the same base name as the
! package but with a "Reg" suffix (i.e the reg file for the "JvCore" design
package is named "JvCoreReg.pas"). The reg file only contains registrations
for the components and design editors. Design editors and other support code
is not added to the reg file unless absolutely necessary. </P>
<p>A matching dcr file is also included in the \resources
folder. The dcr file always have the same base name as the reg file but with a
--- 1020,1028 ----
<p>Each design package have it's own registration unit
with a Register procedure. The unit is named with the same base name as the
! package but with a "Reg" suffix (i.e the reg file for the "JvCore" design
package is named "JvCoreReg.pas"). The reg file only contains registrations
for the components and design editors. Design editors and other support code
is not added to the reg file unless absolutely necessary. </P>
+ <p> </P>
<p>A matching dcr file is also included in the \resources
folder. The dcr file always have the same base name as the reg file but with a
***************
*** 1067,1070 ****
--- 1096,1100 ----
<li>Newsgroups. You can access the JVCL newsgroups at <a href="news://forums.talkto.net/jedi.vcl">
news://forums.talkto.net/jedi.vcl</a>
+ (preferred)
<li>Mail lists. There are still some mail lists on Yahoo
to discuss JVCL but these are gradually being closed down, so please do not
***************
*** 1072,1080 ****
mail lists on sourceforge. Go to <a href="http://sf.net/projects/jvcl">http://sf.net/projects/jvcl</a>
and click
! he "Lists" link to get to the soureforge mail lists.
<li>Bug reporting. To report bugs, suggest improvement or
! new features or donate a component, go to Mantis (our bug tracking software)
and post/reply to the reports there. You'll find Mantis at <a href="http://projectjedi.sourceforge.net/mantis">
! http://projectjedi.sourceforge.net/mantis</a>.</li></UL>
<p> </p>
<p> </p>
--- 1102,1112 ----
mail lists on sourceforge. Go to <a href="http://sf.net/projects/jvcl">http://sf.net/projects/jvcl</a>
and click
! he "Lists" link to get to the soureforge mail lists (deprecated).
<li>Bug reporting. To report bugs, suggest improvement or
! new features or donate a component, go to Mantis (our on-line bug tracker)
and post/reply to the reports there. You'll find Mantis at <a href="http://projectjedi.sourceforge.net/mantis">
! http://projectjedi.sourceforge.net/mantis</a>. Please make sure your
! problem hasn't already been reported and fixed before posting a new bug
! report!</li></UL>
<p> </p>
<p> </p>
|