25
1
mirror of https://github.com/processone/ejabberd.git synced 2024-12-20 17:27:00 +01:00

Update some modules doc to use the note field

This commit is contained in:
Badlop 2024-03-28 03:24:28 +01:00
parent b70a2fe4cf
commit 6e5895ce45
7 changed files with 12 additions and 14 deletions

View File

@ -252,8 +252,6 @@ mod_doc() ->
#{desc =>
[?T("This module serves a simple page for the "
"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' "
"section, you must also enable it in 'listen' -> 'ejabberd_http' -> "
"_`listen-options.md#request_handlers|request_handlers`_."), "",
@ -263,6 +261,7 @@ mod_doc() ->
?T("When 'conversejs_css' and 'conversejs_script' are 'auto', "
"by default they point to the public Converse client.")
],
note => "added in 21.12 and improved in 22.05",
example =>
[{?T("Manually setup WebSocket url, and use the public Converse client:"),
["listen:",

View File

@ -211,11 +211,11 @@ mod_doc() ->
[?T("This module serves small 'host-meta' files as described in "
"https://xmpp.org/extensions/xep-0156.html[XEP-0156: Discovering "
"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' "
"section, you must also enable it in 'listen' -> 'ejabberd_http' -> "
"_`listen-options.md#request_handlers|request_handlers`_."), "",
?T("Notice it only works if ejabberd_http has tls enabled.")],
note => "added in 22.05",
example =>
["listen:",
" -",

View File

@ -884,8 +884,8 @@ mod_options(Host) ->
mod_doc() ->
#{desc =>
[?T("https://matrix.org/[Matrix] gateway."), "",
?T("This module is available since ejabberd 24.02.")],
[?T("https://matrix.org/[Matrix] gateway.")],
note => "added in 24.02",
example =>
["listen:",
" -",

View File

@ -102,14 +102,13 @@ mod_doc() ->
[?T("This module is an experimental implementation of "
"https://xmpp.org/extensions/xep-0369.html"
"[XEP-0369: Mediated Information eXchange (MIX)]. "
"MIX support was added in ejabberd 16.03 as an "
"experimental feature, updated in 19.02, and is not "
"yet ready to use in production. It's asserted that "
"It's asserted that "
"the MIX protocol is going to replace the MUC protocol "
"in the future (see _`mod_muc`_)."), "",
?T("To learn more about how to use that feature, you can refer to "
"our tutorial: _`../../tutorials/mix-010.md|Getting started with MIX`_"), "",
?T("The module depends on _`mod_mam`_.")],
note => "added in 16.03 and improved in 19.02",
opts =>
[{access_create,
#{value => ?T("AccessName"),

View File

@ -120,8 +120,8 @@ mod_doc() ->
"https://xmpp.org/extensions/xep-0421.html"
"[XEP-0421: Anonymous unique occupant identifiers for MUCs]."), "",
?T("When the module is enabled, the feature is enabled "
"in all semi-anonymous rooms."), "",
?T("This module is available since ejabberd 23.10.")]
"in all semi-anonymous rooms.")],
note => "added in 23.10"
}.
depends(_, _) ->

View File

@ -264,8 +264,8 @@ mod_doc() ->
#{desc =>
[?T("This module implement Real-time blocklists for MUC rooms."), "",
?T("It works by observing remote pubsub node conforming with "
"specification described in https://xmppbl.org/."), "",
?T("This module is available since ejabberd 23.04.")],
"specification described in https://xmppbl.org/.")],
note => "added in 23.04",
opts =>
[{rtbl_server,
#{value => ?T("Domain"),

View File

@ -159,8 +159,8 @@ mod_doc() ->
?T("This module allows XMPP clients to discover STUN/TURN services "
"and to obtain temporary credentials for using them as per "
"https://xmpp.org/extensions/xep-0215.html"
"[XEP-0215: External Service Discovery]. "
"This module is included in ejabberd since version 20.04."),
"[XEP-0215: External Service Discovery]."),
note => "added in 20.04",
opts =>
[{access,
#{value => ?T("AccessName"),