Functions

IBM OpenDoc, Version 1.2 supports the following functions and more:

• Opening and closing a document
• Embedding parts into a document
• Deleting parts from a document
• Dragging/dropping parts within and across OpenDoc documents
• Cutting/copying/pasting parts within and across OpenDoc documents
• Moving and resizing parts
• Storing and recalling a document
• Selecting multiple parts for deletion, dragging/dropping, and cutting/copying/pasting
• Interoperating between OpenDoc and OLE 2.0 parts (embedding, dragging/dropping, cutting/copying/pasting, linking)

Note: this support is provided only where OLE 2.0 is supported, that is, on the Windows platforms.
• Support for building parts with multiple compilers
• Creating source files for parts
• Documentation specific to IBM's implementations
• A formal installation program
• Scripting of parts using "direct scripting"

There are slight differences in the installation procedure depending on your platform. Please see the section below that is specific to your platform.Installing OpenDoc on Windows NT 3.51

1. Log on as System Administrator

 

 
 
 

On Windows NT systems, the user who installs OpenDoc MUST be logged on to a username with System Administrator privileges. If this installation is to support developers who will be building parts, the user who installs OpenDoc must be the same user who installed the compiler, allowing the OpenDoc install facility to correctly set the PATH environment variable.

2. Remove any previous edition of OpenDoc

 

 
 
 

If you have another version of OpenDoc on your system (or in the partition in which you will be installing this edition if you have a multi-boot system), you will need to remove it prior to installing this version. The following steps are recommended to remove the other version:

• If you have version 1.1 or the 08/30/96 edition of IBM OpenDoc installed, do the following:
1. Open the folder IBM OpenDoc for Windows (Common).
2. Double-click on the UnInstallSHIELD icon.
3. Reboot the system.
• If you have the 06/28/96 edition of IBM OpenDoc installed, do the following:
1. Log on as a system administrator.
2. Run the regsetup -r command.
3. Delete the directory where IBM OpenDoc for Windows is installed (typically, C:\ODBETA1), including all subdirectories and files.
4. Reboot the system.
• If you have any other version of IBM OpenDoc installed, do the following:
1. Remove references to the other version of OpenDoc from your PATH statement and any other environment variables.
2. Delete the ODBASE environment variable.
3. Delete the root directory and all lower directories containing the other version of OpenDoc.
3. Install this edition of OpenDoc

 

 
 
 

Follow the steps below to install OpenDoc on your system:

1. Place (download) the installation facility (OD12WIN.EXE) and all of the desired install files into a single directory (the IBM OpenDoc team recommends the C:\OD12 directory). The directory must conform to DOS file system naming conventions (that is, 8.3 names).

 

 
 
 

Use the "File | Save As" menu item from your browser to download each file. If you are using Netscape Navigator, you can use the "Shift-click" method to download the files, that is, hold down the Shift key and click on the file to be downloaded. This causes the file to be downloaded rather than displayed through a viewer.

2. Change to that directory (cd C:\OD12).
3. Review the contents of the directory to ensure that all of the files for the Install Facility and the sets of files that you desire are present.
4. Unpack the install facility by running the OD12WIN.EXE program.
5. Install OpenDoc by running the SETUP.EXE program in the same directory, following the instructions provided by the install facility.
6. If you have previously installed the IBM VisualAge C++ for Windows compiler, you must modify the SOMIR User environment variable.
• From the Program Manager, open Main->Control Panel->System.
• In the box titled "User Environment Variables for xxxx", locate the SOMIR User environment variable.
• Add %SOMIR% to the end of the path, ensuring that a semicolon (;) separates the orginal value from the appended value.
• Press the OK button to save the new value.
7. Reboot the system.
8. Open the folder IBM OpenDoc.
9. Double-click on the Install IBM Parts icon to complete the installation.
4. Uninstall this edition of OpenDoc

 

 
 
 

To remove this edition of OpenDoc, do the following:

1. Open the folder IBM OpenDoc for Windows (Common).
2. Double-click on the Uninstall IBM OpenDoc icon.
3. Reboot the system.
The uninstall procedure does not completely remove the changes introduced when OpenDoc was installed. Specifically:
• All files in directories pointed to by the ODBASE, ODPARTS, and ODSRC are removed, except any files in user-defined subdirectories under the %ODSRC%\src directory.
• Uninstall does not remove all of the Registry provided by OpenDoc. These keys will be reset when OpenDoc is reinstalled.

