Adding a single use variable - AcceleratorKMS - Version 3.12 - Help - Hexagon

AcceleratorKMS Traditional Content Writing
Language
English
Product
AcceleratorKMS
Search by Category
Help
AcceleratorKMS Version
3.12

Use a single use variable in traditional content when the value does not need to be reused.

Before you begin

You must have the document open and the statement in edit mode or the statement must be in edit mode from the statement editor window.

About this task

Single-use variables work well in traditional documents when the statement containing the single-use variable is expected to be reused but the variable value is not. After a variable is used in a document, the value for the variable is defined in the document where the statement is used.

SHARED Tip When using variables within a block in traditional content, you must define the variable values AFTER the block is saved. Otherwise the values are lost.

Loss of single use variable values. When a statement that includes a single use variable is reused, the variable name must not be modified. Changing the variable name, removes all values associated with the variable in every instance where that statement is used, including other documents that use that same statement. For example, when the statement uses the single use variable {su} and you rename it to {su1}, this causes all associated values of {su} to be lost. Instead, a new statement with a new single use variable named {su1} needs to be created.

Procedure

  1. Place your cursor where you want the single use variable.

    Variables can be added to Block titles, Statements, and the More details area within statements.

  2. Select {su} from the formatting toolbar.

    You can also create the single use variable manually by typing {su} inside curly braces { }

    You can repeat the same single-use variable within the same statement; however, if the second single-use variable needs to be defined differently than the first, you can append a number to the variable to make the name unique. For example, the second variable name would be {su1}.

  3. Click Preview to save the statement.

    SHARED Tip Variables that have not been defined will have a red box drawn around them. The box turns green when values are entered.

  4. Define the value for the variable(s).

Results

The single use variable is added to the statement.

What to do next

If you reuse the statement within the same document or within another document, you must add a new value for the variable every time that statement is used.