Document message_escape option

Also add a configuration example for the Telegram service.
This commit is contained in:
Rainer Müller 2018-03-28 11:53:00 +02:00
parent 11f0eb672e
commit 8291d4ee92
2 changed files with 17 additions and 0 deletions

View File

@ -311,6 +311,16 @@ to something similar to "http://domain/#channel/2011-03-09 14:25:09", or
When using Nexmo, this value is where the SMS is "from". In most cases, you must use a valid number in international format. When using Nexmo, this value is where the SMS is "from". In most cases, you must use a valid number in international format.
* `message_escape` Default: ` `
If set, keyword values will be escaped in this format before they are expanded in
`message_content`. Possible values are all that ZNC supports, most useful here will be
`HTML` or `URL`.
Note that the resulting string in `message_content` after keyword expansion will not be
escaped. If you need to escape characters for a service, you have to set the escaped
string to `message_content`.
* `message_uri` Default: ` ` * `message_uri` Default: ` `
URI that will be sent with the push notification. This could be a web address or a URI that will be sent with the push notification. This could be a web address or a

View File

@ -16,5 +16,12 @@ module by following the above steps.
* set secret to the **api key**: <code>/msg *push set secret your-api-key</code> * set secret to the **api key**: <code>/msg *push set secret your-api-key</code>
* set target to chat ID: <code>/msg *push set target your-chat-id</code> * set target to chat ID: <code>/msg *push set target your-chat-id</code>
You can style your messages with [basic HTML][HTML] when you set the
`message_escape` option accordingly.
set message_escape HTML
set message_content <i>{context}</i>: &lt;<b>{nick}</b>&gt; {message}
[Telegram]: https://telegram.org [Telegram]: https://telegram.org
[BotFather]: https://core.telegram.org/bots#6-botfather [BotFather]: https://core.telegram.org/bots#6-botfather
[HTML]: https://core.telegram.org/bots/api#formatting-options