mod_http_muc_log: Document optimization for storage modules lacking :dates API

author: Kim Alvefur <zash@zash.se>
date: Sun, 05 May 2019 14:05:00 +0200
parent: 2589:89a3f049689f
child: 3582:444e2306c99a
--- a/mod_http_muc_log/README.markdown	Sun May 05 13:00:25 2019 +0200
+++ b/mod_http_muc_log/README.markdown	Sun May 05 14:05:00 2019 +0200
@@ -50,6 +50,21 @@
 for rendering templates, with the pattern `"%b{}"` and HTML / XML
 escaping enabled.
 
+## Calendar optimization
+
+The calendar view relies on an optional part of the Prosody archive
+storage API that provides a list of every valid date. If this is
+unavailable then the module queries for the first and the last messages
+and assumes that every date between those is valid. This may lead to
+many empty pages in case the logs are sparse.
+
+This optimization can be turned off, to get a more accurate calendar
+view, but it will likely be very slow.
+
+``` {.lua}
+http_muc_log_lazy_calendar = false
+```
+
 Compatibility
 =============