1. Remove any previous edition of OpenDoc

 

 
 
 

If you have another version of OpenDoc on your system (or in the partition in which you will be installing this edition, if you have a multi-boot system), you will need to remove it prior to installing this version. The IBM OpenDoc team recommends the following steps to remove the other version:

• If you have version 1.1 or the 08/30/96 edition of IBM OpenDoc installed, do the following:
1. Open the folder My Computer.
2. Open the folder Control Panel.
3. Double-click on the Add/Remove Programs icon.
4. Select OpenDoc and click on the Remove button.
5. Click on the OK button to close the Add/Remove Programs program.
6. Reboot the system.
• If you have the 06/28/96 edition of IBM OpenDoc installed, do the following:
1. Run the regsetup -r command
2. Delete the directory where IBM OpenDoc for Windows is installed (typically, C:\ODBETA1), including all subdirectories and files.
3. Edit the AUTOEXEC.BAT file to remove the call to ODSETENV.BAT.
4. Reboot the system.
• If you have the another version of IBM OpenDoc installed, do the following:
1. Remove references to the other version of OpenDoc from your PATH statement and any other environment variables.
2. Delete the ODBASE environment variable.
3. Delete the OpenDoc root directory and all lower directories containing the other version of OpenDoc.
2. Install this edition of OpenDoc

 

 
 
 

Follow the steps below to install OpenDoc on your system:

1. Place (download) the installation facility (OD12WIN.EXE) and all of the desired install files into a single directory (the IBM OpenDoc team recommends the C:\OD12 directory). The directory must conform to DOS file system naming conventions (that is, 8.3 names).

 

 
 
 

Use the "File | Save As" menu item from your browser to download each file. If you are using Netscape Navigator, you can use the "Shift-click" method to download the files, that is, hold down the Shift key and click on the file to be downloaded. This causes the file to be downloaded rather than displayed through a viewer.

2. Change to that directory (cd C:\OD12).
3. Review the contents of the directory to ensure that all of the files for the Install Facility and the sets of files that you desire are present.
4. Unpack the install facility by running the OD12WIN.EXE program.
5. Install OpenDoc by running the SETUP.EXE program in the same directory, following the instructions provided by the install facility.
6. Open the folder IBM OpenDoc.
7. Double-click on the Install IBM Parts icon to complete the installation.
3. Uninstall this edition of OpenDoc

 

 
 
 

To remove this edition of OpenDoc, do the following:

1. Open the folder My Computer.
2. Open the folder Control Panel.
3. Double-click on the Add/Remove Programs icon.
4. Select OpenDoc and click on the Remove button.
5. Click on the OK button to close the Add/Remove Programs program.
6. Reboot the system.
The uninstall procedure does not completely remove the changes introduced when OpenDoc was installed. Specifically:
• All files in directories pointed to by the ODBASE, ODPARTS, and ODSRC are removed, except any files in user-defined subdirectories under the %ODSRC%\src directory.
• Uninstall does not remove all of the Registry provided by OpenDoc. These keys will be reset when OpenDoc is reinstalled. 

WARNING: Installing this edition of OpenDoc includes the application of corrective service to the SOM executables. There is no procedure for removing this corrective service once applied.

1. Set up environment

 

 
 
 

Previously installed products may have set environment variables that need to be unset. Please check the list below for such products:

• If you have installed IBM Visual Age C++ for OS/2, Version 3.0:

 

 
 
 

When you install IBM's VisualAge C++ for OS/2, Version 3.0, it installs other OS/2 products as well. For instance, a version of IBM SOMObjects 2.1 is installed, and a version of the OS/2 Developer's Toolkit is installed.

The installation of IBM Visual Age C++ for OS/2 probably created changes to several important environment variables in your CONFIG.SYS file:

• LIBPATH
• PATH
• SOMIR
This edition of OpenDoc installs a more current version of parts of the IBM SOMObjects 2.1 runtimes and of the OS/2 include files and lib files from the OS/2 Developer's Toolkit. It will attempt to update or correct the environment variables shown above. In general, after installing OpenDoc, you will no longer need references to %CPPMAIN%\include\OS2 in your make files or in the INCLUDE environment variables. You will no longer need references to %CPPMAIN%\lib\OS2 in your makefile or in the LIB environment variables.

