Adobe 65009333 - InCopy CS4 - PC Bedienungsanleitung

ADOBE®INCOPY®CS4

ADOBE INCOPY CS4

SCRIPTING GUIDE:

JAVASCRIPT

Adobe® InCopy® CS4 Scripting Guide: JavaScript

If this guide is distributed with software that includes an end user agreement, this guide, as well as the software

described in it, is furnished under license and may be used or copied only in accordance with the terms of such license.

Except as permitted by any such license, no part of this guide may be reproduced, stored in a retrieval system, or

transmitted, in any form or by any means, electronic, mechanical, recording, or otherwise, without the prior written

permission of Adobe Systems Incorporated. Please note that the content in this guide is protected under copyright law

even if it is not distributed with software that includes an end user license agreement.

The content of this guide is furnished for informational use only, is subject to change without notice, and should not be

construed as a commitment by Adobe Systems Incorporated. Adobe Systems Incorporated assumes no responsibility or

liability for any errors or inaccuracies that may appear in the informational content contained in this guide.

Please remember that existing artwork or images that you may want to include in your project may be protected under

the copyright owner. Please be sure to obtain any permission required from the copyright owner.

Any references to company names in sample templates are for demonstration purposes only and are not intended to

refer to any actual organization.

Adobe, the Adobe logo, Creative Suite, InCopy, InDesign, Illustrator, and Photoshop 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. All other

trademarks are the property of their respective owners.

Adobe Systems Incorporated, 345 Park Avenue, San Jose, California 95110, USA. Notice to U.S. Government End Users.

The Software and Documentation are “Commercial Items,” as that term is defined at 48 C.F.R. §2.101, consisting of

“Commercial Computer Software” and “Commercial Computer Software Documentation,” as such terms are used in 48

C.F.R. §12.212 or 48 C.F.R. §227.7202, as applicable. Consistent with 48 C.F.R. §12.212 or 48 C.F.R. §§227.7202-1 through

227.7202-4, as applicable, the Commercial Computer Software and Commercial Computer Software Documentation are

being licensed to U.S. Government end users (a) only as Commercial Items and (b) with only those rights as are granted

to all other end users pursuant to the terms and conditions herein. Unpublished-rights reserved under the copyright

laws of the United States. Adobe Systems Incorporated, 345 Park Avenue, San Jose, CA 95110-2704, USA. For U.S.

Government End Users, Adobe agrees to comply with all applicable equal opportunity laws including, if appropriate, the

provisions of Executive Order 11246, as amended, Section 402 of the Vietnam Era Veterans Readjustment Assistance Act

of 1974 (38 USC 4212), and Section 503 of the Rehabilitation Act of 1973, as amended, and the regulations at 41 CFR

Parts 60-1 through 60-60, 60-250, and 60-741. The affirmative action clause and regulations contained in the preceding

sentence shall be incorporated by reference.

Contents

1 Introduction . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6

How to use the scripts in this document . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6

About the structure of the scripts . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6

For more information . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6

2 Getting Started . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7

Installing scripts . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7

Running scripts . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8

Using the scripts panel . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8

JavaScript language details . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8

Using the scripts in this document . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9

Your first InCopy script . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9

Walking through the script . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10

Scripting terminology and the InCopy object model . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10

Scripting terminology . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10

Understanding the InDesign and InCopy object model . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 13

Measurements and positioning . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 16

Adding features to “Hello World” . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 17

3 Scripting Features . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 19

Script preferences . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 19

Getting the current script . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 20

Script versioning . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 21

Targeting . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 21

Compilation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 21

Interpretation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 21

Using the doScript method . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 21

Sending parameters to doScript . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 22

Returning values from doScript . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 22

Running scripts at start-up . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 23

Session and main script execution . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 23

4 Text and Type . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 25

Entering and importing text . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 25

Stories and text frames . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 25

Adding text to a story . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 25

Replacing text . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 26

Inserting special characters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 26

Contents 4

Placing text and setting text-import preferences . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 27

Exporting text and setting text-export preferences . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 30

Text objects . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 34

Selections . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 35

Moving and copying text . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 36

