Mercurial > prosody-wiki

annotate mod_vjud.wiki @ 395:af771646760b

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
Add small note about the separate 0.8 repo
author Kim Alvefur <zash@zash.se>
date Fri, 02 Aug 2013 18:23:40 +0200
parents 2454dbf940a8
children
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
292
Kim Alvefur <zash@zash.se>
parents:
diff changeset
1 #summary XEP-0055: Jabber Search
Kim Alvefur <zash@zash.se>
parents:
diff changeset
2 #labels Stage-Alpha
Kim Alvefur <zash@zash.se>
parents:
diff changeset
3
Kim Alvefur <zash@zash.se>
parents:
diff changeset
4 = Introduction =
Kim Alvefur <zash@zash.se>
parents:
diff changeset
5
Kim Alvefur <zash@zash.se>
parents:
diff changeset
6 Basic implementation of [http://xmpp.org/extensions/xep-0055.html XEP-0055: Jabber Search].
Kim Alvefur <zash@zash.se>
parents:
diff changeset
7
Kim Alvefur <zash@zash.se>
parents:
diff changeset
8 = Details =
Kim Alvefur <zash@zash.se>
parents:
diff changeset
9
365
2454dbf940a8 mod_vjud.wiki: Update for 0.9 changes
Kim Alvefur <zash@zash.se>
parents: 300
diff changeset
10 This module has two modes. One mode requires users to opt-in to be
2454dbf940a8 mod_vjud.wiki: Update for 0.9 changes
Kim Alvefur <zash@zash.se>
parents: 300
diff changeset
11 searchable, then allows users to search the list of those users. The
2454dbf940a8 mod_vjud.wiki: Update for 0.9 changes
Kim Alvefur <zash@zash.se>
parents: 300
diff changeset
12 second mode allows search accross all users.
292
Kim Alvefur <zash@zash.se>
parents:
diff changeset
13
Kim Alvefur <zash@zash.se>
parents:
diff changeset
14 = Usage =
Kim Alvefur <zash@zash.se>
parents:
diff changeset
15
Kim Alvefur <zash@zash.se>
parents:
diff changeset
16 First copy the module to the prosody plugins directory.
Kim Alvefur <zash@zash.se>
parents:
diff changeset
17
Kim Alvefur <zash@zash.se>
parents:
diff changeset
18 Then add "vjud" to your modules_enabled list:
Kim Alvefur <zash@zash.se>
parents:
diff changeset
19 {{{
Kim Alvefur <zash@zash.se>
parents:
diff changeset
20 modules_enabled = {
Kim Alvefur <zash@zash.se>
parents:
diff changeset
21 -- ...
Kim Alvefur <zash@zash.se>
parents:
diff changeset
22 "vjud",
Kim Alvefur <zash@zash.se>
parents:
diff changeset
23 -- ...
Kim Alvefur <zash@zash.se>
parents:
diff changeset
24 }
Kim Alvefur <zash@zash.se>
parents:
diff changeset
25 }}}
Kim Alvefur <zash@zash.se>
parents:
diff changeset
26
300
2dc7d6aab48e mod_vjud: Add config example of running as a component
Kim Alvefur <zash@zash.se>
parents: 292
diff changeset
27
2dc7d6aab48e mod_vjud: Add config example of running as a component
Kim Alvefur <zash@zash.se>
parents: 292
diff changeset
28 Alternatively, you can load it as a component:
2dc7d6aab48e mod_vjud: Add config example of running as a component
Kim Alvefur <zash@zash.se>
parents: 292
diff changeset
29
2dc7d6aab48e mod_vjud: Add config example of running as a component
Kim Alvefur <zash@zash.se>
parents: 292
diff changeset
30 {{{
2dc7d6aab48e mod_vjud: Add config example of running as a component
Kim Alvefur <zash@zash.se>
parents: 292
diff changeset
31 Component "search.example.com" "vjud"
2dc7d6aab48e mod_vjud: Add config example of running as a component
Kim Alvefur <zash@zash.se>
parents: 292
diff changeset
32 }}}
2dc7d6aab48e mod_vjud: Add config example of running as a component
Kim Alvefur <zash@zash.se>
parents: 292
diff changeset
33
2dc7d6aab48e mod_vjud: Add config example of running as a component
Kim Alvefur <zash@zash.se>
parents: 292
diff changeset
34 (Some old clients require this)
2dc7d6aab48e mod_vjud: Add config example of running as a component
Kim Alvefur <zash@zash.se>
parents: 292
diff changeset
35
292
Kim Alvefur <zash@zash.se>
parents:
diff changeset
36 = Configuration =
Kim Alvefur <zash@zash.se>
parents:
diff changeset
37
365
2454dbf940a8 mod_vjud.wiki: Update for 0.9 changes
Kim Alvefur <zash@zash.se>
parents: 300
diff changeset
38 || Option || Default || Description ||
2454dbf940a8 mod_vjud.wiki: Update for 0.9 changes
Kim Alvefur <zash@zash.se>
parents: 300
diff changeset
39 || vjud_mode || "opt-in" || Defines how the module behaves ||
292
Kim Alvefur <zash@zash.se>
parents:
diff changeset
40
Kim Alvefur <zash@zash.se>
parents:
diff changeset
41 = Compatibility =
365
2454dbf940a8 mod_vjud.wiki: Update for 0.9 changes
Kim Alvefur <zash@zash.se>
parents: 300
diff changeset
42 || 0.8 || Works, but only the opt-in mode ||
292
Kim Alvefur <zash@zash.se>
parents:
diff changeset
43 || 0.9 || Works ||
Kim Alvefur <zash@zash.se>
parents:
diff changeset
44 || trunk || Works ||
Kim Alvefur <zash@zash.se>
parents:
diff changeset
45
Kim Alvefur <zash@zash.se>
parents:
diff changeset
46 Note that the version for 0.8 and 0.9 are slightly different.
Kim Alvefur <zash@zash.se>
parents:
diff changeset
47