Update `codebox` macro
[GitHub/WoltLab/woltlab.github.io.git] / docs / package / pip / acl-option.md
CommitLineData
8659eb86 1# ACL Option Package Installation Plugin
0b768461 2
649fb02c
MS
3Add customizable permissions for individual objects.
4
5## Option Components
6
7Each acl option is described as an `<option>` element with the mandatory attribute `name`.
8
9### `<categoryname>`
10
ca3f33cf 11<span class="label label-info">Optional</span>
649fb02c
MS
12
13The name of the acl option category to which the option belongs.
14
15### `<objecttype>`
16
17The name of the acl object type (of the object type definition `com.woltlab.wcf.acl`).
18
19
20## Category Components
21
22Each 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
26The name of the acl object type (of the object type definition `com.woltlab.wcf.acl`).
27
28
29## Example
30
9a3f5fa3 31{jinja{ codebox(
f778fce2
MS
32 title="aclOption.xml",
33 language="xml",
34 filepath="package/pip/aclOption.xml"
9a3f5fa3 35) }}