annotate mod_archive_muc.wiki @ 396:5720e3f68061

Update docs for lpty-based version
author MWild1@gmail.com
date Tue, 13 Aug 2013 17:47:14 +0000
parents f7f2befb0f3e
children
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
147
de13306634bb Created wiki page through web user interface.
shinysky1986@gmail.com
parents:
diff changeset
1 #summary XEP-xxxx: Message Archive Management
374
f7f2befb0f3e Labels are apparently comma-separated
Kim Alvefur <zash@zash.se>
parents: 373
diff changeset
2 #labels Stage-Alpha, Deprecated
147
de13306634bb Created wiki page through web user interface.
shinysky1986@gmail.com
parents:
diff changeset
3
de13306634bb Created wiki page through web user interface.
shinysky1986@gmail.com
parents:
diff changeset
4 = Introduction =
de13306634bb Created wiki page through web user interface.
shinysky1986@gmail.com
parents:
diff changeset
5
de13306634bb Created wiki page through web user interface.
shinysky1986@gmail.com
parents:
diff changeset
6 Implementation of [http://matthewwild.co.uk/uploads/message-archive-management.html XEP-xxxx: Message Archive Management]. Like [mod_archive] but much simpler.
de13306634bb Created wiki page through web user interface.
shinysky1986@gmail.com
parents:
diff changeset
7
149
4616d70c974a Edited wiki page through web user interface.
shinysky1986@gmail.com
parents: 147
diff changeset
8 = Details =
4616d70c974a Edited wiki page through web user interface.
shinysky1986@gmail.com
parents: 147
diff changeset
9
4616d70c974a Edited wiki page through web user interface.
shinysky1986@gmail.com
parents: 147
diff changeset
10 The server will have the ability to archive muc messages passing through.
4616d70c974a Edited wiki page through web user interface.
shinysky1986@gmail.com
parents: 147
diff changeset
11
147
de13306634bb Created wiki page through web user interface.
shinysky1986@gmail.com
parents:
diff changeset
12 = Usage =
149
4616d70c974a Edited wiki page through web user interface.
shinysky1986@gmail.com
parents: 147
diff changeset
13
4616d70c974a Edited wiki page through web user interface.
shinysky1986@gmail.com
parents: 147
diff changeset
14 First copy the module to the prosody plugins directory.
4616d70c974a Edited wiki page through web user interface.
shinysky1986@gmail.com
parents: 147
diff changeset
15
4616d70c974a Edited wiki page through web user interface.
shinysky1986@gmail.com
parents: 147
diff changeset
16 Then add "archive_muc" to your modules_enabled list:
4616d70c974a Edited wiki page through web user interface.
shinysky1986@gmail.com
parents: 147
diff changeset
17 {{{
4616d70c974a Edited wiki page through web user interface.
shinysky1986@gmail.com
parents: 147
diff changeset
18 modules_enabled = {
4616d70c974a Edited wiki page through web user interface.
shinysky1986@gmail.com
parents: 147
diff changeset
19 -- ...
4616d70c974a Edited wiki page through web user interface.
shinysky1986@gmail.com
parents: 147
diff changeset
20 "privacy",
4616d70c974a Edited wiki page through web user interface.
shinysky1986@gmail.com
parents: 147
diff changeset
21 "archive_muc",
4616d70c974a Edited wiki page through web user interface.
shinysky1986@gmail.com
parents: 147
diff changeset
22 -- ...
4616d70c974a Edited wiki page through web user interface.
shinysky1986@gmail.com
parents: 147
diff changeset
23 }}}
4616d70c974a Edited wiki page through web user interface.
shinysky1986@gmail.com
parents: 147
diff changeset
24
4616d70c974a Edited wiki page through web user interface.
shinysky1986@gmail.com
parents: 147
diff changeset
25 = Configuration =
4616d70c974a Edited wiki page through web user interface.
shinysky1986@gmail.com
parents: 147
diff changeset
26
4616d70c974a Edited wiki page through web user interface.
shinysky1986@gmail.com
parents: 147
diff changeset
27 || *Name* || *Description* || *Type* || *Default value* ||
4616d70c974a Edited wiki page through web user interface.
shinysky1986@gmail.com
parents: 147
diff changeset
28 || auto_muc_archiving_enabled || applied when no any preferences available || boolean || true ||
4616d70c974a Edited wiki page through web user interface.
shinysky1986@gmail.com
parents: 147
diff changeset
29
4616d70c974a Edited wiki page through web user interface.
shinysky1986@gmail.com
parents: 147
diff changeset
30 = Compatibility =
4616d70c974a Edited wiki page through web user interface.
shinysky1986@gmail.com
parents: 147
diff changeset
31 || 0.7.0 || Works ||
147
de13306634bb Created wiki page through web user interface.
shinysky1986@gmail.com
parents:
diff changeset
32
de13306634bb Created wiki page through web user interface.
shinysky1986@gmail.com
parents:
diff changeset
33 = TODO =
de13306634bb Created wiki page through web user interface.
shinysky1986@gmail.com
parents:
diff changeset
34 Test
de13306634bb Created wiki page through web user interface.
shinysky1986@gmail.com
parents:
diff changeset
35
149
4616d70c974a Edited wiki page through web user interface.
shinysky1986@gmail.com
parents: 147
diff changeset
36
4616d70c974a Edited wiki page through web user interface.
shinysky1986@gmail.com
parents: 147
diff changeset
37
4616d70c974a Edited wiki page through web user interface.
shinysky1986@gmail.com
parents: 147
diff changeset
38