25
1
mirror of https://github.com/processone/ejabberd.git synced 2024-11-24 16:23:40 +01:00

Use shorthands provided by docs.ejabberd.im Makefile, fix markdown syntax

This commit is contained in:
Badlop 2024-03-07 01:09:53 +01:00
parent f5c8406353
commit 2c1b0bb77b
4 changed files with 13 additions and 14 deletions

View File

@ -300,7 +300,7 @@ get_commands_spec() ->
#ejabberd_commands{name = import_prosody, tags = [mnesia, sql], #ejabberd_commands{name = import_prosody, tags = [mnesia, sql],
desc = "Import data from Prosody", desc = "Import data from Prosody",
longdesc = "Note: this requires ejabberd to be " longdesc = "Note: this requires ejabberd to be "
"[compiled with `--enable-lua`](http://localhost:8098/admin/installation/#configure) " "compiled with `./configure --enable-lua` "
"(which installs the `luerl` library).", "(which installs the `luerl` library).",
module = prosody2ejabberd, function = from_dir, module = prosody2ejabberd, function = from_dir,
args_desc = ["Full path to the Prosody data directory"], args_desc = ["Full path to the Prosody data directory"],
@ -371,7 +371,7 @@ get_commands_spec() ->
longdesc = "Configure the modules to use SQL, then call this command. " longdesc = "Configure the modules to use SQL, then call this command. "
"After correctly exported the database of a vhost, " "After correctly exported the database of a vhost, "
"you may want to delete from mnesia with " "you may want to delete from mnesia with "
"the http://./#delete-mnesia[delete_mnesia] command.", "the _`delete_mnesia`_ API.",
module = ejd2sql, function = export, module = ejd2sql, function = export,
args_desc = ["Vhost", "Full path to the destination SQL file"], args_desc = ["Vhost", "Full path to the destination SQL file"],
args_example = ["example.com", "/var/lib/ejabberd/example.com.sql"], args_example = ["example.com", "/var/lib/ejabberd/example.com.sql"],
@ -407,7 +407,7 @@ get_commands_spec() ->
"binary backup file the internal Mnesia " "binary backup file the internal Mnesia "
"database. This will consume a lot of memory if " "database. This will consume a lot of memory if "
"you have a large database, you may prefer " "you have a large database, you may prefer "
"http://./#install-fallback[install_fallback].", "_`install_fallback`_ API.",
module = ?MODULE, function = restore_mnesia, module = ?MODULE, function = restore_mnesia,
args_desc = ["Full path to the backup file"], args_desc = ["Full path to the backup file"],
args_example = ["/var/lib/ejabberd/database.backup"], args_example = ["/var/lib/ejabberd/database.backup"],
@ -430,8 +430,8 @@ get_commands_spec() ->
"recommended for big databases, as it will " "recommended for big databases, as it will "
"consume much time, memory and processor. In " "consume much time, memory and processor. In "
"that case it's preferable to use " "that case it's preferable to use "
"http://./#backup[backup] and " "_`backup`_ API and "
"http://./#install-fallback[install_fallback].", "_`install_fallback`_ API.",
module = ?MODULE, function = load_mnesia, module = ?MODULE, function = load_mnesia,
args_desc = ["Full path to the text file"], args_desc = ["Full path to the text file"],
args_example = ["/var/lib/ejabberd/database.txt"], args_example = ["/var/lib/ejabberd/database.txt"],
@ -454,7 +454,7 @@ get_commands_spec() ->
"start. This means that, after running this " "start. This means that, after running this "
"command, you have to restart ejabberd. This " "command, you have to restart ejabberd. This "
"command requires less memory than " "command requires less memory than "
"http://./#restore[restore].", "_`restore`_ API.",
module = ?MODULE, function = install_fallback_mnesia, module = ?MODULE, function = install_fallback_mnesia,
args_desc = ["Full path to the fallback file"], args_desc = ["Full path to the fallback file"],
args_example = ["/var/lib/ejabberd/database.fallback"], args_example = ["/var/lib/ejabberd/database.fallback"],

View File