Text objects and iteration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 37

Formatting text . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 38

Setting text defaults . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 38

Fonts . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 41

Applying a font . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 42

Changing text properties . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 42

Changing text color . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 43

Creating and applying styles . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 43

Deleting a style . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 45

Importing paragraph and character styles . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 45

Finding and changing text . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 45

Find/change preferences . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 46

Finding text . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 46

Finding and changing formatting . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 47

Using grep . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 48

Using glyph search . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 50

Tables . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 50

Autocorrect . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 54

Footnotes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 54

5 User Interfaces . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 55

Dialog-box overview . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 55

Your first InCopy dialog box . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 56

Adding a user interface to “Hello World” . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 57

Creating a more complex user interface . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 57

Working with ScriptUI . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 59

Creating a progress bar with ScriptUI . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 60

Creating a button-bar panel with ScriptUI . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 60

6 Menus . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 63

Understanding the menu model . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 63

Localization and menu names . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 65

Running a menu action from a script . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 66

Adding menus and menu items . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 66

Menus and events . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 67

Working with script menu actions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 68

Contents 5

7 Events . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 70

Understanding the event scripting model . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 70

About event properties and event propagation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 72

Working with eventListeners . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 73

A sample “afterNew” eventListener . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 75

8 XML . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 77

Overview . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 77

The best approach to scripting XML in InCopy . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 77

Scripting XML Elements . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 77

Setting XML preferences . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 78

Setting XML import preferences . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 78

Importing XML . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 79

Creating an XML tag . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 79

Loading XML tags . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 79

Saving XML tags . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 79

Creating an XML element . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 80

Moving an XML element . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 80

Deleting an XML element . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 80

Duplicating an XML element . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 80

Removing items from the XML structure . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 81

Creating an XML comment . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 81

Creating an XML processing instruction . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 81

Working with XML attributes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 81

Working with XML stories . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 82

Exporting XML . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 83

Adding XML elements to a story . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 83

Associating XML elements with text . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 83

Applying styles to XML elements . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 85

Working with XML tables . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 86

1Introduction

This document shows how to do the following:

➤Work with the Adobe® InCopy® scripting environment.

➤Use advanced scripting features.

➤Work with text and type in an InCopy document, including finding and changing text.

➤Create dialog boxes and other user-interface items.

➤Customize and add menus and create menu actions.

➤Respond to user-interface events.

➤Work with XML, from creating XML elements and importing XML to adding XML elements to a layout.

How to use the scripts in this document

For the most part, the scripts shown in this document are not complete scripts. They are only fragments of

scripts, and are intended to show only the specific part of a script relevant to the point being discussed in

the text. You can copy the script lines shown in this document and paste them into your script editor, but

you should not expect them to run without further editing. Note, in addition, that scripts copied out of this

document may contain line breaks and other characters (due to the document layout) that will prevent

them from executing properly.

A zip archive of all of the scripts shown in this document is available at the InCopy scripting home page, at:

http://www.adobe.com/products/InCopy/scripting/index.html. After you have downloaded and

expanded the archive, move the folders corresponding to the scripting language(s) of your choice into the

Scripts Panel folder inside the Scripts folder in your InCopy folder. At that point, you can run the scripts

from the Scripts panel inside InCopy.

About the structure of the scripts

The script examples are all written using a common template that includes the functions “main,”

“mySetup,” “mySnippet,” and “myTeardown.” We did this to simplify automated testing and publication—

there’s no reason for you to construct your scripts this way. Most of the time, the part of the script you’ll be

interested in will be inside the “mySnippet” function.

For more information

For more information on InCopy scripting, you also can visit the InCopy Scripting User to User forum, at

http://www.adobeforums.com. In the forum, scripters can ask questions, post answers, and share their

newest scripts. The forum contains hundreds of sample scripts.

2Getting Started

Scripting is the most powerful feature in Adobe® InCopy® CS4. No other feature—no tool, panel, or dialog

box you see in the program’s user interface—can save you as much time, trouble, and money as scripting.

This document is for every InCopy user. It does not matter if you never created a script before; this manual

