[GitHub/WoltLab/woltlab.github.io.git] / docs / package / pip / acp-menu.md

# ACP Menu Package Installation Plugin

Registers new ACP menu items.

## Components

Each item is described as an `<acpmenuitem>` element with the mandatory attribute `name`.

### `<parent>`

<span class="label label-info">Optional</span>

The item’s parent item.

### `<showorder>`

<span class="label label-info">Optional</span>

Specifies the order of this item within the parent item.

### `<controller>`

The fully qualified class name of the target controller.
If not specified this item serves as a category.

### `<link>`

Additional components if `<controller>` is set,
the full external link otherwise.

### `<icon>`

!!! info "Use an icon only for top-level and 4th-level items."

Name of the Font Awesome icon class.

### `<options>`

<span class="label label-info">Optional</span>

The options element can contain a comma-separated list of options of which at least one needs to be enabled for the tab to be shown.

### `<permissions>`

<span class="label label-info">Optional</span>

The permissions element can contain a comma-separated list of permissions of which the active user needs to have at least one for the tab to be shown.

## Example

{jinja{ codebox(
  title="acpMenu.xml",
  language="xml",
  filepath="package/pip/acpMenu.xml"
) }}
Commit	Line	Data
8659eb86	1	# ACP Menu Package Installation Plugin
0b768461	2
f4630405 TD	3	Registers new ACP menu items.
	4
	5	## Components
	6
	7	Each item is described as an `<acpmenuitem>` element with the mandatory attribute `name`.
	8
	9	### `<parent>`
	10
ca3f33cf	11	<span class="label label-info">Optional</span>
f4630405 TD	12
	13	The item’s parent item.
	14
	15	### `<showorder>`
	16
ca3f33cf	17	<span class="label label-info">Optional</span>
f4630405 TD	18
	19	Specifies the order of this item within the parent item.
	20
	21	### `<controller>`
	22
	23	The fully qualified class name of the target controller.
	24	If not specified this item serves as a category.
	25
	26	### `<link>`
	27
0263c556	28	Additional components if `<controller>` is set,
f4630405 TD	29	the full external link otherwise.
	30
	31	### `<icon>`
	32
c1b5007e	33	!!! info "Use an icon only for top-level and 4th-level items."
f4630405 TD	34
	35	Name of the Font Awesome icon class.
	36
	37	### `<options>`
	38
ca3f33cf	39	<span class="label label-info">Optional</span>
f4630405 TD	40
	41	The options element can contain a comma-separated list of options of which at least one needs to be enabled for the tab to be shown.
	42
	43	### `<permissions>`
	44
ca3f33cf	45	<span class="label label-info">Optional</span>
f4630405 TD	46
	47	The permissions element can contain a comma-separated list of permissions of which the active user needs to have at least one for the tab to be shown.
	48
	49	## Example
	50
9a3f5fa3	51	{jinja{ codebox(
f778fce2 MS	52	title="acpMenu.xml",
	53	language="xml",
	54	filepath="package/pip/acpMenu.xml"
9a3f5fa3	55	) }}