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/customize_integrated_help.md
+7-6Lines changed: 7 additions & 6 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -10,6 +10,7 @@ The integrated help menu is part of the Integrated help introduced as an LTS Upd
10
10
By default, it provides editors and developers with convenient access to documentation, training and other resources directly from the back office.
11
11
12
12
You can extend or modify the integrated menu in two ways:
13
+
13
14
- by modifying a link to user documentation in a yaml file
14
15
- by subscribing to the `ibexa_integrated_help.menu_configure.help_menu` event
15
16
@@ -32,12 +33,12 @@ When it builds the integrated help menu, it dispatches the `ibexa_integrated_hel
32
33
33
34
You can intercept this event, and change its contents by creating a subscriber.
34
35
With that subscriber, you can access the `menu` object, which is an instance of the `Knp\Menu\MenuItem`, and all the options passed by this object, and modify them.
35
-
This way you can adjust menu sections, add new items, or integrate custom links into the help system.
36
+
This way you can adjust menu sections that are reproduced by the front end as tabs, add new items, or integrate custom links into the help system.
36
37
37
38
### Menu object structure
38
39
39
40
The default `menu` object is structured as follows.
40
-
Recreate this pattern when sending a customized event to the front end.
41
+
Recreate this pattern when modifying an existing event with an intention to send it to the front end.
41
42
42
43
```
43
44
root (MenuItem)
@@ -53,8 +54,8 @@ root (MenuItem)
53
54
└── help__support_portal
54
55
```
55
56
56
-
`help_general` and `help_developers` are menu sections that are reproduced by the front end as tabs.
57
-
Tabs consist of entries, and each entry carries the following information:
57
+
`help_general` and `help_developers` are menu sections, or tabs.
58
+
Sections consist of entries, and each entry carries the following information:
58
59
59
60
- `label` - a name of the help menu item
60
61
- `uri` - an external link to the resource
@@ -75,8 +76,8 @@ declare(strict_types=1);
75
76
76
77
namespace App\EventSubscriber;
77
78
78
-
use Ibexa\Contracts\AdminUi\Menu\Event\ConfigureMenuEvent;
79
79
use Symfony\Component\EventDispatcher\EventSubscriberInterface;
80
+
use Symfony\Contracts\EventDispatcher\Event;
80
81
81
82
final class HelpMenuSubscriber implements EventSubscriberInterface
82
83
{
@@ -91,7 +92,7 @@ final class HelpMenuSubscriber implements EventSubscriberInterface
91
92
];
92
93
}
93
94
94
-
public function onHelpMenuConfigure(ConfigureMenuEvent $event): void
95
+
public function onHelpMenuConfigure(Event $event): void
0 commit comments