|
230
|
1 #summary Security Labels |
|
|
2 #labels Stage-Alpha |
|
|
3 |
|
|
4 = Introduction = |
|
|
5 |
|
|
6 This module implements [http://xmpp.org/extensions/xep-0258.htmla XEP-0258: Security Labels in XMPP]. |
|
|
7 |
|
|
8 = Configuration = |
|
|
9 |
|
|
10 As with all modules, you enable it by adding it to the modules_enabled list. |
|
|
11 |
|
|
12 {{{ |
|
|
13 modules_enabled = { |
|
|
14 ... |
|
|
15 "seclabels"; |
|
|
16 ... |
|
|
17 } |
|
|
18 }}} |
|
|
19 |
|
|
20 These options exist: |
|
|
21 |
|
|
22 || *Name* || *Description* || *Default* || |
|
|
23 || security_catalog_name || Catalouge name || "Default" || |
|
|
24 || security_catalog_desc || Catalouge description || "My labels" || |
|
|
25 |
|
|
26 You can then add your labels in a table called security_labels. They can be both orderd and unorderd, but ordered comes first. |
|
|
27 |
|
|
28 {{{ |
|
|
29 security_labels = { |
|
|
30 { -- This label will come first |
|
|
31 name = "Public", |
|
|
32 label = true, -- This is a label, but without the actual label. |
|
|
33 default = true -- This is the default label. |
|
|
34 }, |
|
|
35 { |
|
|
36 name = "Private", |
|
|
37 label = "PRIVATE", |
|
|
38 color = "white", |
|
|
39 bgcolor = "blue" |
|
|
40 }, |
|
|
41 Sensitive = { -- A Sub-selector |
|
|
42 SECRET = { -- The index is used as name |
|
|
43 label = true |
|
|
44 }, |
|
|
45 TOPSECRET = { -- The order of this and the above is not guaranteed. |
|
|
46 color = "red", |
|
|
47 bgcolor = "black", |
|
|
48 } |
|
|
49 } |
|
|
50 } |
|
|
51 }}} |
|
|
52 |
|
|
53 |
|
|
54 Each label can have the following properties: |
|
|
55 |
|
|
56 || *Name* || *Description* || *Default* || |
|
|
57 || name || The name of the label. Used for selector. || Required. || |
|
391
|
58 || label || The actual label, ie {{{<esssecuritylabel/>}}} || Required, can be boolean for a empty label, or a string. || |
|
230
|
59 || display || The text shown as display marking. || Defaults to the name || |
|
|
60 || color, bgcolor || The fore- and background color of the display marking || None || |
|
|
61 || default || Boolean, true for the default. Only one may be default. || false || |
|
|
62 |
