docs/package/pip/acp-menu.md

   1 # ACP Menu Package Installation Plugin
   2
   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
  11 <span class="label label-info">Optional</span>
  12
  13 The item’s parent item.
  14
  15 ### `<showorder>`
  16
  17 <span class="label label-info">Optional</span>
  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
  28 Additional components if `<controller>` is set,
  29 the full external link otherwise.
  30
  31 ### `<icon>`
  32
  33 !!! info "Use an icon only for top-level and 4th-level items."
  34
  35 Name of the Font Awesome icon class.
  36
  37 ### `<options>`
  38
  39 <span class="label label-info">Optional</span>
  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
  45 <span class="label label-info">Optional</span>
  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
  51 {jinja{ codebox(
  52     "xml",
  53     "package/pip/acpMenu.xml",
  54     "acpMenu.xml"
  55 ) }}