shows you how to get started. If you wrote scripts before for other applications, this manual shows you

how to apply your knowledge to InCopy scripting. It covers installing and running an InCopy script, and it

describes what InCopy scripting can and cannot do. It also discusses the software you need to get started

writing your own scripts.

Almost anything you can do with the InCopy user interface; you can do with a script. You can enter and

format text, find and change text, add notes, and print or export the pages of the document. Any action

that can change a document or its contents can be scripted. There are even a few things you can do in

scripting that you cannot do using the user interface.

Scripts can create menus, add menu items, create and display dialogs and panels, and respond to your

user-interface selections. Scripts can read and write text files, parse XML data, and communicate with

other applications. Scripts can do everything from very small tasks (like setting a tab stop at the location of

the text cursor) to providing complete features. You can start with very simple scripts that do only one

thing and move on to scripts that automate your entire publishing workflow.

Most of the things scripting cannot do—like setting up a workspace or defining a set of keyboard

shortcuts—are related to the user interface. In addition, scripts cannot add new kinds of objects to an

InCopy document or add new, fundamental capabilities to the program, like a new text-composition

engine. For that type of extensibility, you must to turn to the InCopy Software Development Kit (SDK),

which shows you how to write compiled plug-ins using C++.

This document talks about Adobe InDesign® as well as InCopy, because InCopy almost always is used in

conjunction with InDesign documents. In addition, InDesign and InCopy scripting are very similar. For

more on InDesign scripting, see Adobe InDesign CS4 Scripting Tutorial and Adobe InDesign CS4 Scripting

Guide.

Installing scripts

To install an InCopy script, just put the script file in the Scripts Panel folder in the Scripts folder in your

InCopy application folder.

Alternately, put the script in the Scripts Panel folder in your user-preferences folder. You can find your user

preferences folder at the following locations:

Mac OS®: Users/user_name/Library/Preferences/Adobe InCopy/Version 6.0/Scripts

Windows® XP: ~\Documents and Settings\user_name\Application Data\Adobe\InCopy\

Version 6.0\Scripts

where user_name is your user name and ~ (tilde) is your system volume.

Once the script is in the folder, it appears in the Scripts panel inside InCopy (choose Window > Scripts to

display the panel).

Getting Started Running scripts 8

You also can put in the Scripts Panel folder aliases/shortcuts to scripts or folders containing scripts, and

they will appear in the Scripts panel.

Running scripts

To run a script, display the Scripts panel (choose Window > Scripts), then double-click the script name in

the Scripts panel. Many scripts display user-interface items (like dialogs or panels) and display alerts if

necessary.

Using the scripts panel

The Scripts panel can run compiled or uncompiled AppleScripts (files with the file extension .spt, .as, or

.applescript), JavaScripts (files with the file extension .js or .jsx), VBScripts (files with the extension

.vbs), or executable programs from the Scripts panel.

To edit a script shown in the Scripts panel, hold down Option (Mac OS) or Alt (Windows) key and

double-click the script’s name. This opens the script in the editor you defined for the script file type.

To open the folder containing a script shown in the Scripts panel, hold down the Command (Mac OS) or

Ctrl-Shift (Windows) keys and double-click the script’s name. Alternately, choose Reveal in Finder (Mac OS)

or Reveal in Explorer (Windows) from the Scripts panel menu. The folder containing the script opens in the

Finder (Mac OS) or Explorer (Windows).

Scripts run as a series of actions, which means you can undo the changes the script made to a document

by choosing Undo from the Edit menu. This can help you troubleshoot a script, as you can step backward

through each change.

To add a keyboard shortcut for a script, choose Edit > Keyboard Shortcuts, select an editable shortcut set

from the Set menu, then choose Product Area > Scripts. A list of the scripts in your Scripts panel appears.

Select a script and assign a keyboard shortcut as you would for any other InCopy feature.

JavaScript language details

InCopy’s JavaScript support is based on an Adobe implementation of JavaScript known as ExtendScript.

The ExtendScript interpreter conforms to the current ECMA 262 standard for JavaScript. All language

features of JavaScript 1.5 are supported. Adobe Illustrator®, Adobe Photoshop®, and other Adobe Creative

