Adobe InDesign CS4 Server Software Development Kit (Build 578, September 2009) ReadMe File ______________________________________________________________________ This SDK provides the information you need to develop Java and/or scripting components that communicate with Adobe InDesign CS4 Server. ______________________________________________________________________ This file has the following sections: 1. Legal 2. Changes 3. Getting Started 4. Development Environment 5. Porting from CS3 to CS4 6. Known Issues 6. SDK Support and Adobe Partner Programs *********************************************************** 1. Legal *********************************************************** You may use this SDK only in a manner consistent with the included End User License Agreement: \legalnotices\EULAs.pdf Other notices, terms and conditions pertaining to third-party software are located at: http://www.adobe.com/go/thirdparty *********************************************************** 2. Changes *********************************************************** Version 6.0.4 ============= There were no changes for the 6.0.4 release. Version 6.0.3 ============= Adds a new AIR-based sample, DropBox. DropBox is a type of sample client for InDesign Server. It allows you to configure a user interface with several images that are associated with scripts. Users can drag and drop input files (IDML, INDD, etc.) onto the image, triggering the script to be run on the file provided. Version 6.0.2 ============= There were no changes for the 6.0.2 release. Version 6.0.1 ============= There were no changes for the 6.0.1 release. *********************************************************** 3. Getting Started *********************************************************** For an overview and instructions on how to proceed with this SDK, see "Getting Started with the Adobe InDesign CS4 Server SDK": /getting-started.pdf *********************************************************** 4. Development Environment *********************************************************** * InDesign CS4 Server * JDK (Java SE Development Kit) 1.4.2 or newer - Available for download at http://java.sun.com (Windows) or http://developer.apple.com/java/download (Mac OS). * Eclipse 3.2 or newer (optional) - Available for download at http://www.eclipse.org/ Windows: - Microsoft Windows XP with service pack 2 - Ant 1.7 or newer - Available for download at http://ant.apache.org/. Mac OS - Mac OS 10.4 - Ant 1.6.5 or newer - OSX 10.4 with the latest updates installs this by default * Additional requirements for regenerating the InDesign Server Java/CORBA API: - InDesign CS4 Products SDK - omniORB 4.1.2 - See installation instructions in "Regenerating the Adobe InDesign CS4 Server Java API." - Windows: - Microsoft Visual Studio 2005 - Perl (optional) - For chm generation. Available for download at http://www.activestate.com. - Microsoft HTML Help 1.4 SDK (optional) - For chm generation. Available for download at http://www.microsoft.com. - Mac OS: XCode 2.4.1 for Mac OS 10.4.x - OR - XCode 3.1 for Mac OS 10.5.x - Available for download at http://developer.apple.com/tools/xcode/. *********************************************************** 5. Porting from CS3 to CS4 *********************************************************** doScript ======== The doScript method has added two parameters for undoMode and undoName. undoMode is an enum; undoName, a string. Example: VariableType returnValue = myApp.doScript( VariableTypeUtils.createFile(scriptFilePath), OptArg.makeScriptLanguageEnum(kScriptLanguageJavascript.value), OptArg.noVariableTypeSeq(), OptArg.noUndoModesEnum(), OptArg.noString()); possible values for undo mode include: OptArg.noUndoModesEnum(), OptArg.makeUndoModesEnum(kUndoModesAutoUndo.value) OptArg.makeUndoModesEnum(kUndoModesEntireScript.value) OptArg.makeUndoModesEnum(kUndoModesFastEntireScript.value) OptArg.makeUndoModesEnum(kUndoModesScriptRequest.value) setName method of CharacterStyle ================================ In CS3, the setName method accepted a variableType argument. In CS4, it accepts a string. CS3: myCharacterStyle.setName(VariableTypeUtils.createString("Emphasis")); CS4: myCharacterStyle.setName("Emphasis"); AutoLayout ========== AutoLayout functionality was been removed in CS4. As a result, the following are not available in InDesign CS4 Server: Plugins: kAutoLayoutPluginID kKnowledgeBasePluginID Bosses: kKnowledgeBaseBoss kAutoLayoutBoss kAutoLayoutCompoundCmdBoss kSetAutoLayoutPrefsCmdBoss kALSpreadBoss kALHorGuideBoss kALVerGuideBoss kALPageBoss kALColumnBoss kALPageItemBoss kAutoLayoutNewDocResponderBoss kAutoLayoutOpenDocResponderBoss kAutoLayoutConversionProviderBoss kLayoutAdjustPrefsScriptProviderBoss AddIn Implementations: IID_IAUTOLAYOUTPREFERENCES, kSessionAutoLayoutPrefsImpl (on kWorkspaceBoss) IID_IAUTOLAYOUTPREFERENCES, kDocAutoLayoutPrefsImpl (on kDocWorkspaceBoss) IID_IALSAVEDOBSERVER, kPMUnknownDataImpl (on kDocWorkspaceBoss) For scripting purposes, the following will be be marked obsolete in a server-only plug-in: Objects: kLayoutAdjustPrefsObjectScriptElement Properties: kLayoutAdjustPrefsPropertyScriptElement kEnableLayoutAdjustPropertyScriptElement kLASnapZonePropertyScriptElement kLAAllowGraphicsResizePropertyScriptElement kLAAllowRulerGuidesMovePropertyScriptElement kLAIgnoreRulerGuideAlignmentsPropertyScriptElement kLAIgnoreObjectLayerlocksPropertyScriptElement Providers: kLayoutAdjustPrefsScriptProviderBoss was redirected to kObsoleteFeatureScriptProviderBoss The only change to the InDesign and InCopy model is marking the AutoLayoutPrefs on the document workspace as ignorable, so data can get carried along and documents with that data can open without complaint in InDesign Server. Text Import and Export ====================== kTextImportCharacterSetUnicode was removed. Replace it with either of these constants: kTextImportCharacterSetUTF8 kTextImportCharacterSetUTF16 Example: TextImportPreference myPrefs = myApp.getTextImportPreferences(); myPrefs.setCharacterSet(kTextImportCharacterSetUTF8.value); kTextExportCharacterSetUnicode was removed. Replace it with either of these constants: kTextExportCharacterSetUTF8 kTextExportCharacterSetUTF16 Example: TextExportPreference myPref = myApp.getTextExportPreferences(); myPref.setCharacterSet(kTextExportCharacterSetUTF8.value); configuration Folder ==================== In CS3, the configuration folder name on Windows was created by morphing the configuration parameter such that each capital letter was converted to two lower-case letters. For instance, "Hello" became "hhello". This was removed in CS4, and now configuration folder names are untouched. *********************************************************** 6. Known Issues *********************************************************** * regenerating-java-api.pdf Document If you are following the procedure entitled "Using CORBA and Java to Exercise the Plug-in" on page 14, you will need to modify the TransparencyEffect Java component. (This file is supplied with the InDesign CS4 Products SDK, not the InDesign CS4 Server SDK.) Modify the TransparencyEffect.java file by replacing this line: Application myApp = ApplicationUtils.getApplication(args[0]); with these two lines: ApplicationUtils utils = new ApplicationUtils(args[0]); Application myApp = utils.getApplication(); *********************************************************** 7. SDK Support and Adobe Partner Programs *********************************************************** If you require SDK support for the Version Cue CS4 SDK, you may purchase single or multi-pack SDK support cases. Information on purchasing SDK support cases can be found at: http://partners.adobe.com/public/developer/support/index.html Information on Adobe support, in general, may be found at: http://www.adobe.com/support/programs/ If you are a partner who extends, markets, or sells Adobe products or solutions, you should consider membership in the Adobe Partner Connection Solution Partner Program. The Solution Partner Program provides development support, access to timely product information, as well as various marketing benefits. To learn more about the program, point your browser to: http://wwww.adobe.com/partners or contact one of the following locations. In the U.S., Canada, and Mexico: Adobe Solution Partner Program Adobe Systems Incorporated PO Box 2205 Beaverton, OR 97005 Tel: 1-800-685-3510 (toll free in the US and Canada only) or 206-675-6145 Fax: 206-675-6872 E-mail: solutionpartner@adobe.com In Europe, Middle East, and Africa: Adobe Solution Partner Program Adobe Systems Incorporated Postbus 20623 1001 NP Amsterdam The Netherlands Tel: +31 20 582 0850 Fax: +31 20 582 0851 E-mail: eurosolutionpartner@adobe.com In Japan: Adobe Solution Partner Program Adobe Systems Co., Ltd. Shinjuku Oak Tower 16F 6-8-1 Nishishinjuku, Shinjuku-ku, Tokyo 163-6016 Japan Tel: 03-5740-2620 Fax: 03-5740-2621 E-mail: japanpartner@adobe.com _____________________________________________________________________________ Copyright 2009 Adobe Systems Incorporated. All rights reserved. Adobe and InDesign are registered trademarks or trademarks of Adobe Systems, Incorporated in the United States and/or other countries. Microsoft and Windows are registered trademarks or trademarks of Microsoft Corporation in the United States and/or other countries. Mac OS is a trademark of Apple Computer, Incorporated, registered in the United States and other countries. All other trademarks are the property of their respective owners. Adobe legal audits: 0000760 _____________________________________________________________________________