home *** CD-ROM | disk | FTP | other *** search
/ OS/2 Shareware BBS: 10 Tools / 10-Tools.zip / opendc12.zip / od124os2.exe / od12oin.exe / readme.txt < prev   
Text File  |  1997-04-02  |  48KB  |  940 lines
  1.  
  2.                         Welcome to IBM OpenDoc (R),
  3.                                 Version 1.2!
  4.  
  5. ----------------------------------------------------------------------------
  6.  
  7. This version of IBM OpenDoc implements level 1.0.4 of OpenDoc (as provided
  8. by Apple) across the Windows NT, Windows 95, OS/2, and AIX platforms.
  9.  
  10. This readme file discusses the functions, prerequisites, and installation
  11. instructions for this release. For the latest information and a list of
  12. known restrictions, please refer to:
  13.       http://www.software.ibm.com/ad/opendoc/downloads/od12news.html.
  14.  
  15. For a description of things we have changed in this version please refer to:
  16.       http://www.software.ibm.com/ad/opendoc/downloads/od12updt.html
  17.  
  18. ----------------------------------------------------------------------------
  19.  
  20.                       Notes for OpenDoc for OS/2 users
  21.  
  22. If you have version 1.0 or earlier of OpenDoc installed on your OS/2 platform,
  23. review this file carefully, especially the "Migrating From Prior OS/2
  24. Versions of OpenDoc" and "Installing OpenDoc on OS/2" sections. Following
  25. those instructions ensure that your installation is not corrupted.
  26.  
  27. Also, certain files provided with OS/2, the OS/2 Developer Toolkit, or IBM
  28. Visual Age C++ for OS/2 must be updated. These System Object Model (SOM)
  29. executables and Presentation Manager (PM) header files are included with
  30. this edition of OpenDoc and are applied during installation of this edition
  31. of OpenDoc. These files contain the latest available corrective service.
  32. ----------------------------------------------------------------------------
  33.  
  34. Contents
  35.  
  36. Three packages are provided, organized by operating system environment:
  37.  
  38.    * Windows (Windows NT and Windows 95)
  39.    * OS/2
  40.    * AIX
  41.  
  42. Each package contains the following:
  43.  
  44.    * Install Facility
  45.      Provided for Windows and OS/2. AIX uses smit.
  46.    * Runtime, including runtimes for parts provided by IBM
  47.    * Documentation
  48.    * Development Toolkit
  49.    * Samples source
  50.    * Source code
  51.  
  52. For Windows NT, Windows 95, or OS/2, you need to download the Install
  53. Facility files plus one other set of files for a minimum installation. To
  54. install the Development Toolkit or the Samples source, you need the Runtime
  55. as well.
  56.  
  57. For AIX, you need to download the Runtime images for a minimum installation.
  58. ----------------------------------------------------------------------------
  59.  
  60. Prerequisites
  61.  
  62. In order to successfully work with this edition of OpenDoc, you need
  63. hardware and software meeting the criteria listed below. Unless otherwise
  64. noted, these criteria are required. The prerequisite software must be
  65. installed before you install OpenDoc.
  66.                             Windows
  67.                        NT            95                 OS/2                 AIX
  68.  Hardware
  69.    Processor      Pentium class Pentium class      Pentium class        Any Power2 or
  70.    (recommended)                                                           PowerPC
  71.    RAM                32 MB         32 MB              32 MB                32 MB
  72.    (recommended)
  73.    Disk Space Needed
  74.     during        This temporary space can be recovered by deleting the downloaded
  75.     installation  files after installation completes.
  76.                    up to 55 MB   up to 55 MB        up to 39 MB          up to 42 MB
  77.     after installation
  78.        Install         5 MB          5 MB               4 MB                 0 MB
  79.         Base          35 MB         35 MB              22 MB                13 MB
  80.      Development       5 MB          5 MB               5 MB                 2 MB
  81.        Toolkit
  82.        Samples        12 MB         12 MB              20 MB                 2 MB
  83.     Documentation      8 MB          8 MB               8 MB                 6 MB
  84.      Source Code       9 MB          9 MB              11 MB                 9 MB
  85.  Software
  86.    Operating        Windows NT   Windows 95    OS/2 Warp Connect with     AIX 4.1.4
  87.    System             3.51                      OS/2 Warp FixPak 17
  88.                                               (for OS/2 Warp J, FixPak
  89.                                                       WX02204)
  90.                                                    OS/2 Warp 4.0           AIX 4.2
  91.    HTML Browser                    HTML 3.0 (tables)-capable browser
  92.    Compiler (if               IBM                        IBM                 IBM
  93.    developing      VisualAge C++ for Windows,  VisualAge C++ for OS/2,  CSET++ for AIX
  94.    parts)                Version 3.5 or             Version 3.0           Compiler,
  95.                      Microsoft Visual C++,                              Version 3.1.4
  96.                           Version 4.0
  97. ----------------------------------------------------------------------------
  98.  
  99. Functions
  100.  
  101. IBM OpenDoc, Version 1.2 supports the following functions and more:
  102.  
  103.    * Opening and closing a document
  104.    * Embedding parts into a document
  105.    * Deleting parts from a document
  106.    * Dragging/dropping parts within and across OpenDoc documents
  107.    * Cutting/copying/pasting parts within and across OpenDoc documents
  108.    * Moving and resizing parts
  109.    * Storing and recalling a document
  110.    * Selecting multiple parts for deletion, dragging/dropping, and
  111.      cutting/copying/pasting
  112.    * Interoperating between OpenDoc and OLE 2.0 parts (embedding,
  113.      dragging/dropping, cutting/copying/pasting, linking)
  114.      Note: this support is provided only where OLE 2.0 is supported, that
  115.      is, on the Windows platforms.
  116.    * Support for building parts with multiple compilers
  117.    * Creating source files for parts
  118.    * Documentation specific to IBM's implementations
  119.    * A formal installation program
  120.    * Scripting of parts using "direct scripting"
  121.  
  122. ----------------------------------------------------------------------------
  123.  
  124. Providing Feedback
  125.  
  126. The IBM OpenDoc team encourages you to report any problems arising from the
  127. execution of the code. Please use the bug report form at:
  128.  
  129.        http://www.software.ibm.com/clubopendoc/forms/bugrptform.html.
  130. ----------------------------------------------------------------------------
  131.  
  132. Installing OpenDoc
  133.  
  134. There are slight differences in the installation procedure depending on your
  135. platform. Please see the section below that is specific to your platform.
  136.  
  137. Installing OpenDoc on Windows NT 3.51
  138.  
  139.   1. Log on as System Administrator
  140.  
  141.      On Windows NT systems, the user who installs OpenDoc MUST be logged on
  142.      to a username with System Administrator privileges. If this
  143.      installation is to support developers who will be building parts, the
  144.      user who installs OpenDoc must be the same user who installed the
  145.      compiler, allowing the OpenDoc install facility to correctly set the
  146.      PATH environment variable.
  147.  
  148.   2. Remove any previous edition of OpenDoc
  149.  
  150.      If you have another version of OpenDoc on your system (or in the
  151.      partition in which you will be installing this edition if you have a
  152.      multi-boot system), you will need to remove it prior to installing this
  153.      version.  The following steps are recommended to remove the other version:
  154.         o If you have version 1.1 or the 08/30/96 edition of IBM OpenDoc
  155.           installed, do the following:
  156.             1. Open the folder IBM OpenDoc for Windows (Common).
  157.             2. Double-click on the UnInstallSHIELD icon.
  158.             3. Reboot the system.
  159.         o If you have the 06/28/96 edition of IBM OpenDoc installed, do the
  160.           following:
  161.             1. Log on as a system administrator.
  162.             2. Run the regsetup -r command.
  163.             3. Delete the directory where IBM OpenDoc for Windows is
  164.                installed (typically, C:\ODBETA1), including all
  165.                subdirectories and files.
  166.             4. Reboot the system.
  167.         o If you have any other version of IBM OpenDoc installed, do the
  168.           following:
  169.             1. Remove references to the other version of OpenDoc from your
  170.                PATH statement and any other environment variables.
  171.             2. Delete the ODBASE environment variable.
  172.             3. Delete the root directory and all lower directories
  173.                containing the other version of OpenDoc.
  174.  
  175.   3. Install this edition of OpenDoc
  176.  
  177.      Follow the steps below to install OpenDoc on your system:
  178.        1. Place (download) the installation facility (OD12WIN.EXE) and all
  179.           of the desired install files into a single directory (the IBM
  180.           OpenDoc team recommends the C:\OD12 directory). The directory must
  181.           conform to DOS file system naming conventions (that is, 8.3
  182.           names).
  183.  
  184.           Use the "File | Save As" menu item from your browser to download
  185.           each file. If you are using Netscape Navigator, you can use the
  186.           "Shift-click" method to download the files, that is, hold down the
  187.           Shift key and click on the file to be downloaded. This causes the
  188.           file to be downloaded rather than displayed through a viewer.
  189.  
  190.        2. Change to that directory (cd C:\OD12).
  191.        3. Review the contents of the directory to ensure that all of the
  192.           files for the Install Facility and the sets of files that you
  193.           desire are present.
  194.        4. Unpack the install facility by running the OD12WIN.EXE program.
  195.        5. Install OpenDoc by running the SETUP.EXE program in the same
  196.           directory, following the instructions provided by the install
  197.           facility. If you had installed version 1.1 of OpenDoc, we recommend
  198.           you install this version into a different directory.
  199.        6. If you have previously installed the IBM VisualAge C++ for Windows
  200.           compiler, you must modify the SOMIR User environment variable.
  201.              + From the Program Manager, open Main->Control Panel->System.
  202.              + In the box titled "User Environment Variables for xxxx",
  203.                locate the SOMIR User environment variable.
  204.              + Add %SOMIR% to the end of the path, ensuring that a semicolon
  205.                (;) separates the orginal value from the appended value.
  206.              + Press the OK button to save the new value.
  207.        7. Reboot the system.
  208.        8. Open the folder IBM OpenDoc.
  209.        9. Double-click on the Install IBM Parts icon to complete the
  210.           installation.
  211.  
  212.   4. Uninstall this edition of OpenDoc
  213.  
  214.      To remove this edition of OpenDoc, do the following:
  215.        1. Open the folder IBM OpenDoc for Windows (Common).
  216.        2. Double-click on the Uninstall IBM OpenDoc icon.
  217.        3. Reboot the system.
  218.  
  219.      The uninstall procedure does not completely remove the changes
  220.      introduced when OpenDoc was installed. Specifically:
  221.         o All files in directories pointed to by the ODBASE, ODPARTS, and
  222.           ODSRC are removed, except any files in user-defined subdirectories
  223.           under the %ODSRC%\src directory.
  224.         o Uninstall does not remove all of the Registry provided by OpenDoc.
  225.           These keys will be reset when OpenDoc is reinstalled.
  226.  
  227. Installing OpenDoc on Windows 95 and Windows NT 4.0
  228.  
  229.   1. Remove any previous edition of OpenDoc
  230.  
  231.      If you have another version of OpenDoc on your system (or in the
  232.      partition in which you will be installing this edition, if you have a
  233.      multi-boot system), you will need to remove it prior to installing this
  234.      version. The IBM OpenDoc team recommends the following steps to remove
  235.      the other version:
  236.         o If you have version 1.1 or the 08/30/96 edition of IBM OpenDoc
  237.           installed, do the following:
  238.             1. Open the folder My Computer.
  239.             2. Open the folder Control Panel.
  240.             3. Double-click on the Add/Remove Programs icon.
  241.             4. Select OpenDoc and click on the Remove button.
  242.             5. Click on the OK button to close the Add/Remove Programs
  243.                program.
  244.             6. Reboot the system.
  245.         o If you have the 06/28/96 edition of IBM OpenDoc installed, do the
  246.           following:
  247.             1. Run the regsetup -r command
  248.             2. Delete the directory where IBM OpenDoc for Windows is
  249.                installed (typically, C:\ODBETA1), including all
  250.                subdirectories and files.
  251.             3. Edit the AUTOEXEC.BAT file to remove the call to
  252.                ODSETENV.BAT.
  253.             4. Reboot the system.
  254.         o If you have the another version of IBM OpenDoc installed, do the
  255.           following:
  256.             1. Remove references to the other version of OpenDoc from your
  257.                PATH statement and any other environment variables.
  258.             2. Delete the ODBASE environment variable.
  259.             3. Delete the OpenDoc root directory and all lower directories
  260.                containing the other version of OpenDoc.
  261.  
  262.   2. Install this edition of OpenDoc
  263.  
  264.      Follow the steps below to install OpenDoc on your system:
  265.        1. Place (download) the installation facility (OD12WIN.EXE) and all
  266.           of the desired install files into a single directory (the IBM
  267.           OpenDoc team recommends the C:\OD12 directory). The directory must
  268.           conform to DOS file system naming conventions (that is, 8.3
  269.           names).
  270.  
  271.           Use the "File | Save As" menu item from your browser to download
  272.           each file. If you are using Netscape Navigator, you can use the
  273.           "Shift-click" method to download the files, that is, hold down the
  274.           Shift key and click on the file to be downloaded. This causes the
  275.           file to be downloaded rather than displayed through a viewer.
  276.  
  277.        2. Change to that directory (cd C:\OD12).
  278.        3. Review the contents of the directory to ensure that all of the
  279.           files for the Install Facility and the sets of files that you
  280.           desire are present.
  281.        4. Unpack the install facility by running the OD12WIN.EXE program.
  282.        5. Install OpenDoc by running the SETUP.EXE program in the same
  283.           directory, following the instructions provided by the install
  284.           facility. If you had installed version 1.1 of OpenDoc, we recommend
  285.           you install this version into a different directory.
  286.        6. Open the folder IBM OpenDoc.
  287.        7. Double-click on the Install IBM Parts icon to complete the
  288.           installation.
  289.  
  290.   3. Uninstall this edition of OpenDoc
  291.  
  292.      To remove this edition of OpenDoc, do the following:
  293.        1. Open the folder My Computer.
  294.        2. Open the folder Control Panel.
  295.        3. Double-click on the Add/Remove Programs icon.
  296.        4. Select OpenDoc and click on the Remove button.
  297.        5. Click on the OK button to close the Add/Remove Programs program.
  298.        6. Reboot the system.
  299.  
  300.      The uninstall procedure does not completely remove the changes
  301.      introduced when OpenDoc was installed. Specifically:
  302.         o All files in directories pointed to by the ODBASE, ODPARTS, and
  303.           ODSRC are removed, except any files in user-defined subdirectories
  304.           under the %ODSRC%\src directory.
  305.         o Uninstall does not remove all of the Registry provided by OpenDoc.
  306.           These keys will be reset when OpenDoc is reinstalled.
  307.  
  308. Installing OpenDoc on OS/2
  309.  
  310.  WARNING: Installing this edition of OpenDoc includes the application of
  311.           corrective service to the SOM executables. There is no procedure
  312.           for removing this corrective service once applied.
  313.  
  314.   1. Set up environment
  315.  
  316.      Previously installed products may have set environment variables that
  317.      need to be unset. Please check the list below for such products:
  318.         o If you have installed IBM Visual Age C++ for OS/2, Version .3.0:
  319.  
  320.           When you install IBM's Visual Age C++ for OS/2, Version .3.0, it
  321.           installs other OS/2 products as well. For instance, a version of
  322.           IBM SOMObjects 2.1 is installed, and a version of the OS/2
  323.           Developer's Toolkit is installed.
  324.  
  325.           The installation of IBM Visual Age C++ for OS/2 probably created
  326.           changes to several important environment variables in your
  327.           CONFIG.SYS file:
  328.              + LIBPATH
  329.              + PATH
  330.              + SOMIR
  331.  
  332.           This edition of OpenDoc installs a more current version of parts
  333.           of the IBM SOMObjects 2.1 runtimes and of the OS/2 include files
  334.           and lib files from the OS/2 Developer's Toolkit. It will attempt
  335.           to update or correct the environment variables shown above. In
  336.           general, after installing OpenDoc, you will no longer need
  337.           references to %CPPMAIN%\include\OS2 in your make files or in the
  338.           INCLUDE environment variables. You will no longer need references
  339.           to %CPPMAIN%\lib\OS2 in your makefile or in the LIB environment
  340.           variables.
  341.  
  342.           The SOM include files and SOM runtimes are part of the code
  343.           installed with this version of OpenDoc. They are more current than
  344.           what was shipped in the 3.0 version of the IBM Visual Age C++ for
  345.           OS/2 product or in its CSDs. You will need to remove references to
  346.           any %CPPMAIN%\*\SOM directories from your PATH or LIBPATH
  347.           environment variables.
  348.  
  349.           Be careful to observe the above ordering of files.
  350.  
  351.         o If you have installed SOMObjects 2.1 for OS/2:
  352.  
  353.           The installation of IBM SOMObjects 2.1 for OS/2 probably created
  354.           changes to several important environment variables in your
  355.           CONFIG.SYS file:
  356.              + SOMBASE
  357.              + LIBPATH
  358.              + PATH
  359.              + SOMIR
  360.  
  361.           This edition of OpenDoc installs more current versions of parts of
  362.           the IBM SOMObjects 2.1 runtimes and OS/2 include files and lib
  363.           files from the OS/2 Developer's Toolkit. It attempts to update or
  364.           correct the environment variables shown above. In general, after
  365.           installing OpenDoc, you no longer need references to
  366.           %SOMBASE%\include\ in your make files or in the INCLUDE
  367.           environment variables. In addition, you no longer need references
  368.           to %SOMBASE%\lib\ in your makefile or in the LIB environment
  369.           variables.
  370.  
  371.           Remove any references to paths that start with the directory named
  372.           by %SOMBASE% from your LIBPATH and PATH statements before you
  373.           begin to install this version of OpenDoc.
  374.  
  375.         o If you have installed an OS/2 Developer Toolkit:
  376.  
  377.           The installation of an IBM OS/2 Developer Toolkit probably created
  378.           changes to several important environment variables in your
  379.           CONFIG.SYS file:
  380.              + LIBPATH
  381.              + PATH
  382.              + SOMIR
  383.  
  384.           This edition of OpenDoc installs more current versions of parts of
  385.           the IBM SOMObjects 2.1 runtimes and OS/2 include files and lib
  386.           files from the OS/2 Developer's Toolkit. It attempts to update or
  387.           correct the environment variables shown above. In general, after
  388.           installing OpenDoc, you no longer need references to the include
  389.           Toolkit directory in your make files or in the INCLUDE environment
  390.           variables. In addition, you no longer need references to the lib
  391.           Toolkit directory in your makefile or in the LIB environment
  392.           variables.
  393.  
  394.           Examine any references to paths that start with the directory
  395.           named by the Toolkit in your LIBPATH and PATH statements, before
  396.           you begin to install this version of OpenDoc. You do not need any
  397.           SOM or OS/2 header or lib information from the Toolkit.
  398.  
  399.   2. Disable any previous edition of OpenDoc
  400.         o If you have version 1.1 installed, we recommend you install
  401.           version 1.2 in a different directory.
  402.  
  403.         o If you have the 8/30/96 beta edition installed, do the following:
  404.             1. Open the folder OpenDoc for OS/2.
  405.             2. Double-click on the Uninstall OpenDoc icon.
  406.                Follow the instructions provided by the uninstall program.
  407.             3. Reboot the system.
  408.  
  409.           The OpenDoc for OS/2 folder and the Uninstall OpenDoc icon will
  410.           remain following the uninstall procedure. They can be manually
  411.           deleted.
  412.  
  413.         o If you have OpenDoc for OS/2, Version 1.0 (beta or
  414.           generally-available editions) installed, you must disable it prior
  415.           to the installation of this edition of OpenDoc. To determine if
  416.           you have a previous version of OpenDoc installed on your OS/2
  417.           system, issue the following command from an OS/2 command prompt:
  418.  
  419.              echo %SOMIR%
  420.  
  421.           If you see a file named OPENDOC.IR in the results of this command,
  422.           you have OpenDoc installed. Note the second parent directory of
  423.           the OPENDOC.IR file. For example, if the file is listed as
  424.           C:\OPENDOC\BIN\OPENDOC.IR, the second parent directory is
  425.           C:\OPENDOC. This directory is the base directory for the previous
  426.           version of OpenDoc.
  427.  
  428.           If a previous version is installed, do the following:
  429.             1. Make a backup copy of the CONFIG.SYS file.
  430.             2. Edit the CONFIG.SYS file to remove any references to the base
  431.                directory for the previous version of OpenDoc.
  432.             3. Reboot the system.
  433.             4. Change to the base directory, as determined above.
  434.             5. Go to the parent of the base directory by issuing the
  435.                command:
  436.                cd ..
  437.             6. Rename the base directory, using the rename command. The IBM
  438.                OpenDoc team suggests renaming the directory to OLD_OD.
  439.             7. If you have any other OpenDoc-related directories (perhaps
  440.                associated with parts that you have built or acquired) the
  441.                IBM OpenDoc team suggests you rename those directories as
  442.                well.
  443.  
  444.           Alternately, you may uninstall the previous version by following
  445.           the uninstall instructions provided with that version. We have
  446.           observed some problems in the behavior of the current version of
  447.           OpenDoc (such as corruption of the .ir file) due to the incomplete
  448.           removal of the prior version. The procedure described above does
  449.           not avoid these problems, but preserves the capability to revert
  450.           to the prior version easily.
  451.  
  452.   3. Install this edition of OpenDoc
  453.  
  454.      Follow the steps below to install OpenDoc on your system:
  455.        1. Edit the CONFIG.SYS file to insure that references to
  456.           %CPPBASE%\INCLUDE\SOM are removed from the SMINCLUDE and INCLUDE
  457.           environment variables. These variables are added to the CONFIG.SYS
  458.           file when the IBM VisualAge C++ compiler is installed. If you
  459.           install the compiler after installing OpenDoc, you need to remove
  460.           these references following the compiler installation.
  461.        2. Place (download) the installation facility (OD12OIN.EXE) and all
  462.           of the desired install files into a single directory (the IBM
  463.           OpenDoc team recommends the C:\OD12 directory). The directory must
  464.           conform to DOS file system naming conventions (that is, 8.3
  465.           names).
  466.  
  467.           Use the "File | Save As" menu item from your browser to download
  468.           each file. If you are using Netscape Navigator, you can use the
  469.           "Shift-click" method to download the files, that is, hold down the
  470.           Shift key and click on the file to be downloaded. This causes the
  471.           file to be downloaded rather than displayed through a viewer.
  472.  
  473.        3. Change to that directory (cd C:\OD12).
  474.        4. Review the contents of the directory to ensure that all of the
  475.           files for the Install Facility and the sets of files that you
  476.           desire are present.
  477.        5. Unpack the install facility by running the OD12OIN.EXE program.
  478.        6. Install OpenDoc by running the INSTALL.EXE program in the same
  479.           directory, following the instructions provided by the Install
  480.           Facility.
  481.        7. Reboot the system.
  482.        8. Open the folder IBM OpenDoc folder.
  483.        9. Double-click on the Install IBM Parts icon to complete the
  484.           installation.
  485.  
  486.   4. Uninstall this edition of OpenDoc
  487.  
  488.      To remove this edition of OpenDoc, do the following:
  489.        1. Open the folder OpenDoc for OS/2.
  490.        2. Double-click on the Uninstall OpenDoc icon.
  491.           Follow the instructions provided by the uninstall program.
  492.        3. Reboot the system.
  493.  
  494.      The uninstall procedure removes all of OpenDoc's files, except for
  495.      files related to parts. These files may be manually deleted.
  496.  
  497.   5. Restore Previous Version of OpenDoc
  498.  
  499.      If you renamed the directories related to the previous version of
  500.      OpenDoc according to the instructions in the "Disable Any Previous
  501.      Versions of OpenDoc" section, you may restore the previous version. To
  502.      do so, do the following:
  503.        1. Change to the old base directory, that is, the one suggested to be
  504.           named OLD_OD.
  505.        2. Go to the parent of the old base directory by issuing the command:
  506.  
  507.           cd ..
  508.        3. Rename the old base directory to its original name, using the
  509.           rename command.
  510.        4. If you renamed other directories, rename them to their original
  511.           names.
  512.        5. Restore the references to the old base directory in the CONFIG.SYS
  513.           file. Refer to the backup copy you created prior to installing
  514.           this edition of OpenDoc to determine which references need to be
  515.           restored. Do not copy the backup file over the current file,
  516.           unless you are certain that no other updates to CONFIG.SYS have
  517.           occurred since this edition of OpenDoc was installed.
  518.        6. Reboot the system.
  519.  
  520. Installing OpenDoc on AIX
  521.  
  522.  WARNING: Installing this edition of OpenDoc includes the application of
  523.           corrective service to the SOM executables.
  524.  
  525.  NOTE:    If you have version 1.1 of OpenDoc there is no need to remove it.
  526.           You may install version 1.2 on top of it.
  527.  
  528.   1. Install this edition of OpenDoc
  529.         o Follow the steps below to install OpenDoc on your AIX 4.1.4
  530.           system:
  531.             1. Create a directory on your system to hold the downloaded
  532.                images.
  533.             2. Download all of the images to this directory.
  534.  
  535.                Use the "File | Save As" menu item from your browser to
  536.                download each file. If you are using Netscape Navigator, you
  537.                can use the "Shift-click" method to download the files, that
  538.                is, hold down the Shift key and click on the file to be
  539.                downloaded. This causes the file to be downloaded rather than
  540.                displayed through a viewer.
  541.  
  542.             3. Become superuser for the system ("su" or login as root).
  543.             4. Before you begin installing OpenDoc onto AIX, you should
  544.                check that your locale is properly defined:
  545.                   + Start the SMIT program.
  546.                   + Select "System Environments".
  547.                   + Select "Manage Language Environment".
  548.                   + Select "Change Language Environment".
  549.                   + Select your locale if its not already selected.
  550.                   + Exit SMIT.
  551.  
  552.                Please note that OpenDoc message files are only shipped in
  553.                the primary code page associated with the lowercase locale
  554.                name (i.e. xx_YY not Xx_YY). locale name.
  555.  
  556.             5. Change to the directory holding the downloaded images.
  557.             6. Start the smit program.
  558.             7. Select "Software Installation and Maintenance".
  559.             8. Select "Install and Update Software".
  560.             9. Select "Install/Update Selectable Software (Custom Install)".
  561.            10. Select "Install Software Products at Latest Level".
  562.            11. Select "Install New Software Products at Latest Level"
  563.            12. Enter "." for "INPUT device / directory for software" entry
  564.                field.
  565.            13. If you are only going to install the OpenDoc runtime, enter
  566.                "OpenDoc.rte" in the "SOFTWARE to install" entry field on the
  567.                next screen. If you are going to install all of OpenDoc,
  568.                enter "OpenDoc.*" in the "SOFTWARE to install" entry field.
  569.                In either case, you must select YES for installing any
  570.                software prereqs. ("OpenDoc.msg.en_US" is a prereq of
  571.                "OpenDoc.rte") Press the Enter key.
  572.            14. Press Enter again for the "ARE YOU SURE?" dialog to continue
  573.                installation.
  574.            15. The images are installed (including all prerequisite images).
  575.            16. After successful installation, the SMIT screen displays a
  576.                highlighted OK in the status field at the top of the screen
  577.                and a table of status results at the bottom of the smit log
  578.                showing "SUCCESS" for all install components.
  579.  
  580.           To complete the setup of IBM OpenDoc for a particular user, do the
  581.           following:
  582.             1. Log in as the particular user.
  583.             2. Open the folder IBM OpenDoc.
  584.             3. Double-click on the Install IBM Parts icon to complete the
  585.                setup.
  586.             4. Before running OpenDoc, environment variables must be set
  587.                within the session. These variables are set by running:
  588.  
  589.                   . /usr/OpenDoc/bin/odsetenv
  590.  
  591.                This command may be added to the user's .profile file so that
  592.                the command always runs when a session starts.
  593.  
  594.         o Follow the steps below to install OpenDoc on your AIX 4.2 system:
  595.             1. Create a directory on your system to hold the downloaded
  596.                images.
  597.             2. Download all of the images to this directory.
  598.  
  599.                Use the "File | Save As" menu item from your browser to
  600.                download each file. If you are using Netscape Navigator, you
  601.                can use the "Shift-click" method to download the files, that
  602.                is, hold down the Shift key and click on the file to be
  603.                downloaded. This causes the file to be downloaded rather than
  604.                displayed through a viewer.
  605.  
  606.             3. Become superuser for the system ("su" or login as root).
  607.             4. Before you begin installing OpenDoc onto AIX, you should
  608.                check that your locale is properly defined:
  609.                   + Start the SMIT program.
  610.                   + Select "System Environments".
  611.                   + Select "Manage Language Environment".
  612.                   + Select "Change Language Environment".
  613.                   + Select your locale if its not already selected.
  614.                   + Exit SMIT.
  615.  
  616.                Please note that OpenDoc message files are only shipped in
  617.                the primary code page associated with the lowercase locale
  618.                name (i.e. xx_YY not Xx_YY). locale name.
  619.  
  620.             5. Change to the directory holding the downloaded images.
  621.             6. Start the SMIT program.
  622.             7. Select "Software Installation and Maintenance".
  623.             8. Select "Install and Update Software".
  624.             9. Select "Install and Update from LATEST Available Software".
  625.            10. Enter "." for "INPUT device / directory for software" entry
  626.                field.
  627.            11. If you are only going to install the OpenDoc runtime, enter
  628.                "OpenDoc.rte" in the "SOFTWARE to install" entry field on the
  629.                next screen. If you are going to install all of OpenDoc,
  630.                enter "OpenDoc.*" in the "SOFTWARE to install" entry field.
  631.                In either case, you must select YES for installing any
  632.                software prereqs. ("OpenDoc.msg.en_US" is a prereq of
  633.                "OpenDoc.rte") Press the Enter key.
  634.            12. Press Enter again for the "ARE YOU SURE?" dialog to continue
  635.                installation.
  636.            13. The images are installed (including all prerequisite images).
  637.            14. After successful installation, the SMIT screen displays a
  638.                highlighted OK in the status field at the top of the screen
  639.                and a table of status results at the bottom of the smit log
  640.                showing "SUCCESS" for all install components.
  641.            15. Exit SMIT.
  642.  
  643.           To complete the setup of IBM OpenDoc for a particular user, do the
  644.           following:
  645.             1. Log in as the particular user.
  646.             2. Open the folder IBM OpenDoc.
  647.             3. Double-click on the Install IBM Parts icon to complete the
  648.                setup.
  649.             4. Before running OpenDoc, environment variables must be set
  650.                within the session. These variables are set by running:
  651.  
  652.                   . /usr/OpenDoc/bin/odsetenv
  653.  
  654.                This command may be added to the user's .profile file so that
  655.                the command always runs when a session starts.
  656.  
  657.   2. Uninstall this edition of OpenDoc
  658.  
  659.      To remove this edition of OpenDoc from your AIX 4.1.4 system, do the
  660.      following:
  661.        1. Become superuser for the system ("su" or login as root).
  662.        2. Start the smit program.
  663.        3. Select "Software Installation and Maintenance".
  664.        4. Select "Maintain Installed Software".
  665.        5. Select "Remove Software Products".
  666.        6. If you are going to uninstall all of OpenDoc, enter "OpenDoc.*" in
  667.           the "SOFTWARE name" entry field. If you are only going to
  668.           uninstall the OpenDoc runtime, enter "OpenDoc.rte" in the
  669.           "SOFTWARE name" entry field.
  670.        7. Toggle the "PREVIEW only?" field from "yes" to "no". Press the
  671.           Enter key.
  672.        8. Press Enter again for the "ARE YOU SURE?" dialog to continue
  673.           uninstalling.
  674.        9. The OpenDoc images are uninstalled.
  675.       10. After successful uninstallation, the SMIT screen displays a
  676.           highlighted OK in the status field at the top of the screen and a
  677.           table of status results at the bottom of the smit log showing
  678.           "SUCCESS" for all uninstalled components.
  679.  
  680.      To remove this edition of OpenDoc from your AIX 4.2 system, do the
  681.      following:
  682.        1. Become superuser for the system ("su" or login as root).
  683.        2. Start the smit program.
  684.        3. Select "Software Installation and Maintenance".
  685.        4. Select "Software Maintenance and Utilities".
  686.        5. Select "Remove Installed Software".
  687.        6. If you are going to uninstall all of OpenDoc, enter "OpenDoc.*" in
  688.           the "SOFTWARE name" entry field. If you are only going to
  689.           uninstall the OpenDoc runtime, enter "OpenDoc.rte" in the
  690.           "SOFTWARE name" entry field.
  691.        7. Toggle the "PREVIEW only?" field from "yes" to "no". Press the
  692.           Enter key.
  693.        8. Press Enter again for the "ARE YOU SURE?" dialog to continue
  694.           uninstalling.
  695.        9. The OpenDoc images are uninstalled.
  696.       10. After successful uninstallation, the SMIT screen displays a
  697.           highlighted OK in the status field at the top of the screen and a
  698.           table of status results at the bottom of the smit log showing
  699.           "SUCCESS" for all uninstalled components.
  700.  
  701.      For either version of AIX, follow these steps to clean up each user's
  702.      workspace:
  703.        1. If . /usr/OpenDoc/bin/odsetenv was added to the user's .profile
  704.           file, edit the .profile file to remove this command.
  705.        2. Delete the .odrc file from the user's home directory.
  706.  
  707.           This file is created when a user double-clicks on the Install IBM
  708.           Parts icon. This file remembers certain environment settings which
  709.           will persist into any subsequent installation of IBM OpenDoc
  710.           unless the user deletes the file.
  711.  
  712.        3. Delete directories pointed to by the $ODPARTS and $ODCFG
  713.           environment variables.
  714.  
  715.           Do not delete these directories if they contain files that you
  716.           wish to keep.
  717.  
  718.        4. Unlink the following symbolic links:
  719.              + $HOME/.dt/appmanager/IBM_OpenDoc_Editors
  720.              + $HOME/.dt/appmanager/IBM_OpenDoc_Stationery
  721.              + $HOME/.dt/appmanager/IBM_OpenDoc_ShellPlugins
  722.              + $HOME/.dt/appmanager/IBM_OpenDoc_Documents
  723.  
  724. ----------------------------------------------------------------------------
  725.  
  726. Finding the Documentation
  727.  
  728. You can access the books for IBM OpenDoc, Version 1.2, by pointing your HTML
  729. browser at the doc\en_US\index.htm file under the base OpenDoc directory
  730. (that is, the directory specified in the ODBASE environment variable). From
  731. this file, you will be able to link to the OpenDoc Programming Guide,
  732. OpenDoc Programming Reference, and OpenDoc Problem Determination Guide
  733. documents.
  734.  
  735. ----------------------------------------------------------------------------
  736.  
  737. Running OpenDoc
  738.  
  739. To create a new empty document, open the IBM OpenDoc folder and double-click
  740. on the OpenDoc icon. Alternately, issue the following command:
  741.  
  742.   docshell
  743.  
  744. Note: On Windows 95, you must run the odsetenv.bat command file to set the
  745. environment properly before launching the docshell command from the command
  746. prompt.
  747.  
  748. The OpenDoc Root Part Selection dialog box displays with a list of part
  749. kinds from which you can select the part kind for the root part of the new
  750. OpenDoc document. Select one of the available part kinds and click on the OK
  751. button. The following part kinds are installed and registered by default with
  752. this edition:
  753.  
  754.            Part Kind Name                         Description
  755.  IBM Base Container                  A basic container part without any
  756.                                      content data of its own.
  757.  Frame List                          A synonym for Base Container.
  758.  Link Container                      A container part with linking.
  759.  OLE Part (*)                        The part editor that handles embedded
  760.                                      OLE objects.
  761.                                      Typically, this part editor is not run
  762.                                      as a root part. It is embedded in some
  763.                                      other root part to allow an OLE server
  764.                                      object to be embedded.
  765.  Scriptable Graph Part (+)           A scriptable container part that
  766.                                      demonstrates creation of shapes.
  767.  Shape Part (+)                      An irregularly-shaped leaf part.
  768.  Simple Part                         A leaf part.
  769.  Text Part (+)                       A container part that supports
  770.                                      importing and exporting of text.
  771.  Timer                               A utility part used by scripting.
  772.  
  773.  (*) denotes part kinds supported only on Windows NT and Windows 95.
  774.  (+) denotes part kinds supported only on Windows NT, Windows 95, and OS/2.
  775.  
  776. The following part kinds are provided but are not registered by default.
  777. If you had installed version 1.1 previously, you should erase the version 1.1
  778. DLLs for the following part kinds from the version 1.1 install directories
  779. before installing version 1.2 support for these part kinds.
  780.  
  781. You may register a part by dropping its .odz file onto the Part Editor Install
  782. icon in the IBM OpenDoc folder.  The .odz files may be found in the pkg
  783. directory pointed to by the ODBASE environment variable.
  784.  
  785.            Part Kind Name                         Description
  786.  Clock (+)                       A running analog clock.
  787.  Dynamic Part (+)                A leaf part that demonstrates dynamic
  788.                                  updates, even when the part is not active.
  789.  Graphics Part (+)               A container part that demonstrates
  790.                                  creation of shapes.
  791.  JavaPart (*)                    A part that allows Java applets to be
  792.                                  embedded into OpenDoc containers.  Before
  793.                                  this part is installed and registered, a
  794.                                  Java runtime must be installed.
  795.  PageLayout (+)                  A container part demonstrating pagination
  796.                                  and printing.
  797.  Scriptable Base Container (*)   A container part supporting direct scripting.
  798.  Scriptable Simple Part (*)      A simple leaf part supporting direct scripting.
  799.  Scriptable Simple 1 (*)         An alternate version of Scriptable Simple
  800.                                  Part - see the version 1.2 update notes.
  801.  Scriptable Simple 2 (*)         An alternate version of Scriptable Simple
  802.                                  Part - see the version 1.2 update notes.
  803.  
  804. You may register additional part kinds if you provide additional part
  805. editors. Watch Club OpenDoc for more part editors.
  806.  
  807. We provide several additional part editors as samples. These part editors
  808. may be found in subdirectories underneath the src directory under the
  809. directory pointed to by the ODSRC environment variable. These additional
  810. part editors are:
  811.  Additional Part Kind Name                   Description
  812.  Bitmap (*)                A leaf part that displays bitmaps.
  813.  Card Game (*)             A container part for playing poker or blackjack.
  814.  CDPlayer (*)              A leaf part that controls the playing of compact
  815.                            disks.
  816.  ClockPartKind (#)         A leaf part which provides a clock widget.
  817.  
  818.  Mandelbrot (*)            A leaf part that displays Mandelbrot sets.
  819.  PianoPart (*)             A container part that plays .wav files.
  820.  PushButtonPartKind (#)    A leaf part which provides a push button widget.
  821.  StaffPart (*)             A container part that composes files that may be
  822.                            played using PianoPart part editor.
  823.  TextPartKind (#)          A leaf part which provides a text widget.
  824.  TickerPartKind (#)        A leaf part that scrolls a text banner across
  825.                            the part facet.
  826.  T3GamePart (*)            A container part for playing a 3D Tic-Tac-Toe
  827.                            game.
  828.  (*) denotes part kinds supported only on Windows NT and Windows 95.
  829.  (+) denotes part kinds supported only on Windows NT, Windows 95, and OS/2.
  830.  
  831.  (#) denotes part kinds supported only on AIX.
  832.  
  833. To load an existing document, issue the following command line command:
  834.  
  835.   docshell -f file_name
  836.  
  837. Where file_name is the name of the OpenDoc document file containing the
  838. document you want to load.
  839.  
  840. On Windows 95, OS/2, and AIX, stationery in the "Stationery" subfolder may
  841. be used to create document parts. Open the folder and drag one of the
  842. stationery icons to an open document. This action opens the part editor for
  843. the type of stationery dropped into the document.
  844. ----------------------------------------------------------------------------
  845.  
  846. Building Parts
  847.  
  848. Prior to building the sample parts provided in this edition, please note the
  849. following:
  850.  
  851.    * For Windows NT:
  852.  
  853.      Before installing and registering a part enabled for OLE Scripting, be
  854.      sure to log on with System Administrator privileges.
  855.  
  856.    * For OS/2:
  857.  
  858.      Run odsomxh.cmd before building any of the sample parts provided with
  859.      this edition. Failure to run this command could result in the use of
  860.      incompatible header files.
  861.  
  862.    * For AIX:
  863.  
  864.      Run odmkSampleTree to create a writeable copy of the samples source
  865.      tree. This copy will be placed where the environment variable $ODSRC
  866.      points.
  867.  
  868.      Run /usr/lpp/som/somxh before building any of the sample parts provided
  869.      with this edition.
  870.  
  871. The make files provided with the samples demonstrate how to explicitly
  872. specify the path to the proper version of the header files, negating the
  873. need to have the SMINCLUDE and INCLUDE environment variables set.
  874.  
  875. The sample makefiles are all named "makefile" to conform to the "nmake"
  876. default makefile name. The OpenDoc sample makefile system, provides
  877. recursive subdirectory walking macro which relies on the makefile name being
  878. "makefile" in each subdirectory to be traversed. Keep this in mind if you
  879. plan to add samples to the existing list of OpenDoc.
  880.  
  881. If you install the IBM VisualAge C++ for OS/2 compiler or the OS/2
  882. Developer's Toolkit after installing OpenDoc, these environment variables
  883. must be manually unset by adding the following lines to the end of your
  884. CONFIG.SYS file:
  885.  
  886.         SET SMINCLUDE=
  887.         SET INCLUDE=
  888.  
  889. For Windows NT or Windows 95, association of stationery icons with your
  890. newly-build part editor must be done manually.
  891. ----------------------------------------------------------------------------
  892.  
  893. Source Code
  894.  
  895. To improve your ability to understand this edition as well as to assist in
  896. your debugging, the source code is included with this edition. The bulk of
  897. the files are provided, but files necessary to actually build the binaries
  898. are excluded. In a typical installation the source code files are in the
  899. directory %ODBASE%\SRC. A complete list of source files which exist on your
  900. system after successful installation is available in the file
  901. %ODBASE%\SRC\SRCFILES.LST.
  902.  
  903. The license agreement stipulates that you only use the source code for
  904. debugging and education. Be wary about exploiting side effects that you
  905. discover in the source code, because the IBM OpenDoc team may change the
  906. code in future editions.
  907.  
  908. ----------------------------------------------------------------------------
  909.  
  910. Migrating From Prior OS/2 Versions of OpenDoc
  911.  
  912. If you have been using version 1.0 or earlier of OpenDoc on OS/2, you will
  913. find that parts compiled for the earlier version will not run on this
  914. version, due to changes in interfaces and linkage. You need to obtain
  915. recompiled versions of parts before they will work with this version of
  916. OpenDoc.
  917.  
  918. If you have been developing parts on version 1.0 or earlier of OpenDoc on
  919. OS/2, you will notice some differences in this release. The interfaces are
  920. equivalent, with minor changes to achieve better consistency across
  921. different platforms. To better understand the changes, consult the OpenDoc
  922. Programming Reference manual available in softcopy with this edition.
  923.  
  924. You may also notice differences in behavior of some of the part editors. The
  925. IBM OpenDoc team has rewritten the BaseContainer part editor to achieve
  926. better consistency across platforms. Parts that subclass from BaseContainer
  927. may also display these differences.
  928.  
  929. ----------------------------------------------------------------------------
  930. ⌐ 1996, 1997 IBM Corporation. All rights reserved.
  931.  
  932. AIX, OS/2, and VisualAge for C++ are trademarks of IBM.
  933. OpenDoc, Apple, the Apple Logo and Macintosh are trademarks of Apple
  934. Computer, Inc., registered in the United States and other countries.
  935. Pentium is a trademark of Intel Corporation.
  936. Microsoft, Microsoft Excel, Microsoft Word, OLE, Windows, and the Windows 95
  937. logo are trademarks or registered trademarks of Microsoft Corporation.
  938. Netscape Communications, Netscape and Netscape Navigator are trademarks of
  939. Netscape Communications Corporation.
  940.