Suite® products also use the ExtendScript JavaScript interpreter.

While you can write scripts using other versions of JavaScript, such as Late Night Software’s OSA JavaScript

(on Mac OS) or Microsoft® JScript (on Windows), the terms you use in those languages are not the same as

the terms you use in ExtendScript. ExtendScript examples will not work in other JavaScript versions.

NOTE: Because ExtendScript tools and features are used in several Adobe products, we consolidated all

ExtendScript documentation. To learn more about JavaScript utilities like the ExtendScript Toolkit (a

JavaScript development environment and object-model inspector) and the ScriptUI user-interface

module, see Creative Suite 3 JavaScript Tools Guide.

Getting Started Using the scripts in this document 9

Using the scripts in this document

To use any script from this document, either open the tutorial script file (the filename is given before each

script). The files are stored in a zip archive, InCopyCS4ScriptingGuideScripts.zip. When you

uncompress the archive, you can move the folder containing the scripts written in the scripting language

you want to use (AppleScript, JavaScript, or VBScript) to your Scripts Panel folder. Working with the script

files is much easier than entering the script yourself or copying and pasting from this document.

If you do not have access to the script archive, you can enter the scripting code shown in this chapter. To

do this:

1. Copy the script from this Adobe PDF document and paste it into the ExtendScript Toolkit.

2. Save the script as a plain-text file in the Scripts Panel folder (see “Installing scripts” on page 7), using

the file extension .jsx.

3. Choose Windows > Scripts to display the Scripts panel.

4. Double-click the script name in the Scripts panel to run the script.

Entering scripts manually will only work for the scripts shown in this chapter. The scripts shown in the

other chapters are script fragments, not complete scripts. To run these scripts, you must use the scripts

from the script archive.

NOTE: If you are entering the examples yourself (rather than using the scripts from the script archive), it is

very important you use the same capitalization as shown in the example. JavaScript is case-sensitive, and

the scripts will fail if they do not use the capitalization shown.

NOTE: If you are copying and pasting scripts from this document, be aware that line breaks caused by the

layout of the document can cause errors in your script. As it can be very difficult to find such errors, we

recommend hat you use the scripts in the zip archive.

Your first InCopy script

Next, we create an InCopy script that creates a new document, adds a text frame, then enters text in the

text frame. While this seems trivial, it demonstrates how to do the following:

➤Establish communication with InCopy.

➤Create a new document.

➤Add text to a story.

Start the ExtendScript Toolkit (or a text editor) and enter the following script (or open the HelloWorld

tutorial script):

var myDocument = app.documents.add();

var myStory = myDocument.stories.item(0);

myStory.contents = "Hello World!";

Save the script as a plain-text file with the file extension .jsx in the Scripts Panel folder (see “Installing

scripts” on page 7). To run the script, double-click the script name in the Scripts panel (or select InCopy

CS4 from the application target pop-up menu in the ExtendScript Toolkit, then click Run).

Getting Started Scripting terminology and the InCopy object model 10

Walking through the script

This section presents a step-by-step analysis of what the script above does.

1. Establish communication with the InCopy application object:

Refer to the application as app.

2. Create a new document and a reference to the document:

Var myDocument = app.documents.add();

3. Get a reference to the first story in the document (a standalone document always contains a story):

var myStory = myDocument.stories.item(0);

4. Add text to the story by setting the contents property to a string.

myStory.contents = "Hello World!";

Scripting terminology and the InCopy object model

Now that you created your first InCopy script, it is time to learn more about the terminology of scripting

languages in general and InCopy scripting in particular.

Scripting terminology

First, let’s review a few common scripting terms and concepts.

Comments

Comments give you a way to add descriptive text to a script. The scripting system ignores comments as

the script executes; this prevents comments from producing errors when you run your script. Comments

are useful when you want to document the operation of a script (for yourself or someone else). In this

document, we use comments in the tutorial scripts.

To include a comment in JavaScript, type // to the left of the comment, or surround the comment with /*

and */. For example:

// this is a comment

/* and so is this */

Values

