variable_string_from_file
Define a variable from a file content.
⚙️ 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 variable_prefix.variable_name. This parameter is required. |
| file_name | The path of the file. This parameter is required. |
Outcome conditions
You need to replace ${name} with its actual canonified value.
- ✅ Ok:
variable_string_from_file_${name}_ok- ☑️ Already compliant:
variable_string_from_file_${name}_kept - 🟨 Repaired:
variable_string_from_file_${name}_repaired
- ☑️ Already compliant:
- ❌ Error:
variable_string_from_file_${name}_error
Example
method: variable_string_from_file
params:
name: VALUE
prefix: VALUE
file_name: VALUE
Documentation
To use the generated variable, you must use the form ${variable_prefix.variable_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.