Mercurial > prosody-modules

comparison mod_conversejs/README.markdown @ 3598:1921ae4449b8

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
mod_conversejs: Separate out templates into separate configurable files (breaks 0.9 compat)
author Kim Alvefur <zash@zash.se>
date Thu, 16 May 2019 08:45:41 +0200
parents 5567098a7f91
children 740870196b97
comparison
equal deleted inserted replaced
3597:da7ec4ed6ddf 3598:1921ae4449b8
45 ---- 45 ----
46 46
47 The module is served on Prosody's default HTTP ports at the path 47 The module is served on Prosody's default HTTP ports at the path
48 `/conversejs`. More details on configuring HTTP modules in Prosody can 48 `/conversejs`. More details on configuring HTTP modules in Prosody can
49 be found in our [HTTP documentation](http://prosody.im/doc/http). 49 be found in our [HTTP documentation](http://prosody.im/doc/http).
50
51 ## Templates
52
53 The HTML and JS can be customized either by editing the included
54 `template.html` and `template.js` files or configuring your own like:
55
56 ```lua
57 conversejs_html_template = "/path/to/my-template.html"
58 conversejs_js_template = "/path/to/my-template.js"
59 ```
60
61 The HTML template uses Prosodys
62 [`util.interpolation`][doc:developers:util:interpolation] template
63 library while the JS template has `%s` where generated settings are
64 injected.
50 65
51 Other 66 Other
52 ----- 67 -----
53 68
54 To pass [other Converse.js 69 To pass [other Converse.js
117 The example above uses the `[[` and `]]` syntax simply because it will not conflict with any embedded quotes. 132 The example above uses the `[[` and `]]` syntax simply because it will not conflict with any embedded quotes.
118 133
119 Compatibility 134 Compatibility
120 ============= 135 =============
121 136
122 Should work with Prosody 0.9 and later. Websocket support requires 0.10. 137 Prosody version state
138 ----------------- ---------------
139 0.9 Does not work
140 0.10 Should work
141 0.11 Should work
142 trunk Works