Adobe 65009333 Scripting Guide - Page 79

XML

Scripting XML Elements

79

Importing XML

Once you set the XML-import preferences the way you want them, you can import an XML file, as shown in

the following script fragment (from the ImportXML tutorial script):

myDocument.importXML(File("/c/completeDocument.xml"));

When you need to import the contents of an XML file into a specific XML element, use the importXML

method of the XML element, rather than the corresponding method of the document. See the following

script fragment (from the ImportXMLIntoElement tutorial script):

var myXMLTag = myDocument.xmlTags.add("xml_element");

var myXMLElement = myDocument.xmlElements.item(0).xmlElements.add(myXMLTag);

//Import into the new XML element.

myXMLElement.importXML(File("/c/completeDocument.xml"));

You also can set the

importToSelected

property of the

xmlImportPreferences

object to true, then

select the XML element, and then import the XML file, as shown in the following script fragment (from the

ImportXMLIntoSelectedXMLElement tutorial script):

var myXMLTag = myDocument.xmlTags.add("xml_element");

var myXMLElement = myDocument.xmlElements.item(0).xmlElements.add(myXMLTag);

myDocument.select(myXMLElement);

myDocument.xmlImportPreferences.importToSelected = true;

//Import into the selected XML element.

myDocument.importXML(File("/c/test.xml"));

Creating an XML tag

XML tags are the names of XML elements you want to create in a document. When you import XML, the

element names in the XML file are added to the list of XML tags in the document. You also can create XML

tags directly, as shown in the following script fragment (from the MakeXMLTags tutorial script):

//You can create an XML tag without specifying a color for the tag.

var myXMLTagA = myDocument.xmlTags.add("XML_tag_A");

//You can define the highlight color of the XML tag using the UIColors enumeration...

var myXMLTagB = myDocument.xmlTags.add("XML_tag_B", UIColors.gray);

//...or you can provide an RGB array to set the color of the tag.

var myXMLTagC = myDocument.xmlTags.add("XML_tag_C", [0, 92, 128]);

Loading XML tags

You can import XML tags from an XML file without importing the XML contents of the file. You might want

to do this to work out a tag-to-style or style-to-tag mapping before importing the XML data., as shown in

the following script fragment (from the LoadXMLTags tutorial script):

myDocument.loadXMLTags(File("/c/test.xml"));

Saving XML tags

Just as you can load XML tags from a file, you can save XML tags to a file, as shown in the following script.

When you do this, only the tags themselves are saved in the XML file; document data is not included. As

you would expect, this process is much faster than exporting XML, and the resulting file is much smaller.

The following sample script shows how to save XML tags (for the complete script, see SaveXMLTags):

Section	Page
Introduction	6
How to use the scripts in this document	6
About the structure of the scripts	6
For more information	6
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
Comments	10
Values	10
Variables	11
Operators	12
Conditional statements	12
Control structures	13
Functions	13
Understanding the InDesign and InCopy object model	13
Looking at the InCopy object model	15
Measurements and positioning	16
Coordinates	16
Measurement units	16
Adding features to “Hello World”	17
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
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
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
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
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
Events	70
Understanding the event scripting model	70
About event properties and event propagation	72
Working with eventListeners	73
A sample “afterNew” eventListener	75
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
Inserting text in and around XML text elements	83
Mapping tags to styles	84
Mapping styles to tags	84
Applying styles to XML elements	85

Adobe 65009333 Scripting Guide - Page 79

Importing XML, Creating an XML tag, Loading XML tags

Page 79 highlights