Home > Actions API

A list of available elements for Actions

Details of the available elements that can be used in Actions. Optional element attributes and properties are contained in [square brackets].

Action

There are four Action elements that correspond to the type of Action generated:

• Standalone Actions, these Actions are unique, they can’t have other Actions applied to them and they can’t have text or content added to them through anything other than the Actions interface.
• Item Actions, these Actions can be applied to any items in Freeway.
• Page Actions, these Actions can be applied to pages.
• Folder Actions, these Actions can be applied to folders, they behave the same way as page Actions and will affect each page in the folder they are applied to.

Examples:

<action name=string [title=string] [region=regioncode title=string ...] [preview-type=checkbox | radio | button | textfield | list | textarea | text] [preview-text=string] [width=number] [height=number] [generates-form]  [generates-link]  [requires-form]>...</action>

<item-action name=string [title=string] [region=regioncode title=string ...] [generates-form] [generates-link] [requires-form]  [allows-text-overflow]>...</item-action>

<page-action name=string [title=string] [region=regioncode title=string ...] [generates-form] [generates-link] [requires-form]>...</page-action>

<folder-action name=string [title=string] [region=regioncode title=string ...] [generates-form] [generates-link] [requires-form]>...</folder-action>

Attributes/Properties

name

The unique name of the Action. If the name contains spaces the name needs to be enclosed in quotes.

title

The title of the Action. If this is provided, it will be displayed within Freeway in place of the name. It can also be accompanied by a region code, to allow the setting of different titles for different localized versions of Freeway (see region below).

region

A region code to accompany a title, which allows a different title to be displayed within the Freeway interface according to the localized version of Freeway which is runninprovided at the end of this section.

preview-type

Options are checkbox, radio, button, textfield, list, textarea and text (default).

preview-text

For use with preview-type=text. This specifies the text to appear on the layout item within Freeway. This can include variables, the example below displays the title of the item on the Action.

preview-text=&_title

width/height

Width and height for the item within Freeway (always an integer).

generates-form

The Action outputs a <form> tag. Freeway’s automatic generation of the <form> tag (when there are form controls on the page) is suppressed if an Action is already handling it.

generates-link

The Action outputs the <a> (link) tag. This is used to prevent Freeway from generating a second link tag if the Action already handles it internally.

requires-form

The Action requires a <form> tag to be generated elsewhere. This would be used to ensure that Freeway automatically generates its default <form> tag when this Action is used, in the case when this Action will output a form element.width/height Width and height for the item within Freeway (always an integer).

Action Encoding

Let Freeway know what encoding type your Action is written in. This element can be placed anywhere in your Action file, even outside of the main Action element.

Example:

<action-encoding>UTF-8</action-encoding>

Action Version

Include the Action’s version number and a short description of the Action or copyright text.

Attributes/Properties

version

This is a decimal number which will be displayed in the Actions palette (for example: 1.0)

Example:

<action-version version=decimal> 
    [Short description/Copyright text]
</action-version>

Appliesto

Specifies what type of items or pages an Action can be applied to. A combination of the following can be used to increase specificity.

Attributes/Properties

html

Apply to HTML items.

gif

Apply to items with their output set to GIF.

jpeg

Apply to items with their output set to JPEG.

png

Apply to items with their output set to PNG.

svg-import

Apply to SVG imports.

image-map

Apply to image maps.

pass-through

Apply to pass throughs.

url

Apply to items with links applied.

form-items

Apply to all form items.

checkbox

Apply to checkboxes.

radio-button

Apply to radio buttons.

button

Apply to buttons.

menu-list

Apply to menu/lists.

text-field

Apply to text fields.

text-area

Apply to text areas.

plugin

Apply to plugins.

quicktime

Apply to QuickTime items.

flash

Apply to Flash items.

markup

Apply to markup items.

nofixedchildren

Don’t apply if the item has children

table

Apply to tables.

table-cell

Apply to table cells.

layer

Apply to layers.

non-layer

Apply to non-layers.

applescript

Apply if AppleScript for Actions has been turned on

webaddress

Apply if a web address has been sepcified in the Upload dialog

html32

Apply to HTML 3.2 pages.

html32css

Apply to HTML 3.2 with CSS pages.

non-html32

Don’t apply to HTML 3.2 pages.

html4

Apply to HTML 4.01 pages.

xhtmlstrict

Apply to XHTML 1.0 Strict pages.

non-xhtmlstrict

Don’t apply to XHTML 1.0 Strict pages.

The following example will create an Action that can only be applied to a layer graphic item on a page with an HTML level of 4.01 and above:

<action-appliesto nonhtml32 layer gif jpeg png pass-through />

---

Register or log in to view or add comments.