The SOM include files and SOM runtimes are part of the code installed with this version of OpenDoc. They are more current than what was shipped in the 3.0 version of the IBM Visual Age C++ for OS/2 product or in its CSDs. You will need to remove references to any %CPPMAIN%\*\SOM directories from your PATH or LIBPATH environment variables.

Be careful to observe the above ordering of files.

• If you have installed SOMObjects 2.1 for OS/2:

 

 
 
 

The installation of IBM SOMObjects 2.1 for OS/2 probably created changes to several important environment variables in your CONFIG.SYS file:

• SOMBASE
• LIBPATH
• PATH
• SOMIR
This edition of OpenDoc installs more current versions of parts of the IBM SOMObjects 2.1 runtimes and OS/2 include files and lib files from the OS/2 Developer's Toolkit. It attempts to update or correct the environment variables shown above. In general, after installing OpenDoc, you no longer need references to %SOMBASE%\include\ in your make files or in the INCLUDE environment variables. In addition, you no longer need references to %SOMBASE%\lib\ in your makefile or in the LIB environment variables.

Remove any references to paths that start with the directory named by %SOMBASE% from your LIBPATH and PATH statements before you begin to install this version of OpenDoc.

• If you have installed an OS/2 Developer Toolkit:

 

 
 
 

The installation of an IBM OS/2 Developer Toolkit probably created changes to several important environment variables in your CONFIG.SYS file:

• LIBPATH
• PATH
• SOMIR
This edition of OpenDoc installs more current versions of parts of the IBM SOMObjects 2.1 runtimes and OS/2 include files and lib files from the OS/2 Developer's Toolkit. It attempts to update or correct the environment variables shown above. In general, after installing OpenDoc, you no longer need references to the include Toolkit directory in your make files or in the INCLUDE environment variables. In addition, you no longer need references to the lib Toolkit directory in your makefile or in the LIB environment variables.

Examine any references to paths that start with the directory named by the Toolkit in your LIBPATH and PATH statements, before you begin to install this version of OpenDoc. You do not need any SOM or OS/2 header or lib information from the Toolkit.

2. Disable any previous edition of OpenDoc
• If you have version 1.1 installed you may install version 1.2 on top of it. You do not need to remove version 1.1.
• If you have the 8/30/96 beta edition installed, do the following:
1. Open the folder OpenDoc for OS/2. 
2. Double-click on the Uninstall OpenDoc icon.

Follow the instructions provided by the uninstall program. 
3. Reboot the system. 
The OpenDoc for OS/2 folder and the Uninstall OpenDoc icon will remain following the uninstall procedure. They can be manually deleted.
• If you have OpenDoc for OS/2, Version 1.0 (beta or generally-available editions) installed, you must disable it prior to the installation of this edition of OpenDoc.To determine if you have a previous version of OpenDoc installed on your OS/2 system, issue the following command from an OS/2 command prompt:

 

 
 
 

   echo %SOMIR%

If you see a file named OPENDOC.IR in the results of this command, you have OpenDoc installed. Note the second parent directory of the OPENDOC.IR file. For example, if the file is listed as C:\OPENDOC\BIN\OPENDOC.IR, the second parent directory is C:\OPENDOC. This directory is the base directory for the previous version of OpenDoc.

If a previous version is installed, do the following:

1. Make a backup copy of the CONFIG.SYS file.
2. Edit the CONFIG.SYS file to remove any references to the base directory for the previous version of OpenDoc.
3. Reboot the system.
4. Change to the base directory, as determined above.
5. Go to the parent of the base directory by issuing the command:

cd ..
6. Rename the base directory, using the rename command. The IBM OpenDoc team suggests renaming the directory to OLD_OD. 
7. If you have any other OpenDoc-related directories (perhaps associated with parts that you have built or acquired) the IBM OpenDoc team suggests you rename those directories as well.
Alternately, you may uninstall the previous version by following the uninstall instructions provided with that version. We have observed some problems in the behavior of the current version of OpenDoc (such as corruption of the .ir file) due to the incomplete removal of the prior version. The procedure described above does not avoid these problems, but preserves the capability to revert to the prior version easily.
3. Install this edition of OpenDoc

 

 
 
 

