You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: docs/administration/back_office/configure_product_tour.md
+23-16Lines changed: 23 additions & 16 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -17,7 +17,7 @@ Use the default provided configuration, available in `config/packages/ibexa_inte
17
17
18
18
## Configuration structure
19
19
20
-
Product tour scenarios are configured under the `ibexa.system.<siteaccess>.product_tour` key.
20
+
Configure product tour scenarios under the `ibexa.system.<siteaccess>.product_tour` key.
21
21
Each scenario has a unique identifier and contains steps, which in turn contain blocks.
22
22
23
23
Basic configuration structure of a scenario:
@@ -72,11 +72,13 @@ The order of scenarios in the configuration file determines the order in which t
72
72
73
73
For **general scenario**, the scenario appears at the earliest opportunity (on any page after logging in), with an exception of the user settings area.
74
74
75
-
For **targeted scenarios**, the scenario begins if the target element is found in the DOM.
76
-
This means the scenario only appears on pages where the target element exists.
77
-
To control where a targeted tour appears, ensure the first step targets an element unique to that specific page or section.
75
+
For **targeted scenarios**, the scenario begins if the target element is found in the DOM when the page is loaded.
76
+
Targeted scenarios don't trigger in the user settings area as well.
78
77
79
-
Once a scenario ends, the next scenario from the configuration is evaluated and, if applicable, displayed.
78
+
To control where a targeted tour appears, ensure that the first step targets an element unique to that specific page.
79
+
You can target elements that appear after a user action (for example, modals like [content browser](browser.md)), but the first step's target must be present in the DOM when the page is loaded.
80
+
81
+
Once a scenario ends, the system evaluates the next scenario from the configuration and, if applicable, displays it.
80
82
81
83
### Scenario type
82
84
@@ -113,22 +115,24 @@ The configuration differs based on scenario type:
113
115
114
116
### General scenario steps
115
117
116
-
General scenario steps display centered modals and support the `background_image` settings, allowing you to set a shared background image for each step.
118
+
General scenario steps display centered modals and support the `background_image` setting, allowing you to set a shared background image for each step.
119
+
For the background, you can use an absolute URL or place your image in the `public` directory and provide the path relative to it.
120
+
To resolve the path relative to the site root, [prefix it with `/`](https://developer.mozilla.org/en-US/docs/Web/API/URL_API/Resolving_relative_references#root_relative).
If a step's target element doesn't exist on the page, the step isn't be displayed and the scenario is be stopped.
135
+
If a step's target element doesn't exist on the page, the step isn't displayed and the scenario is stopped.
132
136
Ensure your configuration matches the actual DOM structure to avoid broken scenarios.
133
137
Use unique selectors to avoid triggering your scenarios on other pages.
134
138
@@ -143,11 +147,12 @@ TODO: 2 pane screenshot here, showing the UI for each of types.
143
147
144
148
Clickable and draggable modes are designed for single actions only (buttons, links).
145
149
You can't select an entire form.
146
-
If the interaction with the highlighted element results in redirection to a new page or opening a modal window where the previous target element can't be found, the "Previous" navigation step will be disabled.
150
+
If the interaction with the highlighted element results in redirection to a new page or opening a modal window where the previous target element can't be found, the "Previous" navigation button won't be displayed.
147
151
148
152
**Standard mode**:
149
153
150
-
The default value. A tooltip attached to specific element on the page is displayed.
154
+
The default value.
155
+
A tooltip attached to specific element on the page is displayed.
151
156
Users continue the scenario with Previous/Next buttons:
152
157
153
158
```yaml
@@ -172,6 +177,8 @@ Users continue the scenario by [dragging](https://developer.mozilla.org/en-US/do
You can use this mode only with HTML elements that have the [`draggable` attribute](https://developer.mozilla.org/en-US/docs/Web/HTML/Reference/Global_attributes/draggable) set to `true`.
181
+
175
182
## Block types
176
183
177
184
Blocks are content elements that make up each step, available both for `general` and `targetable` scenarios.
@@ -216,15 +223,15 @@ The `title_translation_key` property is optional.
216
223
217
224
### Media blocks
218
225
219
-
To provide data to the media block, place your image or video files in the `public` directory and provide the relative path to it.
220
-
221
-
!!! tip
222
-
223
-
To resolve the path relative to the site root, [prefix it with `/`](https://developer.mozilla.org/en-US/docs/Web/API/URL_API/Resolving_relative_references#root_relative).
226
+
To provide data to the media block, provide absolute URLs or place your image or video files in the `public` directory and provide the path relative to it.
227
+
To resolve the path relative to the site root, [prefix it with `/`](https://developer.mozilla.org/en-US/docs/Web/API/URL_API/Resolving_relative_references#root_relative).
224
228
225
229
#### Image block
226
230
227
-
Embed images with alternative text:
231
+
Embed images inside the step.
232
+
You can provide alternative text by using the `alt_translation_key` property.
233
+
234
+
Assuming a `public/img/diagram.jpg` image exists, set the configuration value to `/img/diagram.jpg`.
0 commit comments