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

# Menu Package Installation Plugin

Deploy and manage menus that can be placed anywhere on the site.

## Components

Each item is described as a `<menu>` element with the mandatory attribute `identifier` that should follow the naming pattern `<packageIdentifier>.<MenuName>`, e.g. `com.woltlab.wcf.MainMenu`.

### `<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 internal name displayed in the admin panel only, can be fully customized by the administrator and is immutable. Only one value is accepted and will be picked based on the site's default language, but you can provide localized values by including multiple `<title>` elements.

### `<box>`

The following elements of the [box PIP](box.md) are supported, please refer to the documentation to learn more about them:

* `<position>`
* `<showHeader>`
* `<visibleEverywhere>`
* `<visibilityExceptions>`
* `cssClassName`

## Example

{jinja{ codebox(
  title="menu.xml",
  language="xml",
  filepath="package/pip/menu.xml"
) }}
Commit	Line	Data
8659eb86	1	# Menu Package Installation Plugin
8f710e75 AE	2
	3	Deploy and manage menus that can be placed anywhere on the site.
	4
	5	## Components
	6
1113ec1a	7	Each item is described as a `<menu>` element with the mandatory attribute `identifier` that should follow the naming pattern `<packageIdentifier>.<MenuName>`, e.g. `com.woltlab.wcf.MainMenu`.
8f710e75 AE	8
	9	### `<title>`
	10
32f9f6c3	11	!!! info "The `language` attribute is required and should specify the [ISO-639-1](https://en.wikipedia.org/wiki/ISO_639-1) language code."
8f710e75 AE	12
	13	The internal name displayed in the admin panel only, can be fully customized by the administrator and is immutable. Only one value is accepted and will be picked based on the site's default language, but you can provide localized values by including multiple `<title>` elements.
	14
	15	### `<box>`
	16
21609ed2	17	The following elements of the [box PIP](box.md) are supported, please refer to the documentation to learn more about them:
8f710e75 AE	18
	19	* `<position>`
	20	* `<showHeader>`
	21	* `<visibleEverywhere>`
	22	* `<visibilityExceptions>`
	23	* `cssClassName`
	24
	25	## Example
	26
9a3f5fa3	27	{jinja{ codebox(
f778fce2 MS	28	title="menu.xml",
	29	language="xml",
	30	filepath="package/pip/menu.xml"
9a3f5fa3	31	) }}