Follow the steps below to install OpenDoc on your system:

1. Edit the CONFIG.SYS file to insure that references to %CPPBASE%\INCLUDE\SOM are removed from the SMINCLUDE and INCLUDE environment variables. These variables are added to the CONFIG.SYS file when the IBM VisualAge C++ compiler is installed. If you install the compiler after installing OpenDoc, you need to remove these references following the compiler installation.
2. Place (download) the installation facility (OD12OIN.EXE) and all of the desired install files into a single directory (the IBM OpenDoc team recommends the C:\OD12 directory). The directory must conform to DOS file system naming conventions (that is, 8.3 names).

 

 
 
 

Use the "File | Save As" menu item from your browser to download each file. If you are using Netscape Navigator, you can use the "Shift-click" method to download the files, that is, hold down the Shift key and click on the file to be downloaded. This causes the file to be downloaded rather than displayed through a viewer.

3. Change to that directory (cd C:\OD12).
4. Review the contents of the directory to ensure that all of the files for the Install Facility and the sets of files that you desire are present.
5. Unpack the install facility by running the OD12OIN.EXE program.
6. Install OpenDoc by running the INSTALL.EXE program in the same directory, following the instructions provided by the Install Facility.
7. Reboot the system.
8. Open the folder IBM OpenDoc folder.
9. Double-click on the Install IBM Parts icon to complete the installation.
4. Uninstall this edition of OpenDoc

 

 
 
 

To remove this edition of OpenDoc, do the following:

1. Open the folder OpenDoc for OS/2.
2. Double-click on the Uninstall OpenDoc icon.

Follow the instructions provided by the uninstall program.
3. Reboot the system.
The uninstall procedure removes all of OpenDoc's files, except for files related to parts. These files may be manually deleted.
5. Restore Previous Version of OpenDoc

 

 
 
 

If you renamed the directories related to the previous version of OpenDoc according to the instructions in the "Disable Any Previous Versions of OpenDoc" section, you may restore the previous version. To do so, do the following:

1. Change to the old base directory, that is, the one suggested to be named OLD_OD.
2. Go to the parent of the old base directory by issuing the command:

cd ..
3. Rename the old base directory to its original name, using the rename command.
4. If you renamed other directories, rename them to their original names.
5. Restore the references to the old base directory in the CONFIG.SYS file. Refer to the backup copy you created prior to installing this edition of OpenDoc to determine which references need to be restored. Do not copy the backup file over the current file, unless you are certain that no other updates to CONFIG.SYS have occurred since this edition of OpenDoc was installed.
6. Reboot the system.

WARNING: Installing this edition of OpenDoc includes the application of corrective service to the SOM executables.

NOTE: If you have version 1.1 of OpenDoc there is no need to remove it. You may install version 1.2 on top of it.

1. Install this edition of OpenDoc
• Follow the steps below to install OpenDoc on your AIX 4.1.4 system:
1. Create a directory on your system to hold the downloaded images.
2. Download all of the images to this directory.

 

 
 
 

Use the "File | Save As" menu item from your browser to download each file. If you are using Netscape Navigator, you can use the "Shift-click" method to download the files, that is, hold down the Shift key and click on the file to be downloaded. This causes the file to be downloaded rather than displayed through a viewer.

3. Become superuser for the system ("su" or login as root).
4. Before you begin installing OpenDoc onto AIX, you should check that your locale is properly defined:
• Start the SMIT program.
• Select "System Environments".
• Select "Manage Language Environment".
• Select "Change Language Environment".
• Select your locale if its not already selected.
• Exit SMIT.
Please note that OpenDoc message files are only shipped in the primary code page associated with the lowercase locale name (i.e. xx_YY not Xx_YY). locale name.
5. Change to the directory holding the downloaded images.
6. Start the smit program.
7. Select "Software Installation and Maintenance".
8. Select "Install and Update Software".
9. Select "Install/Update Selectable Software (Custom Install)".
10. Select "Install Software Products at Latest Level".
11. Select "Install New Software Products at Latest Level"
12. Enter "." for "INPUT device / directory for software" entry field.
13. If you are only going to install the OpenDoc runtime, enter "OpenDoc.rte" in the "SOFTWARE to install" entry field on the next screen. If you are going to install all of OpenDoc, enter "OpenDoc.*" in the "SOFTWARE to install" entry field. In either case, you must select YES for installing any software prereqs. ("OpenDoc.msg.en_US" is a prereq of "OpenDoc.rte") Press the Enter key.
14. Press Enter again for the "ARE YOU SURE?" dialog to continue installation.
15. The images are installed (including all prerequisite images).
16. After successful installation, the SMIT screen displays a highlighted OK in the status field at the top of the screen and a table of status results at the bottom of the smit log showing "SUCCESS" for all install components.
To complete the setup of IBM OpenDoc for a particular user, do the following:
1. Log in as the particular user.
2. Open the folder IBM OpenDoc.
3. Double-click on the Install IBM Parts icon to complete the setup.
4. Before running OpenDoc, environment variables must be set within the session. These variables are set by running:

./usr/OpenDoc/bin/odsetenv
This command may be added to the user's .profile file so that the command always runs when a session starts.
• Follow the steps below to install OpenDoc on your AIX 4.2 system:
1. Create a directory on your system to hold the downloaded images.
2. Download all of the images to this directory.

 

 
 
 

Use the "File | Save As" menu item from your browser to download each file. If you are using Netscape Navigator, you can use the "Shift-click" method to download the files, that is, hold down the Shift key and click on the file to be downloaded. This causes the file to be downloaded rather than displayed through a viewer.

3. Become superuser for the system ("su" or login as root).
4. Before you begin installing OpenDoc onto AIX, you should check that your locale is properly defined:
• Start the SMIT program.
• Select "System Environments".
• Select "Manage Language Environment".
• Select "Change Language Environment".
• Select your locale if its not already selected.
• Exit SMIT.
Please note that OpenDoc message files are only shipped in the primary code page associated with the lowercase locale name (i.e. xx_YY not Xx_YY). locale name.
5. Change to the directory holding the downloaded images.
6. Start the SMIT program.
7. Select "Software Installation and Maintenance".
8. Select "Install and Update Software".
9. Select "Install and Update from LATEST Available Software".
10. Enter "." for "INPUT device / directory for software" entry field.
11. If you are only going to install the OpenDoc runtime, enter "OpenDoc.rte" in the "SOFTWARE to install" entry field on the next screen. If you are going to install all of OpenDoc, enter "OpenDoc.*" in the "SOFTWARE to install" entry field. In either case, you must select YES for installing any software prereqs. ("OpenDoc.msg.en_US" is a prereq of "OpenDoc.rte") Press the Enter key.
12. Press Enter again for the "ARE YOU SURE?" dialog to continue installation.
13. The images are installed (including all prerequisite images).
14. After successful installation, the SMIT screen displays a highlighted OK in the status field at the top of the screen and a table of status results at the bottom of the smit log showing "SUCCESS" for all install components.
15. Exit SMIT.
To complete the setup of IBM OpenDoc for a particular user, do the following:
1. Log in as the particular user.
2. Open the folder IBM OpenDoc.
3. Double-click on the Install IBM Parts icon to complete the setup.
4. Before running OpenDoc, environment variables must be set within the session. These variables are set by running:

. /usr/OpenDoc/bin/odsetenv
This command may be added to the user's .profile file so that the command always runs when a session starts.
2. Uninstall this edition of OpenDoc

 

 
 
 

To remove this edition of OpenDoc from your AIX 4.1.4 system, do the following:

1. Become superuser for the system ("su" or login as root).
2. Start the smit program.
3. Select "Software Installation and Maintenance".
4. Select "Maintain Installed Software".
5. Select "Remove Software Products".
6. If you are going to uninstall all of OpenDoc, enter "OpenDoc.*" in the "SOFTWARE name" entry field. If you are only going to uninstall the OpenDoc runtime, enter "OpenDoc.rte" in the "SOFTWARE name" entry field.
7. Toggle the "PREVIEW only?" field from "yes" to "no". Press the Enter key.
8. Press Enter again for the "ARE YOU SURE?" dialog to continue uninstalling.
9. The OpenDoc images are uninstalled.
10. After successful uninstallation, the SMIT screen displays a highlighted OK in the status field at the top of the screen and a table of status results at the bottom of the smit log showing "SUCCESS" for all uninstalled components.
To remove this edition of OpenDoc from your AIX 4.2 system, do the following:
1. Become superuser for the system ("su" or login as root).
2. Start the smit program.
3. Select "Software Installation and Maintenance".
4. Select "Software Maintenance and Utilities".
5. Select "Remove Installed Software".
6. If you are going to uninstall all of OpenDoc, enter "OpenDoc.*" in the "SOFTWARE name" entry field. If you are only going to uninstall the OpenDoc runtime, enter "OpenDoc.rte" in the "SOFTWARE name" entry field.
7. Toggle the "PREVIEW only?" field from "yes" to "no". Press the Enter key.
8. Press Enter again for the "ARE YOU SURE?" dialog to continue uninstalling.
9. The OpenDoc images are uninstalled.
10. After successful uninstallation, the SMIT screen displays a highlighted OK in the status field at the top of the screen and a table of status results at the bottom of the smit log showing "SUCCESS" for all uninstalled components.
For either version of AIX, follow these steps to clean up each user's workspace:
1. If . /usr/OpenDoc/bin/odsetenv was added to the user's .profile file, edit the .profile file to remove this command.
2. Delete the .odrc file from the user's home directory.

 

 
 
 

This file is created when a user double-clicks on the Install IBM Parts icon. This file remembers certain environment settings which will persist into any subsequent installation of IBM OpenDoc unless the user deletes the file.

3. Delete directories pointed to by the $ODPARTS and $ODCFG environment variables.

 

 
 
 

Do not delete these directories if they contain files that you wish to keep.

4. Unlink the following symbolic links:
• $HOME/.dt/appmanager/IBM_OpenDoc_Editors
• $HOME/.dt/appmanager/IBM_OpenDoc_Stationery
• $HOME/.dt/appmanager/IBM_OpenDoc_ShellPlugins
• $HOME/.dt/appmanager/IBM_OpenDoc_Documents

You can access the books for IBM OpenDoc, Version 1.2, by pointing your HTML browser at the doc\en_US\index.htm file under the base OpenDoc directory (that is, the directory specified in the ODBASE environment variable). From this file, you will be able to link to the OpenDoc Programming Guide, OpenDoc Programming Reference, and OpenDoc Problem Determination Guide documents.

Running OpenDoc

To create a new empty document, open the IBM OpenDoc folder and double-click on the OpenDoc icon. Alternately, issue the following command:

  docshell

Note: On Windows 95, you must run the odsetenv.bat command file to set the environment properly before launching the docshell command from the command prompt.

The OpenDoc Root Part Selection dialog box displays with a list of part kinds from which you can select the part kind for the root part of the new OpenDoc document. Select one of the available part kinds and click on the OK button. The following part kinds are provided with this edition:

Part Kind Name	Description
IBM Base Container	A basic container part without any content data of its own.
Frame List	A synonym for Base Container.
Link Container	A container part with linking.
OLE Part (*)	The part editor that handles embedded OLE objects. Typically, this part editor is not run as a root part. It is embedded in some other root part to allow an OLE server object to be embedded.
Scriptable Graph Part  (*)	A scriptable container part that demonstrates creation of shapes.
Shape Part (+)	An irregularly-shaped leaf part.
Simple Part	A leaf part.
Text Part (+)	A container part that supports importing and exporting of text.
Timer  (*)	A utility part used by scripting.
(*) denotes part kinds supported only on Windows NT and Windows 95. (+) denotes part kinds supported only on Windows NT, Windows 95, and OS/2.

The following part kinds are provided but are not registered by default. You may register a part by dropping its .odz file onto the Part Editor Install icon in the IBM OpenDoc folder. The .odz files may be found in the pkg directory pointed to by the ODBASE environment variable.

Part Kind Name	Description
Clock (+)	A running analog clock.
Dynamic Part (+)	A leaf part that demonstrates dynamic updates, even when the part is not active.
Graphics Part (+)	A container part that demonstrates creation of shapes.
Java Part (*)	A part that allows Java applets or Java Beans to be embedded into OpenDoc containers. Before this part is installed and registered, a Java runtime must be installed.
Page Layout (+)	A container part demonstrating pagination and printing.
Scriptable Base Container  (*)	A container part supporting direct scripting.
Scriptable Simple Part  (*)	A simple leaf part supporting direct scripting.
Scriptable Simple 1  (*)	An alternate version of Scriptable Simple Part.
Scriptable Simple 2  (*)	An alternate version of Scriptable Simple Part.
(*) denotes part kinds supported only on Windows NT and Windows 95. (+) denotes part kinds supported only on Windows NT, Windows 95, and OS/2.

