Assignment packages. Adobe InCopy CS6

Assignments An assignment story 91

Assignment packages

Assignment packages (.

incp files created by InCopy) are compressed folders that contain assignment files.

An assignment can be packaged using the createPackage

method. The following sample script uses this technique to create a package file: var myDocument = app.documents.item(0); var myAssignement = myDocument.assignments.item(0); if(myAssignement.packaged==false)

{ var myFile= new File("/c/b.icap");

// PackageType.FORWARD_PACKAGE Creates an assignment package for export.

// PackageType.RETURN_PACKAGE Create a package to place in the main document. myAssignement.createPackage(myFile,PackageType.FORWARD_PACKAGE);

}

An assignment story

The following diagram shows InCopy’s assignment object model. An assignment document contains one or more assignments; an assignment contains zero, one, or more assigned stories. Each assigned story references a text story or image story.

document

1

1…* assignment

1

0…* assigned story

1 text/image story

1

This section covers the process of getting assigned stories and assignment story properties.

Assigned-story object

The following script shows how to get an assigned story from an assignment object: var myDocument = app.documents.item(0); var myAssignement = myDocument.assignments.item(0); var myAssignmentStory = myAssignement.assignedStories.item(0);

Iterating through the assigned-story properties

In InCopy, assigned-story objects have properties. The following script shows how to get all properties of an assigned-story object:

Assignments var myDocument = app.documents.item(0); var myAssignement = myDocument.assignments.item(0); var myAssignmentStory = myAssignement.assignedStories.item(0); if(myAssignmentStory != null)

{ var myName = myAssignmentStory.name; var myIsvalid = myAssignmentStory.isValid; var myFilePath = myAssignmentStory.filePath; var myStoryReference = myAssignmentStory.storyReference;

}

An assignment story 92