Menu
▾
▴
[Oorexx-svn] SF.net SVN: oorexx:[6346] docs/branches/4.1.0/trunk/readme
|
From: <mie...@us...> - 2010-11-02 19:32:27
|
Revision: 6346
http://oorexx.svn.sourceforge.net/oorexx/?rev=6346&view=rev
Author: miesfeld
Date: 2010-11-02 19:32:20 +0000 (Tue, 02 Nov 2010)
Log Message:
-----------
Finish the read me doc
Modified Paths:
--------------
docs/branches/4.1.0/trunk/readme/newinrelease.xml
docs/branches/4.1.0/trunk/readme/windows.xml
Modified: docs/branches/4.1.0/trunk/readme/newinrelease.xml
===================================================================
--- docs/branches/4.1.0/trunk/readme/newinrelease.xml 2010-11-02 15:20:52 UTC (rev 6345)
+++ docs/branches/4.1.0/trunk/readme/newinrelease.xml 2010-11-02 19:32:20 UTC (rev 6346)
@@ -44,7 +44,7 @@
<section><title>New in this Release</title>
<para>
- This section describes the changes and enhancements introduced since Open Object Rexx 4.0.1.
+ This section lists the new features and enhancements introduced since Open Object Rexx 4.0.1.
</para>
<para>
You should refer to the CHANGES document accompanying the release for a complete list of the changes
@@ -56,53 +56,299 @@
<section><title>All Platforms</title>
<para>
- x
+ The enhancements listed here are platform-independent and available on all suppoted platforms.
</para>
+<section><title>Builtin Classes</title>
+<para>
+ Enhancements to the built in classes have been made.
+ <variablelist>
+ <varlistentry><term><emphasis role="bold">File Class</emphasis></term>
+ <listitem>
+ <para>
+ A new class, the <computeroutput>File</computeroutput> class has been added to the built in classes. It has the
+ following methods:
+ </para>
+ <itemizedlist>
+ <listitem><para><emphasis role="bold">Class methods:</emphasis></para></listitem>
+ <listitem><para>isCaseSensitive</para></listitem>
+ <listitem><para>listRoots </para></listitem>
+ <listitem><para>pathSeparator </para></listitem>
+ <listitem><para>separator </para></listitem>
+ <listitem><para><emphasis role="bold">Instance methods:</emphasis></para></listitem>
+ <listitem><para>absoluteFile </para></listitem>
+ <listitem><para>absolutePath </para></listitem>
+ <listitem><para>canRead </para></listitem>
+ <listitem><para>canWrite </para></listitem>
+ <listitem><para>compareTo </para></listitem>
+ <listitem><para>delete </para></listitem>
+ <listitem><para>exists </para></listitem>
+ <listitem><para>hashCode </para></listitem>
+ <listitem><para>init </para></listitem>
+ <listitem><para>isCaseSensitive</para></listitem>
+ <listitem><para>isDirectory </para></listitem>
+ <listitem><para>isFile </para></listitem>
+ <listitem><para>isHidden </para></listitem>
+ <listitem><para>lastModified </para></listitem>
+ <listitem><para>lastModified= </para></listitem>
+ <listitem><para>length </para></listitem>
+ <listitem><para>list </para></listitem>
+ <listitem><para>listFiles </para></listitem>
+ <listitem><para>makeDir </para></listitem>
+ <listitem><para>makeDirs </para></listitem>
+ <listitem><para>name </para></listitem>
+ <listitem><para>parent </para></listitem>
+ <listitem><para>parentFile </para></listitem>
+ <listitem><para>path </para></listitem>
+ <listitem><para>pathSeparator </para></listitem>
+ <listitem><para>qualifiedPath </para></listitem>
+ <listitem><para>renameTo </para></listitem>
+ <listitem><para>separator </para></listitem>
+ <listitem><para>setReadonly </para></listitem>
+ <listitem><para>string </para></listitem>
+ </itemizedlist>
+ </listitem></varlistentry>
+ <varlistentry><term><emphasis role="bold">New methods in DateTime</emphasis></term>
+ <listitem>
+ <para>
+ A new method, <computeroutput>toLocalTime()</computeroutput> has been added to the
+ <computeroutput>DateTime</computeroutput> class.
+ </para>
+ </listitem></varlistentry>
+ </variablelist>
+</para>
</section>
-<section><title>Unix Platform</title>
+<section><title>Subcommand environment</title>
<para>
- x
+ A new subcommand environment, <computeroutput>Host Emulator</computeroutput>
+ (<computeroutput>hostemu</computeroutput>), has been added. This environment partially emulates a TSO/CMS
+ environment.
</para>
</section>
-<section><title>Windows Platform</title>
+<section><title>Extension classes</title>
<para>
- x
+ The following classes have been added to the distribution. These are extension classes, not built in classes. A
+ requires statement is needed to use them.
</para>
+<itemizedlist>
+ <listitem><para>csvstream.cls</para></listitem>
+ <listitem><para>mime.cls</para></listitem>
+ <listitem><para>smtp.cls</para></listitem>
+ <listitem><para>streamsocket.cls</para></listitem>
+</itemizedlist>
+</section>
-<section><title>New Samples</title>
+<section><title>Documentation</title>
<para>
- The following new samples are included in the distribution:
+ Two new documentation books, <emphasis role="italic">Open Object Rexx, Rexx Extensions Library Reference</emphasis>
+ and <emphasis role="italic">Open Object Rexx, Unix Extensions Reference</emphasis> have been added. These references
+ are available in both PDF and HTML format, the same as other ooRexx documentation.
+</para>
+<para>
+ Both references are intended to document extensions to ooRexx, where the documentation is not big enoough to warrant
+ an individual book. The <emphasis role="italic">Rexx Extensions</emphasis> reference is for extensions available on
+ all platforms, such and the <computeroutput>Host Emulator</computeroutput> or the <computeroutput>CVS
+ Stream</computeroutput> class. The <emphasis role="italic">Unix Extensions</emphasis> references is for extensions
+ specific to Unix platforms. The new <computeroutput>rxunixsys</computeroutput> extension library is documented here.
+</para>
+</section>
+</section>
+
+<section><title>Unix Platform</title>
+<para>
+ The Unix specific enhancments consist of a major new extension library.
</para>
+
+<section><title>rxunixsys</title>
+<para>
+ <computeroutput>rxunixsys</computeroutput> is a new extension of external functions specific to unix-like operating
+ systems. To use these funtions add a <computeroutput>requires</computeroutput> directive to your program.
+</para>
+<programlisting>
+<![CDATA[
+::requires 'rxunixsys' LIBRARY
+]]>
+</programlisting>
+<para>
+ These functions are included in the library:
+ <itemizedlist>
+ <listitem><para>SysAccess </para></listitem>
+ <listitem><para>SysChmod </para></listitem>
+ <listitem><para>SysChown </para></listitem>
+ <listitem><para>SysChroot </para></listitem>
+ <listitem><para>SysCrypt </para></listitem>
+ <listitem><para>SysEuidaccess </para></listitem>
+ <listitem><para>SysGetdirlist </para></listitem>
+ <listitem><para>SysGetegid </para></listitem>
+ <listitem><para>SysGeterrno </para></listitem>
+ <listitem><para>SysGeterrnomsg </para></listitem>
+ <listitem><para>SysGeteuid </para></listitem>
+ <listitem><para>SysGetgid </para></listitem>
+ <listitem><para>SysGetgrgid </para></listitem>
+ <listitem><para>SysGetgrnam </para></listitem>
+ <listitem><para>SysGethostname </para></listitem>
+ <listitem><para>SysGetpgrp </para></listitem>
+ <listitem><para>SysGetpid </para></listitem>
+ <listitem><para>SysGetppid </para></listitem>
+ <listitem><para>SysGetpwnam </para></listitem>
+ <listitem><para>SysGetpwuid </para></listitem>
+ <listitem><para>SysGetservbyname</para></listitem>
+ <listitem><para>SysGetservbyport</para></listitem>
+ <listitem><para>SysGetsid </para></listitem>
+ <listitem><para>SysGetsizeofptr </para></listitem>
+ <listitem><para>SysGettid </para></listitem>
+ <listitem><para>SysGettzname1 </para></listitem>
+ <listitem><para>SysGettzname2 </para></listitem>
+ <listitem><para>SysGetuid </para></listitem>
+ <listitem><para>SysGetxattr </para></listitem>
+ <listitem><para>SysLchown </para></listitem>
+ <listitem><para>SysLink </para></listitem>
+ <listitem><para>SysListxattr </para></listitem>
+ <listitem><para>SysMkdir </para></listitem>
+ <listitem><para>SysRemovexattr </para></listitem>
+ <listitem><para>SysRmdir </para></listitem>
+ <listitem><para>SysSetegid </para></listitem>
+ <listitem><para>SysSeteuid </para></listitem>
+ <listitem><para>SysSetgid </para></listitem>
+ <listitem><para>SysSetpgid </para></listitem>
+ <listitem><para>SysSetpgrp </para></listitem>
+ <listitem><para>SysSetsid </para></listitem>
+ <listitem><para>SysSetuid </para></listitem>
+ <listitem><para>SysSetxattr </para></listitem>
+ <listitem><para>SysSignal </para></listitem>
+ <listitem><para>SysStat </para></listitem>
+ <listitem><para>SysSymlink </para></listitem>
+ <listitem><para>SysUmask </para></listitem>
+ <listitem><para>SysUname </para></listitem>
+ <listitem><para>SysWordexp </para></listitem>
+ </itemizedlist>
+</para>
</section>
+</section>
+
+<section><title>Windows Platform</title>
+<para>
+ A few Windows specific enhancements have been made, mostly to the installation program.
+</para>
+
<section><title>Installation Program</title>
<para>
- x
+ The Windows installer has been rewritten to address some annoyances.
</para>
+
+<section><title>Major Changes</title>
+<orderedlist>
+<listitem>
+<para>
+ There is a new 'type' of install ('upgrade'). The upgrade installation is only active if there is a previous version
+ of ooRexx installed.
+</para>
+<para>
+ An upgrade removes only the files from the previous version and installs the files for the current version. It does
+ not change any of the existing registry or environment settings. They stay exactly the same.
+</para>
+<para>
+ Since the uninstaller is written at the time of installation, the upgrade install is only available if the version of
+ the uninstaller is 4.1.0 or later. What this means in practice is, the first time you install a 4.1.0 ooRexx, the
+ upgrade install will not be available because the previous installation wrote an uninstaller that does not understand
+ the upgrade type.
+</para>
+<para>
+ When you do an upgrade install you can not change any of the settings from the previous install. I.e., if you
+ installed in <computeroutput>C:\MyCrummyDirectory\ooRexx</computeroutput> then the upgrade also installs in that
+ directory. If you installed rxapi as a service in the previous install, then it remains installed as a service.
+ Etc., etc..
+</para>
+</listitem>
+<listitem>
+<para>
+ The installation lets associate file extensions with the ooRexx executables. Default values are :
+ <table id="t000013" frame="all">
+ <title>Default file associations</title>
+ <tgroup cols="3">
+ <thead>
+ <row>
+ <entry>Executable</entry>
+ <entry>Extension</entry>
+ <entry>ftype (File type)</entry>
+ </row>
+ </thead>
+ <tbody>
+ <row>
+ <entry>rexx.exe</entry><entry>.rex</entry><entry>RexxScript</entry>
+ </row>
+ <row>
+ <entry>rexxhide.exe</entry><entry>.rexg</entry><entry>RexxHide</entry>
+ </row>
+ <row>
+ <entry>rexxpaws.exe</entry><entry>.rexp</entry><entry>RexxPaws</entry>
+ </row>
+ </tbody></tgroup>
+ </table>
+</para>
+</listitem>
+<listitem>
+<para>
+ A 'Send To' item can be defined for rexx.exe, rexxhide.exe and rexxpaws.exe.
+</para>
+</listitem>
+<listitem>
+<para>
+ An editor for the Edit context menu item can be defined (the same editor is used for all ooRexx file types.)
+</para>
+</listitem>
+</orderedlist>
</section>
-<section><title>ooDialog</title>
-<variablelist>
- <varlistentry><term><emphasis role="bold">Documentation</emphasis></term>
- <listitem>
- <para>
- x
- </para>
- </listitem>
- </varlistentry>
-</variablelist>
+<section><title>Minor Changes</title>
+<orderedlist>
+<listitem>
+<para>
+ Rather than put up a message box about stopping rxapi, a page is displayed. That way there is more room to explain
+ why rxapi needs to be stopped. If the user elects to not stop rxapi, the installer quits.
+</para>
+</listitem>
+<listitem>
+<para>
+ The message box popup with the question about uninstalling the previous version is turned into a page. This makes it
+ easier to insist that the user uninstall the previous version and explain that if she chooses not to uninstall the
+ previous version it is likely to cause problems and that we won't support that. It is made more difficult for the
+ user to not uninstall a previous version, there is a second check box that has to be manually checked.
+</para>
+</listitem>
+<listitem>
+<para>
+ During the uninstall, the user is given the option of uninstalling by simply deleting the installation directory or
+ only deleting the files placed there by the installer using the log file. Using the log file is the default.
+ Uninstalling by deleting the whole installation directory is generally faster than using the install log.
+</para>
+</listitem>
+<listitem>
+<para>
+ The installation user interface is meant to be more modern, meant to explain better to some one new to the install of
+ ooRexx on Windows what they should do and why, and meant to allow some one used to installing a quicker uninstall /
+ install cycle.
+</para>
+</listitem>
+</orderedlist>
</section>
</section>
-
-<section><title>Miscellaneous Enhancements</title>
+<section><title>ooDialog</title>
<para>
- x
+ <emphasis role="bold">New method.</emphasis> The <computeroutput>userIcon()</computeroutput> method has been added to
+ the <computeroutput>Image</computeroutput> class.
</para>
+<para>
+ <emphasis role="bold">New sample</emphasis> The
+ <computeroutput>samples\oodialog\examples\columnclicklistview.rex</computeroutput> example program has been added.
+</para>
</section>
</section>
+
+</section>
Modified: docs/branches/4.1.0/trunk/readme/windows.xml
===================================================================
--- docs/branches/4.1.0/trunk/readme/windows.xml 2010-11-02 15:20:52 UTC (rev 6345)
+++ docs/branches/4.1.0/trunk/readme/windows.xml 2010-11-02 19:32:20 UTC (rev 6346)
@@ -276,12 +276,6 @@
text on the page offers some suggested extensions and file type names. They should be treated as suggestions only.
</para>
</listitem>
-<listitem>
-<para>
- The file extension <computeroutput>.rex</computeroutput> is added to the System PATHEXT environment
- variable.
-</para>
-</listitem>
</orderedlist>
<para>
<emphasis role="bold">Unattended installation</emphasis>. The Windows installation program can be run from the command
This was sent by the SourceForge.net collaborative development platform, the world's largest Open Source development site.
|