variable_string

Define a variable from a string parameter.

⚙️ Compatible targets: Linux, Windows

Parameters

Name	Documentation
prefix	The prefix of the variable name. This parameter is required.
name	The variable to define, the full name will be prefix.name. This parameter is required.
value	The variable content. This parameter is required.

Outcome conditions

You need to replace ${name} with its actual canonified value.

✅ Ok: variable_string_${name}_ok
- ☑️ Already compliant: variable_string_${name}_kept
- 🟨 Repaired: variable_string_${name}_repaired
❌ Error: variable_string_${name}_error

Example

method: variable_string
params:
  name: VALUE
  prefix: VALUE
  value: VALUE

Documentation

To use the generated variable, you must use the form ${prefix.name} with each name replaced with the parameters of this method.

Be careful that using a global variable can lead to unpredictable content in case of multiple definition, which is implicitly the case when a technique has more than one instance (directive). Please note that only global variables are available within templates.