This document accompanies the FTP release of WriteUp API 1.21. It contains FTP download instructions, installation instructions. Please read this document in its entirety before installing WriteUp API 1.21, even if you're the kind of person who doesn't believe in instructions. You'll thank us later.
WriteUp API 1.21 FTP instructions
This document describes what is available so you can decide in advance what to get from the FTP site. It is assumed you are already familiar with FTP procedures. If you have any trouble downloading or installing the application, please contact AFS by email at WriteUpAPI@afs.com, by phone at +1-215-653-0911, or by fax at +1-215-653-0711.
WriteUp API 1.21 is stored on ftp.cs.orst.edu in the /software/NeXT/demos/productivity directory.
WriteUpAPI.README - This document. Describes what to download and how to install it.
WriteUpAPIBundle.tar - contains the actual API bundle.
WriteUpAPIHeaders.tar - contains the protocol specifications for talking to the objects that the API will handle from inside of WriteUp.
WURemote.tar - contains the source code of a simple application that makes WriteUp jump through a few hoops via "remote control." It should help you start writing your own applications.
Installing WriteUp API 1.21 from FTP tar files
To provide consistency with disk-based installations, the FTP files are simply tarred versions of the Installer.app packages supplied on physical media. After downloading all of the packagesto a temporary directory like /tmp, you need to untar them with the Workspace File->Decompress option. This action will turn them into Installer.app packages. The rest of this document describes the order in which the pieces should be installed, plus preferred installation locations.
WriteUpAPIBundle.tar - Install INSIDE of the WriteUp.app application wrapper. If you follow the installer instructions, it should lead you to the right location.
WriteUpAPIHeaders.tar - Install in /LocalDeveloper/Headers so that when you use ProjectBuilder to build your application it can resolve header files.
WURemote.tar - Install in your example programs directory.
Release Notes
Current Limitations
Must use WriteUp Version 1.21 with the WriteUp API Version 1.21.
Currently, WriteUp cannot disable user access while a remote application is using the API to control WriteUp. So, for example, a user could close a document that the remote application is currently using, or move an insertion point to a location not expected by your remote application. One precaution you can take is to open documents with isVisible set to NO during API interaction with the document.
For proper memory management, you should free resources (i.e. proxies, see example code) that are no longer needed by your application.
WriteUp API v1.21 Protocol changes from previous versions
The WriteUp API protocols have been reorganized. The top level protocol “WriteUp_Protocol.h” contains references to all protocols for the WriteUp API. Instead of importing “WriteUpAPIprotocols.h” as in version 1.1 you now have to import “WriteUp_Protocol.h” .
Header/Footer changes
Headers and Footers have changed in WriteUp version 1.2. In version 1.1, you could have one set of headers/footers on every page with the option of skipping the first page or you could also specify that the header/footer alternate between odd an even pages. In version 1.2 you are allowed to have multiple headers/footers , with the header/footer on every page or even/odd page . (For more information see the release notes and Help documentation for WriteUp version 1.21.) If you have used the WriteUp API version 1.1 you will need to make changes to your existing applications to conform to these changes.
