Skip to content

Commit d25766e

Browse files
committed
Implement review comments
1 parent c896330 commit d25766e

File tree

1 file changed

+7
-6
lines changed

1 file changed

+7
-6
lines changed

docs/administration/back_office/customize_integrated_help.md

Lines changed: 7 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -10,6 +10,7 @@ The integrated help menu is part of the Integrated help introduced as an LTS Upd
1010
By default, it provides editors and developers with convenient access to documentation, training and other resources directly from the back office.
1111

1212
You can extend or modify the integrated menu in two ways:
13+
1314
- by modifying a link to user documentation in a yaml file
1415
- by subscribing to the `ibexa_integrated_help.menu_configure.help_menu` event
1516

@@ -32,12 +33,12 @@ When it builds the integrated help menu, it dispatches the `ibexa_integrated_hel
3233

3334
You can intercept this event, and change its contents by creating a subscriber.
3435
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.
3637

3738
### Menu object structure
3839

3940
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.
4142

4243
```
4344
root (MenuItem)
@@ -53,8 +54,8 @@ root (MenuItem)
5354
└── help__support_portal
5455
```
5556
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:
5859
5960
- `label` - a name of the help menu item
6061
- `uri` - an external link to the resource
@@ -75,8 +76,8 @@ declare(strict_types=1);
7576
7677
namespace App\EventSubscriber;
7778
78-
use Ibexa\Contracts\AdminUi\Menu\Event\ConfigureMenuEvent;
7979
use Symfony\Component\EventDispatcher\EventSubscriberInterface;
80+
use Symfony\Contracts\EventDispatcher\Event;
8081
8182
final class HelpMenuSubscriber implements EventSubscriberInterface
8283
{
@@ -91,7 +92,7 @@ final class HelpMenuSubscriber implements EventSubscriberInterface
9192
];
9293
}
9394
94-
public function onHelpMenuConfigure(ConfigureMenuEvent $event): void
95+
public function onHelpMenuConfigure(Event $event): void
9596
{
9697
$menu = $event->getMenu();
9798

0 commit comments

Comments
 (0)