Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

Variable Settings panel:

...

General Settings

The name of a variable is the underlying code, used for tagging purposes throughout the document. An alternative display name can be entered, which is the label shown to the end user in the variable Input Form. It is not recommend to use special characters (example single quote ') in variable names since it can cause error on some webservice functions.You can use special characters in display names instead.

...

  • The visible checkbox can be used (either manually or by using a display action). Variables which don't have this setting checked, won't be shown in any input form

  • The display filter can be used in combination with a filter in the Input Form Panel's properties. In that case, only variables with a matching filter will be shown inside the relevant panel. Multiple Panels can be configured, to show different sets of variables

Info

New in 6.5 / 2021.1

  • Locked
    Locking the variable, will show a read-only version in the input panel, for end users of the Editor.
    The variable is still accessible / editable through the API or when using a DataSource.

...

For more information on display filters, see Conditional Interface Elements

...

  • short text, long text and formatted text present the user with options for entering textual information

  • A calculated field has no input option at all, but has an additional document action ("Value"), which can return its value. See lower

  • an Image variable is presented to the user as a choice of images from a variety of repositories

  • A number variable is presented in the Input Form as a numeric stepper

  • A checkbox is visualized as a true/false checkbox

  • A date variable allows the user to choose a date

  • A list variable can be presented as a pulldown or as a list of checkboxes (with multiple items being selectable)

  • a table variable is presented as an input grid, and will be placed in the text frames as tab delimited text

  • color, paragraph style, character style and font variables allow for selection (and in some cases modification) of resource items. Note that these input types are mostly used by actions, and do not offer a lot of control over use throughout the document (see ?Common Document Actions for examples which might be more suited to your needs in those cases)

  • coordinate variables are presented to the user as an input of a measurement unit, taking into account the current document's viewpreferences (mm, pt, in, ...), and also allowing the basic calculations. These again are most often used by document actions

  • divider variables allow you to insert a divider into the Input Form

  • button bar variables allow you to configure buttons (or icons) with attached document actions

  • Structured Text (new in 6.3 & 2020.3) a variable that allows structured text in the content, mapped to styles

Depending on the type of the variable, more "Type Specific" settings might be possible.

Short and Long Text

...

Short and long text allow you to limit the amount of characters (0 being an unlimited amount), and optionally show the status of that count inside the Input Form.

...

Next to the height of the input form and the text direction (similar to long text), you can also specify which formatting options are available in the input form.

Image

Image Removed   Image Removed 

...

The basic selection option for an Image Variable is through a popup. These popups can be configured similarly to the normal CHILI Panels for the source, by clicking the "Popup Properties" button.

...

  • Entry of the directory (or reference to a variable which will hold the directory path, and which can therefore also be manipulated easily through Document Actions)

  • Possibility to allow the user to upload new images to the specified directory

  • Possibility to have the user ONLY upload new images. No other selection method is available in that case

Number

...

When working with a numeric input, various options are available to limit entry and configure the display value of the number in the document.

...

The underlying value of a checkbox is "true" (for checked), or anything else (by default almost always "false", unless the data type was modified) for unchecked. But if the checkbox also is referenced inside a Text Frame (rather than using document actions), you can also configure its checked and unchecked display values.

Date

...

Image Removed   Image Removed   Image Removed

...

  

...

The date variable type can be configured with a display format (which is the way the date is inserted in a variable Text Frame), and allows you various ways to limit the selection:

...

Examples of display formatting for february 7, 2030

...

2030

  • M/D/YY will display the selected date as: 2/7/30

  • MM.DD.YYYY will display the selected date as:  02.07.2030

Note

When only 2 digits are provided for the year, 1900 will be assumed

This only applies when reading from a datasource, where only 2 digits are available.

Using the date picker, 4 digits will reassure a correct year.

Supported formats

These formats are tested to work. Other formats or combinations might work also, but we guarantee these to work.

  • D/M/YY

  • DD/MM/YYYY

  • DD-MMM-YY

  • D MMMM YYYY

  • DD.MM.YYYY

  • D.M.YY

  • DDMMYYYY

  • DD *

  • D *

  • EE *

  • EEEE *

  • M/D/YY

  • MM/DD/YYYY

  • MM.DD.YYYY

  • MM DD YYYY *

  • MM-DD-YYYY *

  • M.D.YY

  • MMYY

  • MMMM *

  • YYYY/MM/DD

  • YYYY.MM.DD

  • YYMM

  • YYYYMMDD

  • YY *

  • YYYY *

* Guaranteed to work on CHILI publisher Online and GraFx Publisher

List

...

A list variable can be configured to hold multiple list items, with the option to hide certain items based on values of other variables. The "value" of each list item is optional, and will be used (if present) when the selected item is inserted into a variable Text Frame.

...

Color, Paragraph Style, Character Style, Font

Image Removed   Image Removed

...

The choice of selectable items can be limited based on a filter on name.

...

Button bars can be configured to contain a set of buttons, each with an associated Document Action to be executed

Structured Text

A structured text variable can hold long text (behaves the same way) but can also contain tagged (structured) text.

This variable can then be mapped to a pre-defined mapping in the BackOffice, where you map tags to styles.

...

Actions

See Getting Started with Document Actions for an overview of possibilities of Document Actions. From the context of Variable Data, the following actions are possible. Note that for complex actions, it might make more sense to use Document Event Actions, which allow you to group logic for the entire set of defined variables.

...