diff options
author | Sébastien Helleu <flashcode@flashtux.org> | 2023-05-05 20:38:38 +0200 |
---|---|---|
committer | Sébastien Helleu <flashcode@flashtux.org> | 2023-05-14 15:32:39 +0200 |
commit | 176a10677137e887ed5e8299669bacbc4148d65a (patch) | |
tree | fd27d7d932c80eb3bec59a17ccbc9bd3a15a0eed /doc/en | |
parent | e8b5d73421f63e6e792c039e7a86754db8cfa78c (diff) | |
download | weechat-176a10677137e887ed5e8299669bacbc4148d65a.zip |
irc: add support of capability "draft/multiline" (closes #1923)
Diffstat (limited to 'doc/en')
-rw-r--r-- | doc/en/weechat_user.en.adoc | 54 |
1 files changed, 54 insertions, 0 deletions
diff --git a/doc/en/weechat_user.en.adoc b/doc/en/weechat_user.en.adoc index e6b96feaa..825dfabfd 100644 --- a/doc/en/weechat_user.en.adoc +++ b/doc/en/weechat_user.en.adoc @@ -3408,6 +3408,7 @@ WeeChat supports the following https://ircv3.net/irc/[IRCv3 extensions ^↗^,wi * <<irc_ircv3_batch,batch>> * <<irc_ircv3_cap_notify,cap-notify>> * <<irc_ircv3_chghost,chghost>> +* <<irc_ircv3_draft/multiline,draft/multiline>> * <<irc_ircv3_extended_join,extended-join>> * <<irc_ircv3_invite_notify,invite-notify>> * <<irc_ircv3_message_tags,message-tags>> @@ -3535,6 +3536,59 @@ Example: -- alice (user@example.com) has changed host to test.com .... +[[irc_ircv3_draft_multiline]] +===== draft/multiline + +Specification: https://ircv3.net/specs/extensions/multiline[multiline ^↗^,window=_blank] + +This capability allows the client and server to send messages with multiple lines, +using the <<irc_ircv3_batch,batch>> capability, that must be enabled as well. + +There are limits in term of bytes or number of lines in a multiline message +that are given in the capability sent by the server, for example: + +.... +CAP alice LS * :draft/multiline=max-bytes=4096,max-lines=24 +.... + +This sets a limit of 4096 bytes and 24 lines for a multiline batched content. + +If the limits are not given by the server, the default in WeeChat are: + +* max bytes: 4096 +* max lines: 24 + +Only standard messages and those send by the <<command_irc_notice,/notice>> +command can be multiline. + +ACTION CTCP messages sent with command <<command_irc_me,/me>> are not affected +by this capability. That means multiline actions are sent as multiple actions. + +[WARNING] +As the specification is a "draft", it may change and the multiline support can +possibly break at any time in WeeChat. + +The capability is automatically enabled if the server supports it and can be +disabled with this command: +`/set irc.server_default.capabilities "*,!draft/multiline"`. + +When the capability is disabled, a multiline message is sent as multiple messages, +as if they were sent sequentially to the server. + +Example of IRC messages sent for a user message with two lines (`this is a test` +/ `on two lines`), send to channel #test: + +.... +BATCH +i8Je7M7gquddoyC9 draft/multiline #test +@batch=i8Je7M7gquddoyC9 PRIVMSG #test :this is a test +@batch=i8Je7M7gquddoyC9 PRIVMSG #test :on two lines +BATCH -i8Je7M7gquddoyC9 +.... + +Display of the message sent in WeeChat: + +.... +19:01:45 alice | this is a test + | on two lines +.... + [[irc_ircv3_extended_join]] ===== extended-join |