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

Docs: Document define_keyword and simplify define_macro

Browse source
This commit is contained in:
Badlop 2025-02-05 19:52:49 +01:00
parent c8abff33c1
commit 352ee3a318
1 changed files with 19 additions and 11 deletions
Download patch file Download diff file Expand all files Collapse all files

30
src/ejabberd_options_doc.erl
View file

@ -534,18 +534,26 @@ doc() ->
?T("A list of Erlang nodes to connect on ejabberd startup. " ?T("A list of Erlang nodes to connect on ejabberd startup. "
"This option is mostly intended for ejabberd customization " "This option is mostly intended for ejabberd customization "
"and sophisticated setups. The default value is an empty list.")}}, "and sophisticated setups. The default value is an empty list.")}},
{define_macro, {define_keyword,
#{value => "{MacroName: MacroValue}", #{value => "{NAME: Value}",
desc => desc =>
?T("Defines a " ?T("Allows to define configuration "
"_`../configuration/file-format.md#macros-in-configuration-file|macro`_. " "_`../configuration/file-format.md#keywords|keywords`_. "),
"The value can be any valid arbitrary " example =>
"YAML value. For convenience, it's recommended to define " ["define_keyword:",
"a 'MacroName' in capital letters. Duplicated macros are not allowed. " " SQL_USERNAME: \"eja.global\"",
"Macros are processed after additional configuration files have " "",
"been included, so it is possible to use macros that are defined " "host_config:",
"in configuration files included before the usage. " " localhost:",
"It is possible to use a 'MacroValue' in the definition of another macro."), " define_keyword:",
" SQL_USERNAME: \"eja.localhost\"",
"",
"sql_username: \"prefix.@SQL_USERNAME@\""]}},
{define_macro,
#{value => "{NAME: Value}",
desc =>
?T("Allows to define configuration "
"_`../configuration/file-format.md#macros|macros`_. "),
example => example =>
["define_macro:", ["define_macro:",
" DEBUG: debug", " DEBUG: debug",