You may register additional part kinds if you provide additional part editors. Watch Club OpenDoc for more part editors.

We provide several additional part editors as samples. These part editors may be found in subdirectories underneath the src directory under the directory pointed to by the ODSRC environment variable. These additional part editors are:

Additional Part Kind Name	Description
Bitmap (*)	A leaf part that displays bitmaps.
Card Game (*)	A container part for playing poker or blackjack.
CDPlayer (*)	A leaf part that controls the playing of compact disks.
ClockPartKind (#)	A leaf part which provides a clock widget.
Mandelbrot (*)	A leaf part that displays Mandelbrot sets.
PianoPart (*)	A container part that plays .wav files.
PushButtonPartKind (#)	A leaf part which provides a push button widget.
StaffPart (*)	A container part that composes files that may be played using PianoPart part editor.
TextPartKind (#)	A leaf part which provides a text widget.
TickerPartKind (#)	A leaf part that scrolls a text banner across the part facet.
T3GamePart (*)	A container part for embedding and playing a Tic-Tac-Toe game.
(*) denotes part kinds supported only on Windows NT and Windows 95. (+) denotes part kinds supported only on Windows NT, Windows 95, and OS/2. (#) denotes part kinds supported only on AIX.

To load an existing document, issue the following command line command:

  docshell -ffile_name 

Where file_name is the name of the OpenDoc document file containing the document you want to load.

On Windows 95, OS/2, and AIX, stationery in the "Stationery" subfolder may be used to create document parts. Open the folder and drag one of the stationery icons to an open document. This action opens the part editor for the type of stationery dropped into the document. 

Building Parts

Prior to building the sample parts provided in this edition, please note the following:

• For Windows NT:

 

 
 
 

Before installing and registering a part enabled for OLE Scripting, be sure to log on with System Administrator privileges.

• For OS/2:

 

 
 
 

Run odsomxh.cmd before building any of the sample parts provided with this edition. Failure to run this command could result in the use of incompatible header files.

• For AIX:

 

 
 
 

Run odmkSampleTree to create a writeable copy of the samples source tree. This copy will be placed where the environment variable $ODSRC points.

Run /usr/lpp/som/somxh before building any of the sample parts provided with this edition.
 
 

The sample makefiles are all named "makefile" to conform to the "nmake" default makefile name. The OpenDoc sample makefile system, provides recursive subdirectory walking macro which relies on the makefile name being "makefile" in each subdirectory to be traversed. Keep this in mind if you plan to add samples to the existing list of OpenDoc.

If you install the IBM VisualAge C++ for OS/2 compiler or the OS/2 Developer's Toolkit after installing OpenDoc, these environment variables must be manually unset by adding the following lines to the end of your CONFIG.SYS file:

SET SMINCLUDE=
SET INCLUDE=

Source Code

To improve your ability to understand this edition as well as to assist in your debugging, the source code is included with this edition. The bulk of the files are provided, but files necessary to actually build the binaries are excluded. In a typical installation the source code files are in the directory %ODBASE%\SRC. A complete list of source files which exist on your system after successful installation is available in the file %ODBASE%\SRC\SRCFILES.LST.

The license agreement stipulates that you only use the source code for debugging and education. Be wary about exploiting side effects that you discover in the source code, because the IBM OpenDoc team may change the code in future editions.

Migrating From Prior OS/2 Versions of OpenDoc

If you have been using version 1.0 or earlier of OpenDoc on OS/2, you will find that parts compiled for the earlier version will not run on this version, due to changes in interfaces and linkage. You need to obtain recompiled versions of parts before they will work with this version of OpenDoc.

If you have been developing parts on version 1.0 or earlier of OpenDoc on OS/2, you will notice some differences in this release. The interfaces are equivalent, with minor changes to achieve better consistency across different platforms. To better understand the changes, consult the OpenDoc Programming Reference manual available in softcopy with this edition.

You may also notice differences in behavior of some of the part editors. The IBM OpenDoc team has rewritten the BaseContainer part editor to achieve better consistency across platforms. Parts that subclass from BaseContainer may also display these differences.