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

# Menu Item Package Installation Plugin

Adds menu items to existing menus.

## Components

Each item is described as an `<item>` element with the mandatory attribute `identifier` that should follow the naming pattern `<packageIdentifier>.<PageName>`, e.g. `com.woltlab.wcf.Dashboard`.

### `<menu>`

The target menu that the item should be added to, requires the internal identifier set by creating a menu through the [menu.xml](menu.md).

### `<title>`

!!! info "The `language` attribute is required and should specify the [ISO-639-1](https://en.wikipedia.org/wiki/ISO_639-1) language code."

The title is displayed as the link title of the menu item and can be fully customized by the administrator, thus is immutable after deployment. Supports multiple `<title>` elements to provide localized values.

### `<page>`

The page that the link should point to, requires the internal identifier set by creating a page through the [page.xml](page.md).

## Example

{jinja{ codebox(
  title="menuItem.xml",
  language="xml",
  filepath="package/pip/menuItem.xml"
) }}
Commit	Line	Data
8659eb86	1	# Menu Item Package Installation Plugin
1113ec1a AE	2
	3	Adds menu items to existing menus.
	4
	5	## Components
	6
0931f8b4	7	Each item is described as an `<item>` element with the mandatory attribute `identifier` that should follow the naming pattern `<packageIdentifier>.<PageName>`, e.g. `com.woltlab.wcf.Dashboard`.
1113ec1a AE	8
	9	### `<menu>`
	10
21609ed2	11	The target menu that the item should be added to, requires the internal identifier set by creating a menu through the [menu.xml](menu.md).
1113ec1a AE	12
	13	### `<title>`
	14
32f9f6c3	15	!!! info "The `language` attribute is required and should specify the [ISO-639-1](https://en.wikipedia.org/wiki/ISO_639-1) language code."
1113ec1a AE	16
	17	The title is displayed as the link title of the menu item and can be fully customized by the administrator, thus is immutable after deployment. Supports multiple `<title>` elements to provide localized values.
	18
	19	### `<page>`
	20
21609ed2	21	The page that the link should point to, requires the internal identifier set by creating a page through the [page.xml](page.md).
1113ec1a AE	22
	23	## Example
	24
9a3f5fa3	25	{jinja{ codebox(
f778fce2 MS	26	title="menuItem.xml",
	27	language="xml",
	28	filepath="package/pip/menuItem.xml"
9a3f5fa3	29	) }}