Distributed Copy Editor 1.0 Software Development Kit (GM January 2009) ReadMe File ______________________________________________________________________ This SDK provides the information you need to test-drive and customize the Distributed Copy Editor. The Distributed Copy Editor is a reference implementation of a lightweight copy-editing application that can integrate with traditional InDesign/InCopy publishing workflows using standard web-based protocols. -- Suribachi is the name of the server-side component. -- Surikogi is the name for a set of client-side applications. These include two copy-editor clients; a Flex client that runs in a web browser, and an AIR client that runs as a desktop application. There is also a Flex client for system administration. ______________________________________________________________________ This file has the following sections: 1. Legal 2. Development Environments 3. SDK Documentation Overview 4. Where to Start 5. Known Issues *********************************************************** 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. Development Environments *********************************************************** Platform: Microsoft Windows XP with service pack 2 or higher Mac OS 10.4 or higher Adobe AIR 1.5 or higher Adobe Flash Player 10 or higher JDK 1.5 or higher Apache Tomcat 6.0.14 (bundled with this SDK) BlazeDS 3.2.0.3978 (bundled with this SDK) Adobe InDesign CS4 Server IDE: Eclipse IDE for Java EE Developers 3.3.2 (Europa) or higher Adobe Flex Builder 3.0.2 Professional Eclipse Plug-in with Adobe Flex SDK 3.2.0 NOTE: For information on the requirements for running InDesign Server, see the product Readme file. Instructions for downloading these components are provided where appropriate in the Getting Started Guide. *********************************************************** 3. SDK Documentation *********************************************************** A Getting Started Guide and other documentation is provided. Open this home page in a Web browser: /docs/index.html *********************************************************** 4. Where to Start *********************************************************** Test drive the client applications and try out the features by following the instructions in the Getting Started Guide. The Distributed Copy Editor is ready to run as supplied; you do not need to compile or build any code to take the test drive. Set up a development environment to build, run and customize the Distributed Copy Editor using using the instructions provided in the Developer's Guide. Offline Workflow Features (SurikogiAIR only): ---------------------------------------------- The AIR client, SurikogiAIR, supports the editing of stories when offline. Users can fetch stories from the server to a cache on their local machine, disconnect from the network, edit the stories and then return the edited stories to the server after reconnecting to the network. Documents can be Local (in cache) or Remote (on server) and the connection mode can be Online or Offline -- When Offline, you can edit only Local documents. -- When Online, you can edit both Remote and Local documents. You can retrieve a Remote document as a Local document for editing or viewing, locking it on the server. When you return the Local document to the server, it is unlocked. Preview Features: ------------------ You can preview Local documents while online. A preview is automatically generated after you have opened and saved a document. The Preview offers Fit in Window, Actual Size, Zoom In, and Zoom Out. You can use the Preview button to manually update after a layout change (automatic notification of a layout update is not supported). Copy Fit Statistics Features: ----------------------------- Statistics are automatically generated after you have opened and saved a document. Statistics include lines overset/underset, character count, word count and depth. Text Editing and Styling Features: ----------------------------------- A. Insert text, delete text, select text, cut text, copy text, paste text B. View applied paragraph style, character style, and overrides C. Apply paragraph style, character style and overrides - bold, italic, underline and strike D. Visualisation of Note, Footnote, Table, Inline Graphic, XML Element Markup, Conditional Text, Text Variable, Tracked Insert, Tracked Delete, Hyperlink *********************************************************** 5. Known Issues *********************************************************** A. (1921444) Scroll bar not displayed in the Text Editor on opening an icml file. You can force the scroll bar appear by dragging the small triple bar control that resizes the Text Editor. B. (1919758) Hyperlinks are presented in the UI but you can't distinguish, URL, Bookmark, Text Source from each other - they all appear as HyperlinkTextSource objects C. (1919747 ) Deleted text in a tracked change at the end of a story gets lost D. (1919761) SurikogiAir only - drag and drop events not caught and can mess up the text - don't use drag and drop for now. E. (1886094) SurikogiAir.air downloads as Surikogi.zip in some web browsers. Clicking the link to download the SurikogiAIR client installer does not work - the .air file downloads as a .zip. Workaround: Right click the SurikogiAIR link in the web browser and choose Save Link As... Name the file as SurikogiAIR.air Once downloaded double click to open in the AIR.InstallerPackage F. (1912485) On Macintosh Tomcat startup fails if the SDK's folder name has a space in it. Log file external/tomcat/logs/catalina.out has error "Exception in thread "main" java.lang.NoClassDefFoundError: xxx/external/tomcat/conf/logging/properties". Workaround: Make sure the name of the folder where you install the SDK has no spaces in it. G. (1918693) On Macintosh typing accented characters using keystroke sequences such as Alt-e followed by a to enter á doesn't work. Workaround is to copy / paste the accented character into Surikogi from elsewhere. H. (1920544) Text selection is lost after applying a paragraph style. I. (1934279) SurikogiAIR only - if you try to drag-select in the Story Editor, the resulting selection often misses the first character. Workaround by using Shift-click to extend the selection. J. (2249868) Windows only - if you copy / paste text from other applications (Notepad, Word, a web browser) paragraph markers in the text appear as soft line ends in the Story Editor. K. (2251695) Applying a style to an empty paragraph appears to have no effect in the Story Editor - the style controls do not reflect the name of the style applied to the empty paragraph. Workaround is to apply styles to paragraphs which have text. L. (1934924) Double clicking on a word selects any adjacent punctuation, too. M. (2253403) You can select a word and press enter, changing the text on-screen, when a document is in Read Only mode. N. (2253873) Applying a paragraph style to an empty paragraph has no effect on text that is typed subsequently into that paragraph. Workaround is to apply styles to paragraphs which contain text. O. (2253884) Typing can be slow with heavily styled or long stories. P. (2254231) The Surikogi Document Browser will not open an ICML file whose name contains an accented character. Q. (2255006) The Surikogi Document Browser will not open an ICML file whose name contains a space character. R. (2259326) Error when applying a paragraph or character style that belongs to a Style Group. S. (2259332) Error when applying a paragraph or character style that contains accented or other non-ASCII characters. T. (2265048) Applying paragraph style "[No paragraph style]" is not allowed. U. (2265052) Error when Saving a document after applying "[No character style]". V. (2265055) "Next Paragraph Style" values are ignored when typing multiple paragraphs. W. If you get an error when saving changes to the Server, revert to the last saved version, by Closing without saving changes and then re-Opening the document. There is currently no Undo. X. Some of the ICML files in suribachiassets/qe use fonts that are not automatically installed with InDesign Server, so that you may not have them on your server. In this case, the terminal window in which you are running InDesign Server will display "Missing Font XXXXX" warning messages. In addition, Surikogi's Preview images of the file will not accurately display text that uses the missing fonts. Y. When first opening the Eclipse projects for Suribachi/ Surikogi, you may notice build warnings: Classpath entry /external/tomcat/lib/servlet-api.jar will not be exported or published. Runtime ClassNotFoundExceptions may result. suribachi P/suribachi Classpath Dependency Validator Message No grammar constraints (DTD or XML schema) detected for the document. messaging-config.xml suribachi/server-package/WEB-INF/flex line 1 XML Problem No grammar constraints (DTD or XML schema) detected for the document. proxy-config.xml suribachi/server-package/WEB-INF/flex line 1 XML Problem No grammar constraints (DTD or XML schema) detected for the document. remoting-config.xml suribachi/server-package/WEB-INF/flex line 1 XML Problem No grammar constraints (DTD or XML schema) detected for the document. services-config.xml suribachi/server-package/WEB-INF/flex line 1 XML Problem The CSS type selector 'Menu' was not processed, because the type was not used in the application. SurikogiAdminFlex.mxml SurikogiAdminFlex/src line 32 Flex Problem The CSS type selector 'MenuBar' was not processed, because the type was not used in the application. SurikogiAdminFlex.mxml SurikogiAdminFlex/src line 28 Flex Problem The CSS type selector 'TextArea' was not processed, because the type was not used in the application. SurikogiAdminFlex.mxml SurikogiAdminFlex/src line 44 Flex Problem These may safely be ignored. But if any new warnings are added to this list as a result of any code changes that you make, you should fix or at least understand what Eclipse is warning you about. _____________________________________________________________________________ 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. Apple and Mac OS are trademarks of Apple Computer, Incorporated, registered in the United States and other countries. IBM is a trademark of International Business Machines Corporation, registered in the United States and other countries. All other trademarks are the property of their respective owners. _____________________________________________________________________________