[docs] Update documentation for variables (#38)

OpenBAS-Platform · Oct 18, 2024 · 28b3606 · 28b3606
1 parent 24ad2f1
commit 28b3606
Show file tree

Hide file tree

Showing 9 changed files with 20 additions and 5 deletions.
diff --git a/docs/usage/assets/variables-management.png b/docs/usage/assets/variables-management.png
diff --git a/docs/usage/assets/variables-usage.png b/docs/usage/assets/variables-usage.png
diff --git a/docs/usage/assets/variables_creation.png b/docs/usage/assets/variables_creation.png
diff --git a/docs/usage/assets/variables_inject_definition.png b/docs/usage/assets/variables_inject_definition.png
diff --git a/docs/usage/assets/variables_list.png b/docs/usage/assets/variables_list.png
diff --git a/docs/usage/assets/variables_management.png b/docs/usage/assets/variables_management.png
diff --git a/docs/usage/assets/variables_usage.png b/docs/usage/assets/variables_usage.png
diff --git a/docs/usage/assets/variables_usage_in_email.png b/docs/usage/assets/variables_usage_in_email.png
diff --git a/docs/usage/components/variables.md b/docs/usage/components/variables.md
@@ -9,6 +9,13 @@ Examples of built-in variables include but not limited to :
 - **${user.email}**: Represents the email of the target user
 - **${exercise.name}**: Represents the name of the current exercise
 - **${player_uri}**: Represents the player interface platform link
+- **${teams}**: Represents the list of team name/s for the injection
+
+
+The list of **available variables** is found in the definition of the inject :
+
+![Variables section](../assets/variables_inject_definition.png)
+![Variables section](../assets/variables_list.png)
 
 ## Custom Variables
 
@@ -20,8 +27,10 @@ To define custom variables :
 2. Navigate to the Definition tab
 3. Navigate to the Variables section
 
-In this section, users can create, update or delete custom variables.
-![Variables section](../assets/variables-management.png)
+In this section, users can create, update or delete custom variables : 
+
+![Variables section](../assets/variables_management.png)
+![Variables section](../assets/variables_creation.png)
 
 ### Limitation
 
@@ -32,9 +41,15 @@ To create custom variables, consider the following limitation:
 
 ## Use Variables
 
-These variables can be used to enhance personalization of certain stimuli within an exercise.
-Here is a non-exhaustive list of concerned stimuli :
+These variables can be used to enhance personalization of certain injects within an exercise.
+Here is a non-exhaustive list of concerned injects :
 - Email sending
 - Sms sending
 
-![Variables usage](../assets/variables-usage.png)
+![Variables usage](../assets/variables_usage.png)
+![Variables usage](../assets/variables_usage_in_email.png)
+
+In case of a list like `articles`, which is a list of articles with properties such as `id`, `name`, and `uri`, or `${teams}`, you could write:
+
+<#list articles as article> - `${article.name}` </#list>  
+<#list teams as team> `${team}` </#list>