home *** CD-ROM | disk | FTP | other *** search
/ OS/2 Shareware BBS: 10 Tools / 10-Tools.zip / wpdsc093.zip / READ.ME < prev    next >
Text File  |  1995-11-06  |  7KB  |  163 lines
  1.                                                        Objects From Russia
  2.  
  3.                                WPSDSCR
  4.                  Description WPS Classes replacement
  5.                           beta 0.93 version
  6.  
  7.              Copyright (c) 1995 Virtual Objects Software
  8.                        Author: Vitaly Gumirov
  9.                              [Team OS/2]
  10.                     E-mail: vos@ifshop.ict.nsk.su
  11.                       FIDO: 2:5000/64.4@Fidonet
  12.  
  13. 0. Introduction
  14.  
  15. This package includes the replacement classes for Data File and  Folder WPS
  16. classes adding the 'Description' column in Folder's details  view. This new
  17. version  includes  customization  features.  Now you could  configure  your
  18. folders to use various sources for  files'  descriptions.  FileList  Folder
  19. could take the  values  of  descriptions for it's Data  Files  from  either
  20. .SUBJECT extended attribute or FILES.BBS file or 4DOS's/4OS2's descript.ion
  21. file or any other file-list file you specify.
  22.  
  23. 0.1 ACKNOLEDGEMENTS
  24.  
  25. Our  team  is  very  pleased  to know about your interrest to our WPS  DSCR
  26. classes.  Morover  your  advices  are   very   helpful   in  technical  and
  27. psychological aspects ( is it right in english ? :-)
  28.  
  29. 0.2 Packaging
  30.  
  31. WPS DSCR classes package contains the fillowing files:
  32.  
  33. dscrdf.dll     DSCRDataFile WPS class DLL
  34. dscrlst.dll    DSCRFileList WPS class DLL
  35. install.cmd    REXX program for installing WPS DSCR classes
  36. uninst.cmd     REXX program for uninstalling WPS DSCR classes
  37. register.cmd   REXX program for re-registering already installed  WPS  DSCR
  38.                classes
  39. rxdscr.dll     REXX library used by WPS DSCR REXX scripts
  40. READ.ME        This file
  41. wpdsc093.txt   short WPS DSCR package description
  42. file_id.diz    short WPS DSCR package description
  43. FILES.BBS      sample FILES.BBS file
  44. DSCRdf.idl     public IDL file for DSCRDataFile class
  45. DSCRlst.idl    public IDL file for DSCRFileList class
  46. WPSDSCR.IR     SOM Interface Repository for WPS DSCR classes
  47.  
  48. We've included IDL files for our classes. So, if you'd  like  you could now
  49. inherite these  classes. For those  who using ObjectREXX this pack includes
  50. SOM Interface Repository. But note,  WPS  DSCR  installation procedure does
  51. not integrate it to your system. To make use of it you have to  edit   'SET
  52. SOMIR='  statement  in  your CONFIG.SYS your  self  or  use  IBM's merge IR
  53. utility.
  54.  
  55.  
  56. 1. Installation
  57.  
  58. 1.1 First time installation
  59.  
  60. To install these WPS classes you should unzip WPDSCR93.ZIP package  and run
  61. INSTALL.CMD  from  that  directory  where  you've   done  unzipping.  Note,
  62. INSTALL.CMD requires one parameter. It is some directory  contained in your
  63. LIBPATH where WPSDSCR DLLs have  to  be  copied.  For example, I have in my
  64. config.sys the following LIBPATH:
  65.  
  66.     LIBPATH=C:\OS2\DLL;C:\UTILS\OS2APP;/*...*/
  67.  
  68. So, to install  WPSDSCR classes and  copy their DLLs  into  C:\UTILS\OS2APP
  69. I should run:
  70.  
  71.     INSTALL.CMD C:\UTILS\OS2APP
  72.  
  73. After that  you have  to reload  Workplace Shell.  The simpliest  way to do
  74. that is to reboot your system ;-)
  75.  
  76. 1.2 Upgrading from the previous version
  77.  
  78. We've tried  to make upgrading  from the  previous version as  a simple  as
  79. a possible. You simply should run install.cmd as described in the  previous
  80. section. It'll unregister older version of WPSDSCR classes for you and then
  81. place the  reinstallation REXX script into your StartUp  folder and ask you
  82. to  reboot   the  system.  After  you  reboot  the   second  phase  of  the
  83. reinstallation process will  be started. If  some problems will  appear  at
  84. this stage you could try to run uninst.cmd and then again start install.cmd
  85. as described above.
  86.  
  87.  
  88. 2. Removing WPSDSCR classes from your system
  89.  
  90. To remove  WPSDSCR classes from your  system simply run  uninst.cmd, reboot
  91. OS/2 and  then delete  WPS DSCR related files. The  files which are default
  92. copied to your system are:
  93.         DSCRDF.DLL
  94.         DSCRLST.DLL
  95.         RXDSCR.DLL
  96.  
  97. This files should be located in the directory which you have  specified for
  98. WPSDSCR's INSTALL.CMD when installing classes.
  99.  
  100.  
  101. 3. Future enhancements
  102.  
  103. I'm  still  planning to add the  possibility  of editing descriptions in  a
  104. Folder window just like one can  edit object name pressing Alt-F9. Now I've
  105. found  the  ways  to  do  that.  But  it'll  require  much  coding  and  is
  106. associated  with PM hooks  and  SOM  event  framework. So,  I  suppose  the
  107. introduction of this feature will be delayed for some long  period. Another
  108. idea  came  to  our  team  was using external SOM class or REXX script  for
  109. parsing file-list files. Which of  these  ways will be selected depends  on
  110. your opinion.  To my mind using SOM  class for  parsing is more  extendable
  111. way, but REXX scripts could be more simply customized by the end users.
  112.  
  113.  
  114. 4. Usage
  115.  
  116. 4.1 File list settings page
  117.  
  118. "File  list"  page  has been added  to  the  folders  settings notebook. It
  119. containes:
  120. a) Radio  buttons  to specify  whether  you'd like  current  folder to  use
  121. SUBJECT EAs as a  source for descriptions or file-list file.
  122.  
  123. a) entry field  where you could specify the  name of  file-list file to  be
  124. used by this folder. Default value is still FILES.BBS ;)
  125.  
  126.  
  127. 4.2 FileList folder popup menu
  128.  
  129. Now the folders popup menu contains cascade menu item "File list" which has
  130. the yet another item "Apply  settings  to subfolders". I suppose this  does
  131. not requires any furter explanations;)
  132.  
  133. 4.3 "FileList Folder" template object
  134.  
  135. When  WPS  DSCR  classes are installed or at the first time you are calling
  136. settings notebook for some Folder the special template object is created in
  137. Templates folder.  This is very important and powerful  object. It gives an
  138. opportunity to  configure default settings  for all folders. This means you
  139. could configure class DSCRFileList simply editting settings of this object.
  140. But  note,  when  you first open and close some folder it takes the default
  141. settings from this  template  object  and saves 'em in  it's  own  extended
  142. attributes. Well, this feature is not fully studied yet.
  143.  
  144.  
  145. 5. Known bugs
  146.  
  147. a) On some display adapters icons could  dissappeared  (some  Cirrus  Logic
  148. cards, ATI-32 was reported).
  149.  
  150. b) Saving  of  file-list file after editting  does  not cause folder to  be
  151. refreshed. You should still use "Refresh" from folders popup menu.
  152.  
  153. c) Reinstallation may cause additional template objects of DSCRFileList and
  154. DSCRDataFile to be created in Templates folder.
  155.  
  156.  
  157. 6. Warranties
  158.  
  159. Because I'm  not an insurance company I  provide no  any warranties ;)  But
  160. I'll be appreciate you for your messages about errors and any of your ideas
  161. for future enhancements.
  162.  
  163.