docs/package/pip/acl-option.md

   1 # ACL Option Package Installation Plugin
   2
   3 Add customizable permissions for individual objects.
   4
   5 ## Option Components
   6
   7 Each acl option is described as an `<option>` element with the mandatory attribute `name`.
   8
   9 ### `<categoryname>`
  10
  11 <span class="label label-info">Optional</span>
  12
  13 The name of the acl option category to which the option belongs.
  14
  15 ### `<objecttype>`
  16
  17 The name of the acl object type (of the object type definition `com.woltlab.wcf.acl`).
  18
  19
  20 ## Category Components
  21
  22 Each acl option category is described as an `<category>` element with the mandatory attribute `name`  that should follow the naming pattern `<permissionName>` or `<permissionType>.<permissionName>`, with `<permissionType>` generally having `user` or `mod` as value.
  23
  24 ### `<objecttype>`
  25
  26 The name of the acl object type (of the object type definition `com.woltlab.wcf.acl`).
  27
  28
  29 ## Example
  30
  31 {jinja{ codebox(
  32   title="aclOption.xml",
  33   language="xml",
  34   filepath="package/pip/aclOption.xml"
  35 ) }}