@ -417,7 +417,7 @@ doc() ->
"one of these root CA certificates and should contain the " "one of these root CA certificates and should contain the "
"corresponding JID(s) in 'subjectAltName' field. " "corresponding JID(s) in 'subjectAltName' field. "
"There is no default value."), "", "There is no default value."), "",
?T("You can use http://../toplevel/#host-config[host_config] to specify this option per-vhost."), "", ?T("You can use _`host_config`_ to specify this option per-vhost."), "",
?T("To set a specific file per listener, use the listener's http://../listen-options/#cafile[cafile] option. Please notice that 'c2s_cafile' overrides the listener's 'cafile' option."), "" ?T("To set a specific file per listener, use the listener's http://../listen-options/#cafile[cafile] option. Please notice that 'c2s_cafile' overrides the listener's 'cafile' option."), ""
]}}, ]}},
{c2s_ciphers, {c2s_ciphers,
@ -462,7 +462,7 @@ doc() ->
desc => desc =>
[?T("Path to a file of CA root certificates. " [?T("Path to a file of CA root certificates. "
"The default is to use system defined file if possible."), "", "The default is to use system defined file if possible."), "",
?T("For server connections, this 'ca_file' option is overridden by the http://../toplevel/#s2s-cafile[s2s_cafile] option."), "" ?T("For server connections, this 'ca_file' option is overridden by the _`s2s_cafile`_ option."), ""
]}}, ]}},
{captcha_cmd, {captcha_cmd,
#{value => ?T("Path | ModuleName"), #{value => ?T("Path | ModuleName"),
@ -1164,8 +1164,8 @@ doc() ->
desc => desc =>
[?T("A path to a file with CA root certificates that will " [?T("A path to a file with CA root certificates that will "
"be used to authenticate s2s connections. If not set, " "be used to authenticate s2s connections. If not set, "
"the value of http://../toplevel/#ca-file[ca_file] will be used."), "", "the value of _`ca_file`_ will be used."), "",
?T("You can use http://../toplevel/#host-config[host_config] to specify this option per-vhost."), "" ?T("You can use _`host_config`_ to specify this option per-vhost."), ""
]}}, ]}},
{s2s_ciphers, {s2s_ciphers,
#{value => "[Cipher, ...]", #{value => "[Cipher, ...]",

View File

@ -802,7 +802,7 @@ get_commands_spec() ->
#ejabberd_commands{name = send_stanza_c2s, tags = [stanza], #ejabberd_commands{name = send_stanza_c2s, tags = [stanza],
desc = "Send a stanza from an existing C2S session", desc = "Send a stanza from an existing C2S session",
longdesc = "`user`@`host`/`resource` must be an existing C2S session." longdesc = "`user`@`host`/`resource` must be an existing C2S session."
" As an alternative, use http://./#send-stanza[send_stanza] instead.", " As an alternative, use _`send_stanza`_ API instead.",
module = ?MODULE, function = send_stanza_c2s, module = ?MODULE, function = send_stanza_c2s,
args = [{user, binary}, {host, binary}, {resource, binary}, {stanza, binary}], args = [{user, binary}, {host, binary}, {resource, binary}, {stanza, binary}],
args_example = [<<"admin">>, <<"myserver.com">>, <<"bot">>, args_example = [<<"admin">>, <<"myserver.com">>, <<"bot">>,
@ -1730,7 +1730,7 @@ mod_doc() ->
?T("- 'pushroster': (and 'pushroster-all')"), ?T("- 'pushroster': (and 'pushroster-all')"),
?T("The roster file must be placed, if using Windows, on the " ?T("The roster file must be placed, if using Windows, on the "
"directory where you installed ejabberd: " "directory where you installed ejabberd: "
"C:/Program Files/ejabberd or similar. If you use other " "`C:/Program Files/ejabberd` or similar. If you use other "
"Operating System, place the file on the same directory where " "Operating System, place the file on the same directory where "
"the .beam files are installed. See below an example roster file."), "the .beam files are installed. See below an example roster file."),
?T("- 'srg-create':"), ?T("- 'srg-create':"),

View File

@ -127,8 +127,7 @@ mod_doc() ->
"[XEP-0048: Bookmarks])."), "", "[XEP-0048: Bookmarks])."), "",
?T("It also implements the bookmark conversion described in " ?T("It also implements the bookmark conversion described in "
"https://xmpp.org/extensions/xep-0402.html[XEP-0402: PEP Native Bookmarks]" "https://xmpp.org/extensions/xep-0402.html[XEP-0402: PEP Native Bookmarks]"
", see the command " ", see the command _`bookmarks_to_pep`_ API.")],
"https://docs.ejabberd.im/developer/ejabberd-api/admin-api/#bookmarks-to-pep[bookmarks_to_pep].")],
opts => opts =>
[{db_type, [{db_type,
#{value => "mnesia | sql", #{value => "mnesia | sql",