aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorBadlop <badlop@process-one.net>2021-08-21 18:31:21 +0200
committerBadlop <badlop@process-one.net>2021-08-23 14:04:49 +0200
commit506e2f3b972a7e1b6d4fdd40836b9574c4937908 (patch)
tree2577288f11b50436c0b7ac9be5a5c5f926db69ef
parentImprove formatting and add sections links (diff)
Use specific syntax so modules and top-level will be links
If we use _`whatever`_ here in ejabberd man pages, it is converted to *`whatever`* in markdown, and docs.ejabberd.im/Makefile converts to the proper links
-rw-r--r--src/ejabberd_options_doc.erl142
-rw-r--r--src/mod_admin_update_sql.erl2
-rw-r--r--src/mod_announce.erl14
-rw-r--r--src/mod_avatar.erl4
-rw-r--r--src/mod_bosh.erl12
-rw-r--r--src/mod_caps.erl12
-rw-r--r--src/mod_configure.erl2
-rw-r--r--src/mod_delegation.erl2
-rw-r--r--src/mod_http_upload.erl2
-rw-r--r--src/mod_last.erl10
-rw-r--r--src/mod_mam.erl14
-rw-r--r--src/mod_mix.erl6
-rw-r--r--src/mod_mix_pam.erl10
-rw-r--r--src/mod_mqtt.erl14
-rw-r--r--src/mod_muc.erl4
-rw-r--r--src/mod_muc_admin.erl2
-rw-r--r--src/mod_muc_log.erl2
-rw-r--r--src/mod_offline.erl8
-rw-r--r--src/mod_ping.erl4
-rw-r--r--src/mod_privacy.erl12
-rw-r--r--src/mod_private.erl10
-rw-r--r--src/mod_privilege.erl2
-rw-r--r--src/mod_pubsub.erl4
-rw-r--r--src/mod_push.erl10
-rw-r--r--src/mod_push_keepalive.erl8
-rw-r--r--src/mod_roster.erl14
-rw-r--r--src/mod_shared_roster.erl14
-rw-r--r--src/mod_shared_roster_ldap.erl2
-rw-r--r--src/mod_stream_mgmt.erl6
-rw-r--r--src/mod_vcard.erl10
-rw-r--r--src/mod_vcard_ldap.erl2
-rw-r--r--src/mod_vcard_xupdate.erl12
32 files changed, 186 insertions, 186 deletions
diff --git a/src/ejabberd_options_doc.erl b/src/ejabberd_options_doc.erl
index ee1cf9add..28a6f6333 100644
--- a/src/ejabberd_options_doc.erl
+++ b/src/ejabberd_options_doc.erl
@@ -64,8 +64,8 @@ doc() ->
"erased from cache. The default value is 'one hour'. "
"Several modules have a similar option; and some core "
"ejabberd parts support similar options too, see "
- "'auth_cache_life_time', 'oauth_cache_life_time', "
- "'router_cache_life_time', and 'sm_cache_life_time'.")}},
+ "_`auth_cache_life_time`_, _`oauth_cache_life_time`_, "
+ "_`router_cache_life_time`_, and _`sm_cache_life_time`_.")}},
{cache_missed,
#{value => "true | false",
desc =>
@@ -73,12 +73,12 @@ doc() ->
"an attempt to lookup for a value in a database and "
"this value is not found and the option is set to 'true', "
"this attempt will be cached and no attempts will be "
- "performed until the cache expires (see 'cache_life_time'). "
+ "performed until the cache expires (see _`cache_life_time`_). "
"Usually you don't want to change it. Default is 'true'. "
"Several modules have a similar option; and some core "
"ejabberd parts support similar options too, see "
- "'auth_cache_missed', 'oauth_cache_missed', "
- "'router_cache_missed', and 'sm_cache_missed'.")}},
+ "_`auth_cache_missed`_, _`oauth_cache_missed`_, "
+ "_`router_cache_missed`_, and _`sm_cache_missed`_.")}},
{cache_size,
#{value => "pos_integer() | infinity",
desc =>
@@ -93,16 +93,16 @@ doc() ->
"performance. The default value is '1000'. "
"Several modules have a similar option; and some core "
"ejabberd parts support similar options too, see "
- "'auth_cache_size', 'oauth_cache_size', "
- "'router_cache_size', and 'sm_cache_size'.")}},
+ "_`auth_cache_size`_, _`oauth_cache_size`_, "
+ "_`router_cache_size`_, and _`sm_cache_size`_.")}},
{use_cache,
#{value => "true | false",
desc =>
?T("Enable or disable cache. The default is 'true'. "
"Several modules have a similar option; and some core "
"ejabberd parts support similar options too, see "
- "'auth_use_cache', 'oauth_use_cache', 'router_use_cache', "
- "and 'sm_use_cache'.")}},
+ "_`auth_use_cache`_, _`oauth_use_cache`_, _`router_use_cache`_, "
+ "and _`sm_use_cache`_.")}},
{default_db,
#{value => "mnesia | sql",
desc =>
@@ -122,14 +122,14 @@ doc() ->
"Modules may have its own value of the option. "
"The value of 'ram' means that queues will be kept in memory. "
"If value 'file' is set, you may also specify directory "
- "in 'queue_dir' option where file queues will be placed. "
+ "in _`queue_dir`_ option where file queues will be placed. "
"The default value is 'ram'.")}},
{version,
#{value => "string()",
desc =>
?T("The option can be used to set custom ejabberd version, "
"that will be used by different parts of ejabberd, for "
- "example by 'mod_version' module. The default value is "
+ "example by _`mod_version`_ module. The default value is "
"obtained at compile time from the underlying version "
"control system.")}},
{acl,
@@ -141,7 +141,7 @@ doc() ->
"has name 'ACLName': it can be any string except 'all' or 'none' "
"(those are predefined names for the rules that match all or nothing "
"respectively). The name 'ACLName' can be referenced from other "
- "parts of the configuration file, for example in 'access_rules' "
+ "parts of the configuration file, for example in _`access_rules`_ "
"option. The rules of 'ACLName' are represented by mapping "
"'pass:[{ACLType: ACLValue}]'. These can be one of the following:")},
[{user,
@@ -225,7 +225,7 @@ doc() ->
"of the configuration file (mostly from 'access' options of "
"ejabberd modules). Each rule definition may contain "
"arbitrary number of 'allow' or 'deny' sections, and each "
- "section may contain any number of ACL rules (see 'acl' option). "
+ "section may contain any number of ACL rules (see _`acl`_ option). "
"There are no access rules defined by default."),
example =>
["access_rules:",
@@ -336,18 +336,18 @@ doc() ->
{auth_cache_life_time,
#{value => "timeout()",
desc =>
- ?T("Same as 'cache_life_time', but applied to authentication cache "
- "only. If not set, the value from 'cache_life_time' will be used.")}},
+ ?T("Same as _`cache_life_time`_, but applied to authentication cache "
+ "only. If not set, the value from _`cache_life_time`_ will be used.")}},
{auth_cache_missed,
#{value => "true | false",
desc =>
- ?T("Same as 'cache_missed', but applied to authentication cache "
- "only. If not set, the value from 'cache_missed' will be used.")}},
+ ?T("Same as _`cache_missed`_, but applied to authentication cache "
+ "only. If not set, the value from _`cache_missed`_ will be used.")}},
{auth_cache_size,
#{value => "pos_integer() | infinity",
desc =>
- ?T("Same as 'cache_size', but applied to authentication cache "
- "only. If not set, the value from 'cache_size' will be used.")}},
+ ?T("Same as _`cache_size`_, but applied to authentication cache "
+ "only. If not set, the value from _`cache_size`_ will be used.")}},
{auth_method,
#{value => "[mnesia | sql | anonymous | external | jwt | ldap | pam, ...]",
desc =>
@@ -393,8 +393,8 @@ doc() ->
{auth_use_cache,
#{value => "true | false",
desc =>
- ?T("Same as 'use_cache', but applied to authentication cache "
- "only. If not set, the value from 'use_cache' will be used.")}},
+ ?T("Same as _`use_cache`_, but applied to authentication cache "
+ "only. If not set, the value from _`use_cache`_ will be used.")}},
{c2s_cafile,
#{value => ?T("Path"),
desc =>
@@ -464,7 +464,7 @@ doc() ->
"from CAPTCHA DoS. The default value is 'infinity'.")}},
{captcha_host,
#{value => "String",
- desc => ?T("Deprecated. Use 'captcha_url' instead.")}},
+ desc => ?T("Deprecated. Use _`captcha_url`_ instead.")}},
{captcha_url,
#{value => ?T("URL"),
desc =>
@@ -688,7 +688,7 @@ doc() ->
#{value => "[Host, ...]",
desc =>
?T("A list of IP addresses or DNS names of LDAP backup servers. "
- "When no servers listed in 'ldap_servers' option are reachable, "
+ "When no servers listed in _`ldap_servers`_ option are reachable, "
"ejabberd will try to connect to these backup servers. "
"The default is an empty list, i.e. no backup servers specified. "
"WARNING: ejabberd doesn't try to reconnect back to the main "
@@ -795,7 +795,7 @@ doc() ->
"the result set. There is no default value, which means the "
"result is not filtered. WARNING: Since this filter makes "
"additional LDAP lookups, use it only as the last resort: "
- "try to define all filter rules in 'ldap_filter' option if possible."),
+ "try to define all filter rules in _`ldap_filter`_ option if possible."),
example =>
["ldap_dn_filter:",
" \"(&(name=%s)(owner=%D)(user=%u@%d))\": [sn]"]}},
@@ -866,13 +866,13 @@ doc() ->
{oauth_cache_life_time,
#{value => "timeout()",
desc =>
- ?T("Same as 'cache_life_time', but applied to OAuth cache "
- "only. If not set, the value from 'cache_life_time' will be used.")}},
+ ?T("Same as _`cache_life_time`_, but applied to OAuth cache "
+ "only. If not set, the value from _`cache_life_time`_ will be used.")}},
{oauth_cache_missed,
#{value => "true | false",
desc =>
- ?T("Same as 'cache_missed', but applied to OAuth cache "
- "only. If not set, the value from 'cache_missed' will be used.")}},
+ ?T("Same as _`cache_missed`_, but applied to OAuth cache "
+ "only. If not set, the value from _`cache_missed`_ will be used.")}},
{oauth_cache_rest_failure_life_time,
#{value => "timeout()",
note => "added in 21.01",
@@ -882,8 +882,8 @@ doc() ->
{oauth_cache_size,
#{value => "pos_integer() | infinity",
desc =>
- ?T("Same as 'cache_size', but applied to OAuth cache "
- "only. If not set, the value from 'cache_size' will be used.")}},
+ ?T("Same as _`cache_size`_, but applied to OAuth cache "
+ "only. If not set, the value from _`cache_size`_ will be used.")}},
{oauth_client_id_check,
#{value => "allow | db | deny",
desc =>
@@ -893,13 +893,13 @@ doc() ->
{oauth_use_cache,
#{value => "true | false",
desc =>
- ?T("Same as 'use_cache', but applied to OAuth cache "
- "only. If not set, the value from 'use_cache' will be used.")}},
+ ?T("Same as _`use_cache`_, but applied to OAuth cache "
+ "only. If not set, the value from _`use_cache`_ will be used.")}},
{oauth_db_type,
#{value => "mnesia | sql",
desc =>
?T("Database backend to use for OAuth authentication. "
- "The default value is picked from 'default_db' option, or "
+ "The default value is picked from _`default_db`_ option, or "
"if it's not set, 'mnesia' will be used.")}},
{oauth_expire,
#{value => "timeout()",
@@ -913,7 +913,7 @@ doc() ->
desc =>
?T("Enable or disable OOM (out-of-memory) killer. "
"When system memory raises above the limit defined in "
- "'oom_watermark' option, ejabberd triggers OOM killer "
+ "_`oom_watermark`_ option, ejabberd triggers OOM killer "
"to terminate most memory consuming Erlang processes. "
"Note that in order to maintain functionality, ejabberd only "
"attempts to kill transient processes, such as those managing "
@@ -924,14 +924,14 @@ doc() ->
desc =>
?T("Trigger OOM killer when some of the running Erlang processes "
"have messages queue above this 'Size'. Note that "
- "such processes won't be killed if 'oom_killer' option is set "
+ "such processes won't be killed if _`oom_killer`_ option is set "
"to 'false' or if 'oom_watermark' is not reached yet.")}},
{oom_watermark,
#{value => ?T("Percent"),
desc =>
?T("A percent of total system memory consumed at which "
"OOM killer should be activated with some of the processes "
- "possibly be killed (see 'oom_killer' option). Later, when "
+ "possibly be killed (see _`oom_killer`_ option). Later, when "
"memory drops below this 'Percent', OOM killer is deactivated. "
"The default value is '80' percents.")}},
{outgoing_s2s_families,
@@ -984,7 +984,7 @@ doc() ->
{queue_dir,
#{value => ?T("Directory"),
desc =>
- ?T("If 'queue_type' option is set to 'file', use this 'Directory' "
+ ?T("If _`queue_type`_ option is set to 'file', use this 'Directory' "
"to store file queues. The default is to keep queues inside "
"Mnesia directory.")}},
{redis_connect_timeout,
@@ -1014,8 +1014,8 @@ doc() ->
#{value => "ram | file",
desc =>
?T("The type of request queue for the Redis server. "
- "See description of 'queue_type' option for the explanation. "
- "The default value is the value defined in 'queue_type' "
+ "See description of _`queue_type`_ option for the explanation. "
+ "The default value is the value defined in _`queue_type`_ "
"or 'ram' if the latter is not set.")}},
{redis_server,
#{value => ?T("Hostname"),
@@ -1025,7 +1025,7 @@ doc() ->
{registration_timeout,
#{value => "timeout()",
desc =>
- ?T("This is a global option for module 'mod_register'. "
+ ?T("This is a global option for module _`mod_register`_. "
"It limits the frequency of registrations from a given "
"IP or username. So, a user that tries to register a "
"new account from the same IP address or JID during "
@@ -1048,29 +1048,29 @@ doc() ->
{router_cache_life_time,
#{value => "timeout()",
desc =>
- ?T("Same as 'cache_life_time', but applied to routing table cache "
- "only. If not set, the value from 'cache_life_time' will be used.")}},
+ ?T("Same as _`cache_life_time`_, but applied to routing table cache "
+ "only. If not set, the value from _`cache_life_time`_ will be used.")}},
{router_cache_missed,
#{value => "true | false",
desc =>
- ?T("Same as 'cache_missed', but applied to routing table cache "
- "only. If not set, the value from 'cache_missed' will be used.")}},
+ ?T("Same as _`cache_missed`_, but applied to routing table cache "
+ "only. If not set, the value from _`cache_missed`_ will be used.")}},
{router_cache_size,
#{value => "pos_integer() | infinity",
desc =>
- ?T("Same as 'cache_size', but applied to routing table cache "
- "only. If not set, the value from 'cache_size' will be used.")}},
+ ?T("Same as _`cache_size`_, but applied to routing table cache "
+ "only. If not set, the value from _`cache_size`_ will be used.")}},
{router_db_type,
#{value => "mnesia | redis | sql",
desc =>
?T("Database backend to use for routing information. "
- "The default value is picked from 'default_ram_db' option, or "
+ "The default value is picked from _`default_ram_db`_ option, or "
"if it's not set, 'mnesia' will be used.")}},
{router_use_cache,
#{value => "true | false",
desc =>
- ?T("Same as 'use_cache', but applied to routing table cache "
- "only. If not set, the value from 'use_cache' will be used.")}},
+ ?T("Same as _`use_cache`_, but applied to routing table cache "
+ "only. If not set, the value from _`use_cache`_ will be used.")}},
{rpc_timeout,
#{value => "timeout()",
desc =>
@@ -1147,8 +1147,8 @@ doc() ->
#{value => "ram | file",
desc =>
?T("The type of a queue for s2s packets. "
- "See description of 'queue_type' option for the explanation. "
- "The default value is the value defined in 'queue_type' "
+ "See description of _`queue_type`_ option for the explanation. "
+ "The default value is the value defined in _`queue_type`_ "
"or 'ram' if the latter is not set.")}},
{s2s_timeout,
#{value => "timeout()",
@@ -1176,7 +1176,7 @@ doc() ->
desc =>
?T("The option defines a set of shapers. Every shaper is assigned "
"a name 'ShaperName' that can be used in other parts of the "
- "configuration file, such as 'shaper_rules' option. The shaper "
+ "configuration file, such as _`shaper_rules`_ option. The shaper "
"itself is defined by its 'Rate', where 'Rate' stands for the "
"maximum allowed incoming rate in **bytes** per second. "
"When a connection exceeds this limit, ejabberd stops reading "
@@ -1192,9 +1192,9 @@ doc() ->
#{value => "{ShaperRuleName: {Number|ShaperName: ACLRule|ACLName}}",
desc =>
?T("An entry allowing to declaring shaper to use for matching user/hosts. "
- "Semantics is similar to 'access_rules' option, the only difference is "
+ "Semantics is similar to _`access_rules`_ option, the only difference is "
"that instead using 'allow' or 'deny', a name of a shaper (defined in "
- "'shaper' option) or a positive number should be used."),
+ "_`shaper`_ option) or a positive number should be used."),
example =>
["shaper_rules:",
" connections_limit:",
@@ -1210,29 +1210,29 @@ doc() ->
{sm_cache_life_time,
#{value => "timeout()",
desc =>
- ?T("Same as 'cache_life_time', but applied to client sessions table cache "
- "only. If not set, the value from 'cache_life_time' will be used.")}},
+ ?T("Same as _`cache_life_time`_, but applied to client sessions table cache "
+ "only. If not set, the value from _`cache_life_time`_ will be used.")}},
{sm_cache_missed,
#{value => "true | false",
desc =>
- ?T("Same as 'cache_missed', but applied to client sessions table cache "
- "only. If not set, the value from 'cache_missed' will be used.")}},
+ ?T("Same as _`cache_missed`_, but applied to client sessions table cache "
+ "only. If not set, the value from _`cache_missed`_ will be used.")}},
{sm_cache_size,
#{value => "pos_integer() | infinity",
desc =>
- ?T("Same as 'cache_size', but applied to client sessions table cache "
- "only. If not set, the value from 'cache_size' will be used.")}},
+ ?T("Same as _`cache_size`_, but applied to client sessions table cache "
+ "only. If not set, the value from _`cache_size`_ will be used.")}},
{sm_db_type,
#{value => "mnesia | redis | sql",
desc =>
?T("Database backend to use for client sessions information. "
- "The default value is picked from 'default_ram_db' option, or "
+ "The default value is picked from _`default_ram_db`_ option, or "
"if it's not set, 'mnesia' will be used.")}},
{sm_use_cache,
#{value => "true | false",
desc =>
- ?T("Same as 'use_cache', but applied to client sessions table cache "
- "only. If not set, the value from 'use_cache' will be used.")}},
+ ?T("Same as _`use_cache`_, but applied to client sessions table cache "
+ "only. If not set, the value from _`use_cache`_ will be used.")}},
{sql_type,
#{value => "mssql | mysql | odbc | pgsql | sqlite",
desc =>
@@ -1258,7 +1258,7 @@ doc() ->
note => "added in 20.12",
desc =>
?T("Path to the ODBC driver to use to connect to a Microsoft SQL "
- "Server database. This option is only valid if the 'sql_type' "
+ "Server database. This option is only valid if the _`sql_type`_ "
"option is set to 'mssql'. "
"The default value is: 'libtdsodbc.so'")}},
{sql_password,
@@ -1293,8 +1293,8 @@ doc() ->
#{value => "ram | file",
desc =>
?T("The type of a request queue for the SQL server. "
- "See description of 'queue_type' option for the explanation. "
- "The default value is the value defined in 'queue_type' "
+ "See description of _`queue_type`_ option for the explanation. "
+ "The default value is the value defined in _`queue_type`_ "
"or 'ram' if the latter is not set.")}},
{sql_server,
#{value => ?T("Host"),
@@ -1312,15 +1312,15 @@ doc() ->
#{value => ?T("Path"),
desc =>
?T("A path to a file with CA root certificates that will "
- "be used to verify SQL connections. Implies 'sql_ssl' "
- "and 'sql_ssl_verify' options are set to 'true'. "
+ "be used to verify SQL connections. Implies _`sql_ssl`_ "
+ "and _`sql_ssl_verify`_ options are set to 'true'. "
"There is no default which means "
"certificate verification is disabled.")}},
{sql_ssl_certfile,
#{value => ?T("Path"),
desc =>
?T("A path to a certificate file that will be used "
- "for SSL connections to the SQL server. Implies 'sql_ssl' "
+ "for SSL connections to the SQL server. Implies _`sql_ssl`_ "
"option is set to 'true'. There is no default which means "
"ejabberd won't provide a client certificate to the SQL "
"server.")}},
@@ -1328,8 +1328,8 @@ doc() ->
#{value => "true | false",
desc =>
?T("Whether to verify SSL connection to the SQL server against "
- "CA root certificates defined in 'sql_ssl_cafile' option. "
- "Implies 'sql_ssl' option is set to 'true'. "
+ "CA root certificates defined in _`sql_ssl_cafile`_ option. "
+ "Implies _`sql_ssl`_ option is set to 'true'. "
"The default value is 'false'.")}},
{sql_start_interval,
#{value => "timeout()",
diff --git a/src/mod_admin_update_sql.erl b/src/mod_admin_update_sql.erl
index c87849748..4e932fe83 100644
--- a/src/mod_admin_update_sql.erl
+++ b/src/mod_admin_update_sql.erl
@@ -366,4 +366,4 @@ mod_doc() ->
"from the default to the new schema. Check the section "
"http://../database/#default-and-new-schemas[Default and New Schemas] for details. "
"Please note that only PostgreSQL is supported. "
- "When the module is loaded use 'update_sql' ejabberdctl command.")}.
+ "When the module is loaded use _`update_sql`_ API.")}.
diff --git a/src/mod_announce.erl b/src/mod_announce.erl
index e0501d96b..21213615c 100644
--- a/src/mod_announce.erl
+++ b/src/mod_announce.erl
@@ -930,7 +930,7 @@ mod_doc() ->
"should be disabled for instances of ejabberd with hundreds of "
"thousands users."), "",
?T("The Ad-hoc Commands are listed in the Server Discovery. "
- "For this feature to work, 'mod_adhoc' must be enabled."), "",
+ "For this feature to work, _`mod_adhoc`_ must be enabled."), "",
?T("The specific JIDs where messages can be sent are listed below. "
"The first JID in each entry will apply only to the specified "
"virtual host example.org, while the JID between brackets "
@@ -940,7 +940,7 @@ mod_doc() ->
"online and connected to several resources, only the resource "
"with the highest priority will receive the message. "
"If the registered user is not connected, the message will be "
- "stored offline in assumption that offline storage (see 'mod_offline') "
+ "stored offline in assumption that offline storage (see _`mod_offline`_) "
"is enabled."),
"- example.org/announce/online (example.org/announce/all-hosts/online)::",
?T("The message is sent to all connected users. If the user is "
@@ -965,20 +965,20 @@ mod_doc() ->
{db_type,
#{value => "mnesia | sql",
desc =>
- ?T("Same as top-level 'default_db' option, but applied to this module only.")}},
+ ?T("Same as top-level _`default_db`_ option, but applied to this module only.")}},
{use_cache,
#{value => "true | false",
desc =>
- ?T("Same as top-level 'use_cache' option, but applied to this module only.")}},
+ ?T("Same as top-level _`use_cache`_ option, but applied to this module only.")}},
{cache_size,
#{value => "pos_integer() | infinity",
desc =>
- ?T("Same as top-level 'cache_size' option, but applied to this module only.")}},
+ ?T("Same as top-level _`cache_size`_ option, but applied to this module only.")}},
{cache_missed,
#{value => "true | false",
desc =>
- ?T("Same as top-level 'cache_missed' option, but applied to this module only.")}},
+ ?T("Same as top-level _`cache_missed`_ option, but applied to this module only.")}},
{cache_life_time,
#{value => "timeout()",
desc =>
- ?T("Same as top-level 'cache_life_time' option, but applied to this module only.")}}]}.
+ ?T("Same as top-level _`cache_life_time`_ option, but applied to this module only.")}}]}.
diff --git a/src/mod_avatar.erl b/src/mod_avatar.erl
index 3ad55f6d0..09329853d 100644
--- a/src/mod_avatar.erl
+++ b/src/mod_avatar.erl
@@ -469,8 +469,8 @@ mod_doc() ->
"[XEP-0398: User Avatar to vCard-Based Avatars Conversion]."), "",
?T("Also, the module supports conversion between avatar "
"image formats on the fly."), "",
- ?T("The module depends on 'mod_vcard', 'mod_vcard_xupdate' and "
- "'mod_pubsub'.")],
+ ?T("The module depends on _`mod_vcard`_, _`mod_vcard_xupdate`_ and "
+ "_`mod_pubsub`_.")],
opts =>
[{convert,
#{value => "{From: To}",
diff --git a/src/mod_bosh.erl b/src/mod_bosh.erl
index 1770d27a7..37a7fa809 100644
--- a/src/mod_bosh.erl
+++ b/src/mod_bosh.erl
@@ -240,27 +240,27 @@ mod_doc() ->
{queue_type,
#{value => "ram | file",
desc =>
- ?T("Same as top-level 'queue_type' option, but applied to this module only.")}},
+ ?T("Same as top-level _`queue_type`_ option, but applied to this module only.")}},
{ram_db_type,
#{value => "mnesia | sql | redis",
desc =>
- ?T("Same as 'default_ram_db' but applied to this module only.")}},
+ ?T("Same as _`default_ram_db`_ but applied to this module only.")}},
{use_cache,
#{value => "true | false",
desc =>
- ?T("Same as top-level 'use_cache' option, but applied to this module only.")}},
+ ?T("Same as top-level _`use_cache`_ option, but applied to this module only.")}},
{cache_size,
#{value => "pos_integer() | infinity",
desc =>
- ?T("Same as top-level 'cache_size' option, but applied to this module only.")}},
+ ?T("Same as top-level _`cache_size`_ option, but applied to this module only.")}},
{cache_missed,
#{value => "true | false",
desc =>
- ?T("Same as top-level 'cache_missed' option, but applied to this module only.")}},
+ ?T("Same as top-level _`cache_missed`_ option, but applied to this module only.")}},
{cache_life_time,
#{value => "timeout()",
desc =>
- ?T("Same as top-level 'cache_life_time' option, but applied to this module only.")}}],
+ ?T("Same as top-level _`cache_life_time`_ option, but applied to this module only.")}}],
example =>
["listen:",
" -",
diff --git a/src/mod_caps.erl b/src/mod_caps.erl
index 92869fc7d..c8f548169 100644
--- a/src/mod_caps.erl
+++ b/src/mod_caps.erl
@@ -595,25 +595,25 @@ mod_doc() ->
"https://xmpp.org/extensions/xep-0115.html"
"[XEP-0115: Entity Capabilities]."),
?T("The main purpose of the module is to provide "
- "PEP functionality (see 'mod_pubsub').")],
+ "PEP functionality (see _`mod_pubsub`_).")],
opts =>
[{db_type,
#{value => "mnesia | sql",
desc =>
- ?T("Same as top-level 'default_db' option, but applied to this module only.")}},
+ ?T("Same as top-level _`default_db`_ option, but applied to this module only.")}},
{use_cache,
#{value => "true | false",
desc =>
- ?T("Same as top-level 'use_cache' option, but applied to this module only.")}},
+ ?T("Same as top-level _`use_cache`_ option, but applied to this module only.")}},
{cache_size,
#{value => "pos_integer() | infinity",
desc =>
- ?T("Same as top-level 'cache_size' option, but applied to this module only.")}},
+ ?T("Same as top-level _`cache_size`_ option, but applied to this module only.")}},
{cache_missed,
#{value => "true | false",
desc =>
- ?T("Same as top-level 'cache_missed' option, but applied to this module only.")}},
+ ?T("Same as top-level _`cache_missed`_ option, but applied to this module only.")}},
{cache_life_time,
#{value => "timeout()",
desc =>
- ?T("Same as top-level 'cache_life_time' option, but applied to this module only.")}}]}.
+ ?T("Same as top-level _`cache_life_time`_ option, but applied to this module only.")}}]}.
diff --git a/src/mod_configure.erl b/src/mod_configure.erl
index 99a20ef3a..32c7ebb31 100644
--- a/src/mod_configure.erl
+++ b/src/mod_configure.erl
@@ -1564,4 +1564,4 @@ mod_doc() ->
?T("The module provides server configuration functionality via "
"https://xmpp.org/extensions/xep-0050.html"
"[XEP-0050: Ad-Hoc Commands]. This module requires "
- "'mod_adhoc' to be loaded.")}.
+ "_`mod_adhoc`_ to be loaded.")}.
diff --git a/src/mod_delegation.erl b/src/mod_delegation.erl
index a588e81ef..3ae3b8a51 100644
--- a/src/mod_delegation.erl
+++ b/src/mod_delegation.erl
@@ -95,7 +95,7 @@ mod_doc() ->
?T("WARNING: Security issue: Namespace delegation gives components "
"access to sensitive data, so permission should be granted "
"carefully, only if you trust the component."), "",
- ?T("NOTE: This module is complementary to 'mod_privilege' but can "
+ ?T("NOTE: This module is complementary to _`mod_privilege`_ but can "
"also be used separately.")],
opts =>
[{namespaces,
diff --git a/src/mod_http_upload.erl b/src/mod_http_upload.erl
index 040cb6085..3303f17c0 100644
--- a/src/mod_http_upload.erl
+++ b/src/mod_http_upload.erl
@@ -331,7 +331,7 @@ mod_doc() ->
"replaced with the virtual host name. NOTE: if GET requests "
"are handled by 'mod_http_upload', the 'get_url' must match the "
"'put_url'. Setting it to a different value only makes "
- "sense if an external web server or 'mod_http_fileserver' "
+ "sense if an external web server or _`mod_http_fileserver`_ "
"is used to serve the uploaded files.")}},
{service_url,
#{desc => ?T("Deprecated.")}},
diff --git a/src/mod_last.erl b/src/mod_last.erl
index 295a546f2..a7d36c791 100644
--- a/src/mod_last.erl
+++ b/src/mod_last.erl
@@ -344,20 +344,20 @@ mod_doc() ->
[{db_type,
#{value => "mnesia | sql",
desc =>
- ?T("Same as top-level 'default_db' option, but applied to this module only.")}},
+ ?T("Same as top-level _`default_db`_ option, but applied to this module only.")}},
{use_cache,
#{value => "true | false",
desc =>
- ?T("Same as top-level 'use_cache' option, but applied to this module only.")}},
+ ?T("Same as top-level _`use_cache`_ option, but applied to this module only.")}},
{cache_size,
#{value => "pos_integer() | infinity",
desc =>
- ?T("Same as top-level 'cache_size' option, but applied to this module only.")}},
+ ?T("Same as top-level _`cache_size`_ option, but applied to this module only.")}},
{cache_missed,
#{value => "true | false",
desc =>
- ?T("Same as top-level 'cache_missed' option, but applied to this module only.")}},
+ ?T("Same as top-level _`cache_missed`_ option, but applied to this module only.")}},
{cache_life_time,
#{value => "timeout()",
desc =>
- ?T("Same as top-level 'cache_life_time' option, but applied to this module only.")}}]}.
+ ?T("Same as top-level _`cache_life_time`_ option, but applied to this module only.")}}]}.
diff --git a/src/mod_mam.erl b/src/mod_mam.erl
index e894f5f7d..abb2333cc 100644
--- a/src/mod_mam.erl
+++ b/src/mod_mam.erl
@@ -1456,7 +1456,7 @@ mod_doc() ->
#{value => "true | false",
desc =>
?T("This option determines how ejabberd's "
- "stream management code (see 'mod_stream_mgmt') "
+ "stream management code (see _`mod_stream_mgmt`_) "
"handles unacknowledged messages when the "
"connection is lost. Usually, such messages are "
"either bounced or resent. However, neither is "
@@ -1495,28 +1495,28 @@ mod_doc() ->
#{value => "true | false",
desc =>
?T("Whether to destroy message archive of a room "
- "(see 'mod_muc') when it gets destroyed. "
+ "(see _`mod_muc`_) when it gets destroyed. "
"The default value is 'true'.")}},
{db_type,
#{value => "mnesia | sql",
desc =>
- ?T("Same as top-level 'default_db' option, but applied to this module only.")}},
+ ?T("Same as top-level _`default_db`_ option, but applied to this module only.")}},
{use_cache,
#{value => "true | false",
desc =>
- ?T("Same as top-level 'use_cache' option, but applied to this module only.")}},
+ ?T("Same as top-level _`use_cache`_ option, but applied to this module only.")}},
{cache_size,
#{value => "pos_integer() | infinity",
desc =>
- ?T("Same as top-level 'cache_size' option, but applied to this module only.")}},
+ ?T("Same as top-level _`cache_size`_ option, but applied to this module only.")}},
{cache_missed,
#{value => "true | false",
desc =>
- ?T("Same as top-level 'cache_missed' option, but applied to this module only.")}},
+ ?T("Same as top-level _`cache_missed`_ option, but applied to this module only.")}},
{cache_life_time,
#{value => "timeout()",
desc =>
- ?T("Same as top-level 'cache_life_time' option, but applied to this module only.")}},
+ ?T("Same as top-level _`cache_life_time`_ option, but applied to this module only.")}},
{user_mucsub_from_muc_archive,
#{value => "true | false",
desc =>
diff --git a/src/mod_mix.erl b/src/mod_mix.erl
index 82b5e41a4..002ef5696 100644
--- a/src/mod_mix.erl
+++ b/src/mod_mix.erl
@@ -106,12 +106,12 @@ mod_doc() ->
"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 "
- "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 "
"our tutorial: https://docs.ejabberd.im/tutorials/mix-010/"
"[Getting started with XEP-0369: Mediated Information "
"eXchange (MIX) v0.1]."), "",
- ?T("The module depends on 'mod_mam'.")],
+ ?T("The module depends on _`mod_mam`_.")],
opts =>
[{access_create,
#{value => ?T("AccessName"),
@@ -136,7 +136,7 @@ mod_doc() ->
{db_type,
#{value => "mnesia | sql",
desc =>
- ?T("Same as top-level 'default_db' option, but applied to this module only.")}}]}.
+ ?T("Same as top-level _`default_db`_ option, but applied to this module only.")}}]}.
-spec route(stanza()) -> ok.
route(#iq{} = IQ) ->
diff --git a/src/mod_mix_pam.erl b/src/mod_mix_pam.erl
index c6348b92f..1fa5c1861 100644
--- a/src/mod_mix_pam.erl
+++ b/src/mod_mix_pam.erl
@@ -120,23 +120,23 @@ mod_doc() ->
[{db_type,
#{value => "mnesia | sql",
desc =>
- ?T("Same as top-level 'default_db' option, but applied to this module only.")}},
+ ?T("Same as top-level _`default_db`_ option, but applied to this module only.")}},
{use_cache,
#{value => "true | false",
desc =>
- ?T("Same as top-level 'use_cache' option, but applied to this module only.")}},
+ ?T("Same as top-level _`use_cache`_ option, but applied to this module only.")}},
{cache_size,
#{value => "pos_integer() | infinity",
desc =>
- ?T("Same as top-level 'cache_size' option, but applied to this module only.")}},
+ ?T("Same as top-level _`cache_size`_ option, but applied to this module only.")}},
{cache_missed,
#{value => "true | false",
desc =>
- ?T("Same as top-level 'cache_missed' option, but applied to this module only.")}},
+ ?T("Same as top-level _`cache_missed`_ option, but applied to this module only.")}},
{cache_life_time,
#{value => "timeout()",
desc =>
- ?T("Same as top-level 'cache_life_time' option, but applied to this module only.")}}]}.
+ ?T("Same as top-level _`cache_life_time`_ option, but applied to this module only.")}}]}.
-spec bounce_sm_packet({term(), stanza()}) -> {term(), stanza()}.
bounce_sm_packet({_, #message{to = #jid{lresource = <<>>} = To,
diff --git a/src/mod_mqtt.erl b/src/mod_mqtt.erl
index a1621cc01..5d00408df 100644
--- a/src/mod_mqtt.erl
+++ b/src/mod_mqtt.erl
@@ -327,37 +327,37 @@ mod_doc() ->
{queue_type,
#{value => "ram | file",
desc =>
- ?T("Same as top-level 'queue_type' option, "
+ ?T("Same as top-level _`queue_type`_ option, "
"but applied to this module only.")}},
{ram_db_type,
#{value => "mnesia",
desc =>
- ?T("Same as top-level 'default_ram_db' option, "
+ ?T("Same as top-level _`default_ram_db`_ option, "
"but applied to this module only.")}},
{db_type,
#{value => "mnesia | sql",
desc =>
- ?T("Same as top-level 'default_db' option, "
+ ?T("Same as top-level _`default_db`_ option, "
"but applied to this module only.")}},
{use_cache,
#{value => "true | false",
desc =>
- ?T("Same as top-level 'use_cache' option, "
+ ?T("Same as top-level _`use_cache`_ option, "
"but applied to this module only.")}},
{cache_size,
#{value => "pos_integer() | infinity",
desc =>
- ?T("Same as top-level 'cache_size' option, "
+ ?T("Same as top-level _`cache_size`_ option, "
"but applied to this module only.")}},
{cache_missed,
#{value => "true | false",
desc =>
- ?T("Same as top-level 'cache_missed' option, "
+ ?T("Same as top-level _`cache_missed`_ option, "
"but applied to this module only.")}},
{cache_life_time,
#{value => "timeout()",
desc =>
- ?T("Same as top-level 'cache_life_time' option, "
+ ?T("Same as top-level _`cache_life_time`_ option, "
"but applied to this module only.")}}]}.
%%%===================================================================
diff --git a/src/mod_muc.erl b/src/mod_muc.erl
index 46bfd20e5..ccecb6b66 100644
--- a/src/mod_muc.erl
+++ b/src/mod_muc.erl
@@ -1517,7 +1517,7 @@ mod_doc() ->
{queue_type,
#{value => "ram | file",
desc =>
- ?T("Same as top-level 'queue_type' option, but applied to this module only.")}},
+ ?T("Same as top-level _`queue_type`_ option, but applied to this module only.")}},
{regexp_room_id,
#{value => "string()",
desc =>
@@ -1634,7 +1634,7 @@ mod_doc() ->
{logging,
#{value => "true | false",
desc =>
- ?T("The public messages are logged using 'mod_muc_log'. "
+ ?T("The public messages are logged using _`mod_muc_log`_. "
"The default value is 'false'.")}},
{members_by_default,
#{value => "true | false",
diff --git a/src/mod_muc_admin.erl b/src/mod_muc_admin.erl
index 360d414b1..2abeee45c 100644
--- a/src/mod_muc_admin.erl
+++ b/src/mod_muc_admin.erl
@@ -1413,4 +1413,4 @@ mod_doc() ->
[?T("This module provides commands to administer local MUC "
"services and their MUC rooms. It also provides simple "
"WebAdmin pages to view the existing rooms."), "",
- ?T("This module depends on 'mod_muc'.")]}.
+ ?T("This module depends on _`mod_muc`_.")]}.
diff --git a/src/mod_muc_log.erl b/src/mod_muc_log.erl
index 53223a8eb..8bcbc8bc0 100644
--- a/src/mod_muc_log.erl
+++ b/src/mod_muc_log.erl
@@ -1021,7 +1021,7 @@ mod_doc() ->
?T("- URLs on messages and subjects are converted to hyperlinks."), "",
?T("- Timezone used on timestamps is shown on the log files."), "",
?T("- A custom link can be added on top of each page."), "",
- ?T("The module depends on 'mod_muc'.")],
+ ?T("The module depends on _`mod_muc`_.")],
opts =>
[{access_log,
#{value => ?T("AccessName"),
diff --git a/src/mod_offline.erl b/src/mod_offline.erl
index ff95767b6..1d367eb72 100644
--- a/src/mod_offline.erl
+++ b/src/mod_offline.erl
@@ -1325,19 +1325,19 @@ mod_doc() ->
{db_type,
#{value => "mnesia | sql",
desc =>
- ?T("Same as top-level 'default_db' option, but applied to this module only.")}},
+ ?T("Same as top-level _`default_db`_ option, but applied to this module only.")}},
{use_cache,
#{value => "true | false",
desc =>
- ?T("Same as top-level 'use_cache' option, but applied to this module only.")}},
+ ?T("Same as top-level _`use_cache`_ option, but applied to this module only.")}},
{cache_size,
#{value => "pos_integer() | infinity",
desc =>
- ?T("Same as top-level 'cache_size' option, but applied to this module only.")}},
+ ?T("Same as top-level _`cache_size`_ option, but applied to this module only.")}},
{cache_life_time,
#{value => "timeout()",
desc =>
- ?T("Same as top-level 'cache_life_time' option, but applied to this module only.")}}],
+ ?T("Same as top-level _`cache_life_time`_ option, but applied to this module only.")}}],
example =>
[{?T("This example allows power users to have as much as 5000 "
"offline messages, administrators up to 2000, and all the "
diff --git a/src/mod_ping.erl b/src/mod_ping.erl
index 483f2e834..eee55825e 100644
--- a/src/mod_ping.erl
+++ b/src/mod_ping.erl
@@ -317,8 +317,8 @@ mod_doc() ->
"server ping request in less than period defined "
"in 'ping_ack_timeout' option: "
"'kill' means destroying the underlying connection, "
- "'none' means to do nothing. NOTE: when 'mod_stream_mgmt' "
- "module is loaded and stream management is enabled by "
+ "'none' means to do nothing. NOTE: when _`mod_stream_mgmt`_ "
+ "is loaded and stream management is enabled by "
"a client, killing the client connection doesn't mean "
"killing the client session - the session will be kept "
"alive in order to give the client a chance to resume it. "
diff --git a/src/mod_privacy.erl b/src/mod_privacy.erl
index 4f15b80c4..5ac26c2f5 100644
--- a/src/mod_privacy.erl
+++ b/src/mod_privacy.erl
@@ -887,25 +887,25 @@ mod_doc() ->
"https://xmpp.org/extensions/xep-0191.html"
"[XEP-0191: Blocking Command] which is implemented by "
"'mod_blocking' module. However, you still need "
- "'mod_privacy' loaded in order for 'mod_blocking' to work.")],
+ "'mod_privacy' loaded in order for _`mod_blocking`_ to work.")],
opts =>
[{db_type,
#{value => "mnesia | sql",
desc =>
- ?T("Same as top-level 'default_db' option, but applied to this module only.")}},
+ ?T("Same as top-level _`default_db`_ option, but applied to this module only.")}},
{use_cache,
#{value => "true | false",
desc =>
- ?T("Same as top-level 'use_cache' option, but applied to this module only.")}},
+ ?T("Same as top-level _`use_cache`_ option, but applied to this module only.")}},
{cache_size,
#{value => "pos_integer() | infinity",
desc =>
- ?T("Same as top-level 'cache_size' option, but applied to this module only.")}},
+ ?T("Same as top-level _`cache_size`_ option, but applied to this module only.")}},
{cache_missed,
#{value => "true | false",
desc =>
- ?T("Same as top-level 'cache_missed' option, but applied to this module only.")}},
+ ?T("Same as top-level _`cache_missed`_ option, but applied to this module only.")}},
{cache_life_time,
#{value => "timeout()",
desc =>
- ?T("Same as top-level 'cache_life_time' option, but applied to this module only.")}}]}.
+ ?T("Same as top-level _`cache_life_time`_ option, but applied to this module only.")}}]}.
diff --git a/src/mod_private.erl b/src/mod_private.erl
index 36f1e8d2c..436aae222 100644
--- a/src/mod_private.erl
+++ b/src/mod_private.erl
@@ -128,23 +128,23 @@ mod_doc() ->
[{db_type,
#{value => "mnesia | sql",
desc =>
- ?T("Same as top-level 'default_db' option, but applied to this module only.")}},
+ ?T("Same as top-level _`default_db`_ option, but applied to this module only.")}},
{use_cache,
#{value => "true | false",
desc =>
- ?T("Same as top-level 'use_cache' option, but applied to this module only.")}},
+ ?T("Same as top-level _`use_cache`_ option, but applied to this module only.")}},
{cache_size,
#{value => "pos_integer() | infinity",
desc =>
- ?T("Same as top-level 'cache_size' option, but applied to this module only.")}},
+ ?T("Same as top-level _`cache_size`_ option, but applied to this module only.")}},
{cache_missed,
#{value => "true | false",
desc =>
- ?T("Same as top-level 'cache_missed' option, but applied to this module only.")}},
+ ?T("Same as top-level _`cache_missed`_ option, but applied to this module only.")}},
{cache_life_time,
#{value => "timeout()",
desc =>
- ?T("Same as top-level 'cache_life_time' option, but applied to this module only.")}}]}.
+ ?T("Same as top-level _`cache_life_time`_ option, but applied to this module only.")}}]}.
-spec get_sm_features({error, stanza_error()} | empty | {result, [binary()]},
jid(), jid(), binary(), binary()) ->
diff --git a/src/mod_privilege.erl b/src/mod_privilege.erl
index a6d4ba446..353a8da27 100644
--- a/src/mod_privilege.erl
+++ b/src/mod_privilege.erl
@@ -106,7 +106,7 @@ mod_doc() ->
?T("WARNING: Security issue: Privileged access gives components "
"access to sensitive data, so permission should be granted "
"carefully, only if you trust a component."), "",
- ?T("NOTE: This module is complementary to 'mod_delegation', "
+ ?T("NOTE: This module is complementary to _`mod_delegation`_, "
"but can also be used separately.")],
opts =>
[{roster,
diff --git a/src/mod_pubsub.erl b/src/mod_pubsub.erl
index 8792b2ab9..2e40d8f0e 100644
--- a/src/mod_pubsub.erl
+++ b/src/mod_pubsub.erl
@@ -4269,7 +4269,7 @@ mod_doc() ->
"(https://xmpp.org/extensions/xep-0163.html"
"[XEP-0163: Personal Eventing via Pubsub]) "
"is enabled in the default ejabberd configuration file, "
- "and it requires 'mod_caps'.")],
+ "and it requires _`mod_caps`_.")],
opts =>
[{access_createnode,
#{value => "AccessName",
@@ -4282,7 +4282,7 @@ mod_doc() ->
{db_type,
#{value => "mnesia | sql",
desc =>
- ?T("Same as top-level 'default_db' option, but applied to "
+ ?T("Same as top-level _`default_db`_ option, but applied to "
"this module only.")}},
{default_node_config,
#{value => "List of Key:Value",
diff --git a/src/mod_push.erl b/src/mod_push.erl
index ea1c3e649..5477c5792 100644
--- a/src/mod_push.erl
+++ b/src/mod_push.erl
@@ -191,23 +191,23 @@ mod_doc() ->
{db_type,
#{value => "mnesia | sql",
desc =>
- ?T("Same as top-level 'default_db' option, but applied to this module only.")}},
+ ?T("Same as top-level _`default_db`_ option, but applied to this module only.")}},
{use_cache,
#{value => "true | false",
desc =>
- ?T("Same as top-level 'use_cache' option, but applied to this module only.")}},
+ ?T("Same as top-level _`use_cache`_ option, but applied to this module only.")}},
{cache_size,
#{value => "pos_integer() | infinity",
desc =>
- ?T("Same as top-level 'cache_size' option, but applied to this module only.")}},
+ ?T("Same as top-level _`cache_size`_ option, but applied to this module only.")}},
{cache_missed,
#{value => "true | false",
desc =>
- ?T("Same as top-level 'cache_missed' option, but applied to this module only.")}},
+ ?T("Same as top-level _`cache_missed`_ option, but applied to this module only.")}},
{cache_life_time,
#{value => "timeout()",
desc =>
- ?T("Same as top-level 'cache_life_time' option, but applied to this module only.")}}]}.
+ ?T("Same as top-level _`cache_life_time`_ option, but applied to this module only.")}}]}.
%%--------------------------------------------------------------------
%% ejabberd command callback.
diff --git a/src/mod_push_keepalive.erl b/src/mod_push_keepalive.erl
index aba4fbfae..e0e83f1e1 100644
--- a/src/mod_push_keepalive.erl
+++ b/src/mod_push_keepalive.erl
@@ -94,13 +94,13 @@ mod_options(_Host) ->
mod_doc() ->
#{desc =>
[?T("This module tries to keep the stream management "
- "session (see 'mod_stream_mgmt') of a disconnected "
+ "session (see _`mod_stream_mgmt`_) of a disconnected "
"mobile client alive if the client enabled push "
"notifications for that session. However, the normal "
"session resumption timeout is restored once a push "
"notification is issued, so the session will be closed "
"if the client doesn't respond to push notifications."), "",
- ?T("The module depends on 'mod_push'.")],
+ ?T("The module depends on _`mod_push`_.")],
opts =>
[{resume_timeout,
#{value => "timeout()",
@@ -109,8 +109,8 @@ mod_doc() ->
"the session of a disconnected push client times out. "
"This timeout is only in effect as long as no push "
"notification is issued. Once that happened, the "
- "resumption timeout configured for the 'mod_stream_mgmt' "
- "module is restored. "
+ "resumption timeout configured for _`mod_stream_mgmt`_ "
+ "is restored. "
"The default value is '72' hours.")}},
{wake_on_start,
#{value => "true | false",
diff --git a/src/mod_roster.erl b/src/mod_roster.erl
index f204c9211..94cae4950 100644
--- a/src/mod_roster.erl
+++ b/src/mod_roster.erl
@@ -1345,29 +1345,29 @@ mod_doc() ->
"This option does not affect the client in any way. "
"This option is only useful if option 'versioning' is "
"set to 'true'. The default value is 'false'. "
- "IMPORTANT: if you use 'mod_shared_roster' or "
- "'mod_shared_roster_ldap', you must set the value "
+ "IMPORTANT: if you use _`mod_shared_roster`_ or "
+ " _`mod_shared_roster_ldap`_, you must set the value "
"of the option to 'false'.")}},
{db_type,
#{value => "mnesia | sql",
desc =>
- ?T("Same as top-level 'default_db' option, but applied to this module only.")}},
+ ?T("Same as top-level _`default_db`_ option, but applied to this module only.")}},
{use_cache,
#{value => "true | false",
desc =>
- ?T("Same as top-level 'use_cache' option, but applied to this module only.")}},
+ ?T("Same as top-level _`use_cache`_ option, but applied to this module only.")}},
{cache_size,
#{value => "pos_integer() | infinity",
desc =>
- ?T("Same as top-level 'cache_size' option, but applied to this module only.")}},
+ ?T("Same as top-level _`cache_size`_ option, but applied to this module only.")}},
{cache_missed,
#{value => "true | false",
desc =>
- ?T("Same as top-level 'cache_missed' option, but applied to this module only.")}},
+ ?T("Same as top-level _`cache_missed`_ option, but applied to this module only.")}},
{cache_life_time,
#{value => "timeout()",
desc =>
- ?T("Same as top-level 'cache_life_time' option, but applied to this module only.")}}],
+ ?T("Same as top-level _`cache_life_time`_ option, but applied to this module only.")}}],
example =>
["modules:",
" ...",
diff --git a/src/mod_shared_roster.erl b/src/mod_shared_roster.erl
index 16cc96a75..13ff90466 100644
--- a/src/mod_shared_roster.erl
+++ b/src/mod_shared_roster.erl
@@ -1266,7 +1266,7 @@ mod_doc() ->
?T("- Displayed: A list of groups that will be in the "
"rosters of this group's members. A group of other vhost can "
"be identified with 'groupid@vhost'."), "",
- ?T("This module depends on 'mod_roster'. "
+ ?T("This module depends on _`mod_roster`_. "
"If not enabled, roster queries will return 503 errors.")],
opts =>
[{db_type,
@@ -1274,25 +1274,25 @@ mod_doc() ->
desc =>
?T("Define the type of storage where the module will create "
"the tables and store user information. The default is "
- "the storage defined by the global option 'default_db', "
+ "the storage defined by the top-level _`default_db`_ option, "
"or 'mnesia' if omitted. If 'sql' value is defined, "
"make sure you have defined the database.")}},
- {use_cache,
+ {use_cache,
#{value => "true | false",
desc =>
- ?T("Same as top-level 'use_cache' option, but applied to this module only.")}},
+ ?T("Same as top-level _`use_cache`_ option, but applied to this module only.")}},
{cache_size,
#{value => "pos_integer() | infinity",
desc =>
- ?T("Same as top-level 'cache_size' option, but applied to this module only.")}},
+ ?T("Same as top-level _`cache_size`_ option, but applied to this module only.")}},
{cache_missed,
#{value => "true | false",
desc =>
- ?T("Same as top-level 'cache_missed' option, but applied to this module only.")}},
+ ?T("Same as top-level _`cache_missed`_ option, but applied to this module only.")}},
{cache_life_time,
#{value => "timeout()",
desc =>
- ?T("Same as top-level 'cache_life_time' option, but applied to this module only.")}}],
+ ?T("Same as top-level _`cache_life_time`_ option, but applied to this module only.")}}],
example =>
[{?T("Take the case of a computer club that wants all its members "
"seeing each other in their rosters. To achieve this, they "
diff --git a/src/mod_shared_roster_ldap.erl b/src/mod_shared_roster_ldap.erl
index 93c08e0c3..08fbe8793 100644
--- a/src/mod_shared_roster_ldap.erl
+++ b/src/mod_shared_roster_ldap.erl
@@ -796,7 +796,7 @@ mod_doc() ->
"disable the check. Default value is 'true'.")}}] ++
[{Opt,
#{desc =>
- {?T("Same as top-level '~s' option, but "
+ {?T("Same as top-level _`~s`_ option, but "
"applied to this module only."), [Opt]}}}
|| Opt <- [ldap_backups, ldap_base, ldap_uids, ldap_deref_aliases,
ldap_encrypt, ldap_password, ldap_port, ldap_rootdn,
diff --git a/src/mod_stream_mgmt.erl b/src/mod_stream_mgmt.erl
index b9443e5d2..5d2998500 100644
--- a/src/mod_stream_mgmt.erl
+++ b/src/mod_stream_mgmt.erl
@@ -962,12 +962,12 @@ mod_doc() ->
{queue_type,
#{value => "ram | file",
desc =>
- ?T("Same as top-level 'queue_type' option, but applied to this module only.")}},
+ ?T("Same as top-level _`queue_type`_ option, but applied to this module only.")}},
{cache_size,
#{value => "pos_integer() | infinity",
desc =>
- ?T("Same as top-level 'cache_size' option, but applied to this module only.")}},
+ ?T("Same as top-level _`cache_size`_ option, but applied to this module only.")}},
{cache_life_time,
#{value => "timeout()",
desc =>
- ?T("Same as top-level 'cache_life_time' option, but applied to this module only.")}}]}.
+ ?T("Same as top-level _`cache_life_time`_ option, but applied to this module only.")}}]}.
diff --git a/src/mod_vcard.erl b/src/mod_vcard.erl
index e7cfff819..8e0d32a4a 100644
--- a/src/mod_vcard.erl
+++ b/src/mod_vcard.erl
@@ -640,23 +640,23 @@ mod_doc() ->
{db_type,
#{value => "mnesia | sql | ldap",
desc =>
- ?T("Same as top-level 'default_db' option, but applied to this module only.")}},
+ ?T("Same as top-level _`default_db`_ option, but applied to this module only.")}},
{use_cache,
#{value => "true | false",
desc =>
- ?T("Same as top-level 'use_cache' option, but applied to this module only.")}},
+ ?T("Same as top-level _`use_cache`_ option, but applied to this module only.")}},
{cache_size,
#{value => "pos_integer() | infinity",
desc =>
- ?T("Same as top-level 'cache_size' option, but applied to this module only.")}},
+ ?T("Same as top-level _`cache_size`_ option, but applied to this module only.")}},
{cache_missed,
#{value => "true | false",
desc =>
- ?T("Same as top-level 'cache_missed' option, but applied to this module only.")}},
+ ?T("Same as top-level _`cache_missed`_ option, but applied to this module only.")}},
{cache_life_time,
#{value => "timeout()",
desc =>
- ?T("Same as top-level 'cache_life_time' option, but applied to this module only.")}},
+ ?T("Same as top-level _`cache_life_time`_ option, but applied to this module only.")}},
{vcard,
#{value => ?T("vCard"),
desc =>
diff --git a/src/mod_vcard_ldap.erl b/src/mod_vcard_ldap.erl
index c81c058f5..bc6e7ebca 100644
--- a/src/mod_vcard_ldap.erl
+++ b/src/mod_vcard_ldap.erl
@@ -571,7 +571,7 @@ mod_doc() ->
}]}}] ++
[{Opt,
#{desc =>
- {?T("Same as top-level '~s' option, but "
+ {?T("Same as top-level _`~s`_ option, but "
"applied to this module only."), [Opt]}}}
|| Opt <- [ldap_base, ldap_servers, ldap_uids,
ldap_deref_aliases, ldap_encrypt, ldap_password,
diff --git a/src/mod_vcard_xupdate.erl b/src/mod_vcard_xupdate.erl
index ab8df2c60..59ebc7f71 100644
--- a/src/mod_vcard_xupdate.erl
+++ b/src/mod_vcard_xupdate.erl
@@ -228,26 +228,26 @@ mod_doc() ->
"frequently their presence. However, the overhead is significantly "
"reduced by the use of caching, so you probably don't want "
"to set 'use_cache' to 'false'."), "",
- ?T("The module depends on 'mod_vcard'."), "",
+ ?T("The module depends on _`mod_vcard`_."), "",
?T("NOTE: Nowadays https://xmpp.org/extensions/xep-0153.html"
"[XEP-0153] is used mostly as \"read-only\", i.e. modern "
"clients don't publish their avatars inside vCards. Thus "
"in the majority of cases the module is only used along "
- "with 'mod_avatar' module for providing backward compatibility.")],
+ "with _`mod_avatar`_ for providing backward compatibility.")],
opts =>
[{use_cache,
#{value => "true | false",
desc =>
- ?T("Same as top-level 'use_cache' option, but applied to this module only.")}},
+ ?T("Same as top-level _`use_cache`_ option, but applied to this module only.")}},
{cache_size,
#{value => "pos_integer() | infinity",
desc =>
- ?T("Same as top-level 'cache_size' option, but applied to this module only.")}},
+ ?T("Same as top-level _`cache_size`_ option, but applied to this module only.")}},
{cache_missed,
#{value => "true | false",
desc =>
- ?T("Same as top-level 'cache_missed' option, but applied to this module only.")}},
+ ?T("Same as top-level _`cache_missed`_ option, but applied to this module only.")}},
{cache_life_time,
#{value => "timeout()",
desc =>
- ?T("Same as top-level 'cache_life_time' option, but applied to this module only.")}}]}.
+ ?T("Same as top-level _`cache_life_time`_ option, but applied to this module only.")}}]}.