The point size of a text character, the contents of a note, and the filename of a document are examples of

values used in InCopy scripting. Values are the data your scripts use to do their work.

The type of a value defines what sort of data the value contains. For example, the value type of the

contents of a word is a text string; the value type of the leading of a paragraph is a number. Usually, the

values used in scripts are numbers or text. The following table explains the value types most commonly

used in InCopy scripting:

Andere Handbücher für 65009333 - InCopy CS4 - PC

Dieses Handbuch passt für folgende Modelle

Inhaltsverzeichnis

Andere Adobe Software Handbücher

Adobe

Adobe ACROBAT COM Bedienungsanleitung

Adobe

Adobe PREMIERE PRO 4.0 Referenzhandbuch

Adobe

Adobe ILLUSTRATOR 6.0 Bedienungsanleitung

Adobe

Adobe 65009626 - Soundbooth CS4 - PC Leitfaden

Adobe

Adobe 16001500 - Illustrator CS2 - Mac Bedienungsanleitung

Adobe

Adobe PHOTOSHOP CS2 Bedienungsanleitung

Adobe

Adobe 62000112DM - Acrobat 3D - PC Bedienungsanleitung

Adobe

Adobe 65024872 - InDesign CS4 - Mac Bedienungsanleitung

Adobe

Adobe ACROBAT READER 4.0 Betriebsanleitung

Adobe

Adobe ACROBAT SDK V8.0 Bedienungsanleitung

Adobe

Adobe ACROBAT 7.0.5 SDK Bedienungsanleitung

Adobe

Adobe 38039336 - Flash CS3 Professional Referenzhandbuch

Adobe

Adobe LIVE CYCLE 7.2 - INSTALLING AND CONFIGURING LIVECYCLE FOR... Bedienungsanleitung

Adobe

Adobe 22020738 Kurzanleitung

Adobe

Adobe 12020596 Betriebsanleitung

Adobe

Adobe 16001500 - Illustrator CS2 - Mac Bedienungsanleitung

Adobe

Adobe 65064073 Bedienungsanleitung

Adobe

Adobe 38039481 - Flash CS3 Professional Bedienungsanleitung

Adobe

Adobe PHOTOSHOP CS 2.0 - SCRIPTING GUIDE Bedienungsanleitung

Adobe

Adobe 62000236 Leitfaden

Adobe

Adobe 29500007 - Creative Suite 3 Design Premium Bedienungsanleitung

Adobe

Adobe 29180155 - Photoshop Elements 4.0 Betriebsanleitung

Adobe

Adobe PREMIERE 6.0 FOR WINDOWS - IEEE 1394 COMPATIBILITY... Bedienungsanleitung

Adobe

Adobe 65015459 - Contribute CS4 Bedienungsanleitung

Beliebte Software Handbücher anderer Marken

COMPRO

COMPRO COMPROFM Bedienungsanleitung

Muratec

Muratec OFFICEBRIDGE ONLINE Bedienungsanleitung

Oracle

Oracle Contact Center Anywhere 8.1 Bedienungsanleitung

Avaya

Avaya NULL One-X for RIM Blackberry Bedienungsanleitung

HP ProLiant BL420c Bedienungsanleitung

PS Audio

PS Audio PowerPlay Betriebsanleitung

Brady

Brady LOCKOUT PRO 3.0 Service-Handbuch

Avaya

Avaya Interaction Center Bedienungsanleitung

Texas Instruments

Texas Instruments TI-83 Plus Silver Edition Handbuch

Novell

Novell GROUPWISE 8 - INTERNET AGENT Bedienungsanleitung

Oracle

Oracle Application 9i Bedienungsanleitung

Acer

Acer RDM Bedienungsanleitung

Canon

Canon Vixia HF21 Bedienungsanleitung

Canon

Canon ZR950 Bedienungsanleitung

Samsung

Samsung Auto Backup Bedienungsanleitung

Polycom

Polycom Vortex EF2201 Montage- und Bedienungsanleitung

Brocade Communications Systems

Brocade Communications Systems Brocade 8/12c Bedienungsanleitung

Novell

Novell SP2 - S Bedienungsanleitung