# HG changeset patch
# User shinysky1986@gmail.com
# Date 1281705301 0
# Node ID 5d350ab051f8caae8dbb4886be4bcd7b97e42d22
# Parent  de13306634bbfd03f78fd108992b3933cc59073f
Edited wiki page through web user interface.

diff -r de13306634bb -r 5d350ab051f8 mod_archive.wiki
--- a/mod_archive.wiki	Mon Aug 09 11:25:31 2010 +0000
+++ b/mod_archive.wiki	Fri Aug 13 13:15:01 2010 +0000
@@ -1,14 +1,39 @@
 #summary XEP-0136: Message Archiving
+#labels Stage-Beta
 
 = Introduction =
 
-Implementation of [http://xmpp.org/extensions/xep-0136.html XEP-0136: Message Archiving].
+Currently many XMPP clients save the messages locally and it's not convenient or even possible to retrieve the historical messages, especially when one switches the clients a lot.
+
+So it will be much easier if the XMPP server supports server-side message archiving. In this case, the clients can retrieve archived messages anytime and anywhere. XMPP Extension Proposal XEP-0136 is defined for this purpose. This module is an implementation of [http://xmpp.org/extensions/xep-0136.html XEP-0136: Message Archiving].
+
+= Details =
+
+The server will have the ability to archive messages passing through.
 
 = Usage =
-Load mod_archive.
+
+First copy the module to the prosody plugins directory.
+
+Then add "archive" to your modules_enabled list:
+{{{
+    modules_enabled = {
+                    -- ...
+                    "privacy",
+                    "archive",
+                    -- ...
+}}}
+
+= Configuration =
+|| *Name* || *Description* || *Type* || *Default value* ||
+|| default_max || the maximum number of items to return when requesting collection list or archived messages || integer || 100 ||
+|| force_archiving || archive every message automatically, and do NOT consider the preferences || boolean || false ||
+|| auto_archiving_enabled || applied when no any preferences available || boolean || true ||
+
+
+= Compatibility =
+|| 0.7.0 || Works ||
 
 = TODO =
-All the features
-
-= Compatibility =
-|| 0.7.0 || temporarily ||
\ No newline at end of file
+ * consider '`exactmatch`' attribute when do JID matching.
+ * return a `<feature-not-implemented/>` error when the client set the value of the '`save`' attribute to '`stream`'.
\ No newline at end of file