Style Conventions for Code and Text Elements

These elements identify code options and variables used throughout the help documentation. Generally, you would not include these symbols or style elements in your code or data files. They’re visual indicators only.

Convention Explanation

variable

Variables appear in italics. Substitute the appropriate value for the variable name.

For visual clarity, sometimes variables and other code elements appear between < > brackets. You do not need to use these symbols in your code.

[optional]

Items in square brackets are optional.

(this|that)

Items in parenthesis indicate a Boolean OR choice.

literal

Include text or code exactly as shown.

< >

Sometimes variables and other code elements appear between < > brackets. These are used to improve clarity in long code blocks. Unless specified, do not include these symbols in a data file name or its contents.

On this page

Adobe Summit Banner

A virtual event April 27-28.

Expand your skills and get inspired.

Register for free
Adobe Summit Banner

A virtual event April 27-28.

Expand your skills and get inspired.

Register for free