yetangitu/ejabberd
1
0
Fork 0
mirror of https://github.com/processone/ejabberd synced 2025-10-03 09:49:18 +02:00
Code Issues Releases Wiki Activity

Docs: Fix markdown of some toplevel options

Browse source
This commit is contained in:
Badlop 2025-02-04 13:09:14 +01:00
parent 480e2442ee
commit 07b102bb80
1 changed files with 11 additions and 11 deletions
Download patch file Download diff file Expand all files Collapse all files

22
src/ejabberd_options_doc.erl
View file

@ -472,8 +472,8 @@ doc() ->
note => "improved in 23.01",
desc =>
?T("Full path to a script that generates _`basic.md#captcha|CAPTCHA`_ images. "
"'@VERSION@' is replaced with ejabberd version number in 'XX.YY' format. "
"'@SEMVER@' is replaced with ejabberd version number in semver format "
"The keyword '@VERSION@' is replaced with ejabberd version number in 'XX.YY' format. "
"The keyword '@SEMVER@' is replaced with ejabberd version number in semver format "
"when compiled with Elixir's mix, or XX.YY format otherwise. "
"Alternatively, it can be the name of a module that implements ejabberd CAPTCHA support. "
"There is no default value: when this option is not "
@ -845,18 +845,18 @@ doc() ->
"as alternatives for getting the JID, where 'Attr' is "
"an LDAP attribute which holds the user's part of the JID and "
"'AttrFormat' must contain one and only one pattern variable "
"\"%u\" which will be replaced by the user's part of the JID. "
"For example, \"%u@example.org\". If the value is in the form "
"of '[Attr]' then 'AttrFormat' is assumed to be \"%u\".")}},
"'\"%u\"' which will be replaced by the user's part of the JID. "
"For example, '\"%u@example.org\"'. If the value is in the form "
"of '[Attr]' then 'AttrFormat' is assumed to be '\"%u\"'.")}},
{ldap_filter,
#{value => ?T("Filter"),
desc =>
?T("An LDAP filter as defined in "
"https://tools.ietf.org/html/rfc4515[RFC4515]. "
"There is no default value. Example: "
"\"(&(objectClass=shadowAccount)(memberOf=XMPP Users))\". "
"'\"(&(objectClass=shadowAccount)(memberOf=XMPP Users))\"'. "
"NOTE: don't forget to close brackets and don't use superfluous "
"whitespaces. Also you must not use \"uid\" attribute in the "
"whitespaces. Also you must not use '\"uid\"' attribute in the "
"filter because this attribute will be appended to the filter "
"automatically.")}},
{ldap_dn_filter,
@ -866,11 +866,11 @@ doc() ->
"filter. The filter performs an additional LDAP lookup to make "
"the complete result. This is useful when you are unable to "
"define all filter rules in 'ldap_filter'. You can define "
"\"%u\", \"%d\", \"%s\" and \"%D\" pattern variables in 'Filter': "
"\"%u\" is replaced by a user's part of the JID, \"%d\" is "
"replaced by the corresponding domain (virtual host), all \"%s\" "
"'\"%u\"', '\"%d\"', '\"%s\"' and '\"%D\"' pattern variables in 'Filter: "
"\"%u\"' is replaced by a user's part of the JID, '\"%d\"' is "
"replaced by the corresponding domain (virtual host), all '\"%s\"' "
"variables are consecutively replaced by values from the attributes "
"in 'FilterAttrs' and \"%D\" is replaced by Distinguished Name from "
"in 'FilterAttrs' and '\"%D\"' is replaced by Distinguished Name from "
"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: "