This folder contains the principal developer documentation for OpenDoc on the Macintosh platform. In addition to this ReadMe file and a Recipes folder, these are the titles:
OpenDoc Class Reference
OpenDoc Programmer's Guide
OpenDoc Cookbook
OpenDoc Human Interface Guidelines
All books are in Apple DocViewer format. All are preliminary; the information in them is in some cases incomplete and is not guaranteed to be current with the version of OpenDoc that ships with this seed. Note particularly the errata sheet that accompanies the Class Reference.
Besides the OpenDoc Human Interface Guidelines, the Human Interface folder contains drag and drop guidelines and a checklist that you can use to ensure that your part editors conform to the OpenDoc human interface guidelines.
RECIPES
The Recipes folder contains discussions and code provided by the OpenDoc development team to help you get started programming. Much of the information in the recipes has been incorporated into the Programmer's Guide or the Cookbook, although the recipes may be more up-to-date and may contain code examples not shown elsewhere.
NOTE ON SCRIPTING SUPPORT
As of the date of this release, the design of scripting support in OpenDoc has not yet been finalized. Most of the stucture is in place, but you should look at the current scripting APIs more to get a general sense of the direction we are heading than to actually start programming.
If you have worked with scripting in the A6 version of OpenDoc, you’ll notice that the ODSemanticInterface class has undergone some radical changes, dictated by the conversion to SOM and in anticipation of DSOM. Much of the API of the old XMPSemanticInterface class is now found in the SIHelper utility class.
Currently, some of the semantic events functionality is missing because of these design changes. Apple event handlers and coercion handlers work only for the document shell. Object accessors and the other OSL special callback functions are not yet working. The new API for furnishing 'aete' resources to OpenDoc and for running scripts from OpenDoc has not been implemented. Therefore, you will not be able to put scripting support into your parts in this release. We regret this inconvenience, and plan to fix semantic-events support for beta.
The current documentation is mostly correct, but you can expect some changes. The format of a token will change to improve backward compatibility with Apple Event Manager calls, and there will be other small changes as well.
