Scripting

You can use scripting in your document by attaching scripts to the objects. Scripts must be written in the StreamServe scripting language. For information on the StreamServe scripting language and the available script functions, see the StreamServe Scripting reference.

Scripts are executed when the StoryTeller Process is run through the StreamServer. When you add a script to an object in the document, you must specify if the script is executed before the object is processed or afterwards.

Adding a script

•	Before an object – useful if you for example want to hide the object depending on certain conditions.

•	After an object – useful for example if you want to retrieve the size of an object that has been rendered.

StoryTeller specific functions

There are a number of StoryTeller scripting functions that are used for the following tasks:

•	Setting and retrieving values for properties used in a StoryTeller document.

•	Retrieving coordinates for paragraphs relative to text area and page.

•	Evaluating XPath expressions.

For more information about the StoryTeller script functions, see StoryTeller functions in the StreamServe Scripting reference.

 

You can generally not use the following groups of functions in StoryTeller, they are specific to PageOUT: • Position formatting functions • Page handling functions See the StreamServe Scripting reference for the functions included in these groups. (The page handling functions are found under General functions). However, the page() and pages() functions can be used in StoryTeller. Note: The pages() function must be used within the context of a Content Dependent Fragment to return the total number of pages in the document. You can not add scripts to the following objects: • Page link • Page group • Story • Table cell In addition, you can not add scripts after, or use the Skip() function, on a Repeater, table cell, or on a Story reference. Note: You can add Retrieved script on a substitution, i.e. a script can be run on a substitution after its value has been retrieved. For information on how to add scripts to the StoryTeller document, see Adding scripts to an object.