mirror of
https://github.com/processone/ejabberd.git
synced 2024-11-24 16:23:40 +01:00
Update some modules doc to use the note field
This commit is contained in:
parent
b70a2fe4cf
commit
6e5895ce45
@ -252,8 +252,6 @@ mod_doc() ->
|
|||||||
#{desc =>
|
#{desc =>
|
||||||
[?T("This module serves a simple page for the "
|
[?T("This module serves a simple page for the "
|
||||||
"https://conversejs.org/[Converse] XMPP web browser client."), "",
|
"https://conversejs.org/[Converse] XMPP web browser client."), "",
|
||||||
?T("This module is available since ejabberd 21.12."),
|
|
||||||
?T("Several options were improved in ejabberd 22.05."), "",
|
|
||||||
?T("To use this module, in addition to adding it to the 'modules' "
|
?T("To use this module, in addition to adding it to the 'modules' "
|
||||||
"section, you must also enable it in 'listen' -> 'ejabberd_http' -> "
|
"section, you must also enable it in 'listen' -> 'ejabberd_http' -> "
|
||||||
"_`listen-options.md#request_handlers|request_handlers`_."), "",
|
"_`listen-options.md#request_handlers|request_handlers`_."), "",
|
||||||
@ -263,6 +261,7 @@ mod_doc() ->
|
|||||||
?T("When 'conversejs_css' and 'conversejs_script' are 'auto', "
|
?T("When 'conversejs_css' and 'conversejs_script' are 'auto', "
|
||||||
"by default they point to the public Converse client.")
|
"by default they point to the public Converse client.")
|
||||||
],
|
],
|
||||||
|
note => "added in 21.12 and improved in 22.05",
|
||||||
example =>
|
example =>
|
||||||
[{?T("Manually setup WebSocket url, and use the public Converse client:"),
|
[{?T("Manually setup WebSocket url, and use the public Converse client:"),
|
||||||
["listen:",
|
["listen:",
|
||||||
|
@ -211,11 +211,11 @@ mod_doc() ->
|
|||||||
[?T("This module serves small 'host-meta' files as described in "
|
[?T("This module serves small 'host-meta' files as described in "
|
||||||
"https://xmpp.org/extensions/xep-0156.html[XEP-0156: Discovering "
|
"https://xmpp.org/extensions/xep-0156.html[XEP-0156: Discovering "
|
||||||
"Alternative XMPP Connection Methods]."), "",
|
"Alternative XMPP Connection Methods]."), "",
|
||||||
?T("This module is available since ejabberd 22.05."), "",
|
|
||||||
?T("To use this module, in addition to adding it to the 'modules' "
|
?T("To use this module, in addition to adding it to the 'modules' "
|
||||||
"section, you must also enable it in 'listen' -> 'ejabberd_http' -> "
|
"section, you must also enable it in 'listen' -> 'ejabberd_http' -> "
|
||||||
"_`listen-options.md#request_handlers|request_handlers`_."), "",
|
"_`listen-options.md#request_handlers|request_handlers`_."), "",
|
||||||
?T("Notice it only works if ejabberd_http has tls enabled.")],
|
?T("Notice it only works if ejabberd_http has tls enabled.")],
|
||||||
|
note => "added in 22.05",
|
||||||
example =>
|
example =>
|
||||||
["listen:",
|
["listen:",
|
||||||
" -",
|
" -",
|
||||||
|
@ -884,8 +884,8 @@ mod_options(Host) ->
|
|||||||
|
|
||||||
mod_doc() ->
|
mod_doc() ->
|
||||||
#{desc =>
|
#{desc =>
|
||||||
[?T("https://matrix.org/[Matrix] gateway."), "",
|
[?T("https://matrix.org/[Matrix] gateway.")],
|
||||||
?T("This module is available since ejabberd 24.02.")],
|
note => "added in 24.02",
|
||||||
example =>
|
example =>
|
||||||
["listen:",
|
["listen:",
|
||||||
" -",
|
" -",
|
||||||
|
@ -102,14 +102,13 @@ mod_doc() ->
|
|||||||
[?T("This module is an experimental implementation of "
|
[?T("This module is an experimental implementation of "
|
||||||
"https://xmpp.org/extensions/xep-0369.html"
|
"https://xmpp.org/extensions/xep-0369.html"
|
||||||
"[XEP-0369: Mediated Information eXchange (MIX)]. "
|
"[XEP-0369: Mediated Information eXchange (MIX)]. "
|
||||||
"MIX support was added in ejabberd 16.03 as an "
|
"It's asserted that "
|
||||||
"experimental feature, updated in 19.02, and is not "
|
|
||||||
"yet ready to use in production. It's asserted that "
|
|
||||||
"the MIX protocol is going to replace the MUC protocol "
|
"the MIX protocol is going to replace the MUC protocol "
|
||||||
"in the future (see _`mod_muc`_)."), "",
|
"in the future (see _`mod_muc`_)."), "",
|
||||||
?T("To learn more about how to use that feature, you can refer to "
|
?T("To learn more about how to use that feature, you can refer to "
|
||||||
"our tutorial: _`../../tutorials/mix-010.md|Getting started with MIX`_"), "",
|
"our tutorial: _`../../tutorials/mix-010.md|Getting started with MIX`_"), "",
|
||||||
?T("The module depends on _`mod_mam`_.")],
|
?T("The module depends on _`mod_mam`_.")],
|
||||||
|
note => "added in 16.03 and improved in 19.02",
|
||||||
opts =>
|
opts =>
|
||||||
[{access_create,
|
[{access_create,
|
||||||
#{value => ?T("AccessName"),
|
#{value => ?T("AccessName"),
|
||||||
|
@ -120,8 +120,8 @@ mod_doc() ->
|
|||||||
"https://xmpp.org/extensions/xep-0421.html"
|
"https://xmpp.org/extensions/xep-0421.html"
|
||||||
"[XEP-0421: Anonymous unique occupant identifiers for MUCs]."), "",
|
"[XEP-0421: Anonymous unique occupant identifiers for MUCs]."), "",
|
||||||
?T("When the module is enabled, the feature is enabled "
|
?T("When the module is enabled, the feature is enabled "
|
||||||
"in all semi-anonymous rooms."), "",
|
"in all semi-anonymous rooms.")],
|
||||||
?T("This module is available since ejabberd 23.10.")]
|
note => "added in 23.10"
|
||||||
}.
|
}.
|
||||||
|
|
||||||
depends(_, _) ->
|
depends(_, _) ->
|
||||||
|
@ -264,8 +264,8 @@ mod_doc() ->
|
|||||||
#{desc =>
|
#{desc =>
|
||||||
[?T("This module implement Real-time blocklists for MUC rooms."), "",
|
[?T("This module implement Real-time blocklists for MUC rooms."), "",
|
||||||
?T("It works by observing remote pubsub node conforming with "
|
?T("It works by observing remote pubsub node conforming with "
|
||||||
"specification described in https://xmppbl.org/."), "",
|
"specification described in https://xmppbl.org/.")],
|
||||||
?T("This module is available since ejabberd 23.04.")],
|
note => "added in 23.04",
|
||||||
opts =>
|
opts =>
|
||||||
[{rtbl_server,
|
[{rtbl_server,
|
||||||
#{value => ?T("Domain"),
|
#{value => ?T("Domain"),
|
||||||
|
@ -159,8 +159,8 @@ mod_doc() ->
|
|||||||
?T("This module allows XMPP clients to discover STUN/TURN services "
|
?T("This module allows XMPP clients to discover STUN/TURN services "
|
||||||
"and to obtain temporary credentials for using them as per "
|
"and to obtain temporary credentials for using them as per "
|
||||||
"https://xmpp.org/extensions/xep-0215.html"
|
"https://xmpp.org/extensions/xep-0215.html"
|
||||||
"[XEP-0215: External Service Discovery]. "
|
"[XEP-0215: External Service Discovery]."),
|
||||||
"This module is included in ejabberd since version 20.04."),
|
note => "added in 20.04",
|
||||||
opts =>
|
opts =>
|
||||||
[{access,
|
[{access,
|
||||||
#{value => ?T("AccessName"),
|
#{value => ?T("AccessName"),
|
||||||
|
Loading…
Reference in New Issue
Block a user