doc: add chapter on typing extension in user's guide

2 files changed, 145 insertions, 0 deletions

diff --git a/doc/it/includes/autogen_user_options.it.adoc b/doc/it/includes/autogen_user_options.it.adoc
index 9c9beea50..b16a84092 100644
--- a/doc/it/includes/autogen_user_options.it.adoc
+++ b/doc/it/includes/autogen_user_options.it.adoc
@@ -1845,6 +1845,38 @@
 ** valore predefinito: `+"${weechat_runtime_dir}/weechat_fifo_${info:pid}"+`
 // end::fifo_options[]
 
+// tag::typing_options[]
+* [[option_typing.look.delay_purge_paused]] *typing.look.delay_purge_paused*
+** descrizione: pass:none[number of seconds after paused status has been set: if reached, the typing status is removed]
+** tipo: intero
+** valori: 1 .. 3600
+** valore predefinito: `+30+`
+
+* [[option_typing.look.delay_purge_typing]] *typing.look.delay_purge_typing*
+** descrizione: pass:none[number of seconds after typing status has been set: if reached, the typing status is removed]
+** tipo: intero
+** valori: 1 .. 3600
+** valore predefinito: `+6+`
+
+* [[option_typing.look.delay_set_paused]] *typing.look.delay_set_paused*
+** descrizione: pass:none[number of seconds after typing last char: if reached, the typing status becomes "paused" and no more typing signals are sent]
+** tipo: intero
+** valori: 1 .. 3600
+** valore predefinito: `+10+`
+
+* [[option_typing.look.enabled_nicks]] *typing.look.enabled_nicks*
+** descrizione: pass:none[typing enabled for other nicks (display typing info for nicks typing in the current buffer)]
+** tipo: bool
+** valori: on, off
+** valore predefinito: `+off+`
+
+* [[option_typing.look.enabled_self]] *typing.look.enabled_self*
+** descrizione: pass:none[typing enabled for self messages (send typing info to other users)]
+** tipo: bool
+** valori: on, off
+** valore predefinito: `+off+`
+// end::typing_options[]
+
 // tag::xfer_options[]
 * [[option_xfer.color.status_aborted]] *xfer.color.status_aborted*
 ** descrizione: pass:none[colore del testo per lo status "annullato"]
@@ -2520,6 +2552,18 @@
 ** valori: on, off
 ** valore predefinito: `+off+`
 
+* [[option_irc.look.typing_status_nicks]] *irc.look.typing_status_nicks*
+** descrizione: pass:none[display nicks typing on the channel in bar item "typing" (option typing.look.enabled must be enabled and capability "message-tags" must be enabled on the server)]
+** tipo: bool
+** valori: on, off
+** valore predefinito: `+off+`
+
+* [[option_irc.look.typing_status_self]] *irc.look.typing_status_self*
+** descrizione: pass:none[send self typing status to channels so that other users see when you are typing a message (option typing.look.enabled must be enabled and capability "message-tags" must be enabled on the server)]
+** tipo: bool
+** valori: on, off
+** valore predefinito: `+off+`
+
 * [[option_irc.network.autoreconnect_delay_growing]] *irc.network.autoreconnect_delay_growing*
 ** descrizione: pass:none[growing factor for autoreconnect delay to server (1 = always same delay, 2 = delay*2 for each retry, etc.)]
 ** tipo: intero
diff --git a/doc/it/weechat_user.it.adoc b/doc/it/weechat_user.it.adoc
index a21ea9f3b..375d8f24e 100644
--- a/doc/it/weechat_user.it.adoc
+++ b/doc/it/weechat_user.it.adoc
@@ -322,6 +322,9 @@ List of commonly used options:
 | ENABLE_TRIGGER | `ON`, `OFF` | ON |
   Compile <<trigger_plugin,Trigger plugin>>.
 
+| ENABLE_TYPING | `ON`, `OFF` | ON |
+  Compile <<typing_plugin,Typing plugin>>.
+
 | ENABLE_XFER | `ON`, `OFF` | ON |
   Compile <<xfer_plugin,Xfer plugin>>.
 
@@ -789,6 +792,7 @@ The files in the WeeChat home directory are:
 | spell.conf      | Configuration file for _spell_ plugin      | No.
 | tcl.conf        | Configuration file for _tcl_ plugin        | No.
 | trigger.conf    | Configuration file for _trigger_ plugin    | Possible, depends on triggers.
+| typing.conf     | Configuration file for _typing_ plugin     | No.
 | xfer.conf       | Configuration file for _xfer_ plugin       | No.
 | weechat.log     | WeeChat log file                           | No.
 |===
@@ -2724,6 +2728,8 @@ I plugin predefiniti sono:
 | spell      | Controllo ortografico per la riga di comando.
 // TRANSLATION MISSING
 | trigger    | Text replacement and command execution on events triggered by WeeChat/plugins.
+// TRANSLATION MISSING
+| typing     | Display users currently writing messages.
 | xfer       | Trasferimento file e chat diretta.
 |===
 
@@ -5033,6 +5039,101 @@ Options:
 
 include::includes/autogen_user_options.it.adoc[tag=trigger_options]
 
+// TRANSLATION MISSING
+[[typing_plugin]]
+=== Typing
+
+The typing plugin is used to inform other users you are typing messages and
+show a list of users currently typing a message on the buffer.
+
+It is used by IRC plugin on channel and private buffers, when the "message-tags"
+capability is enabled (you can check with <<command_irc_cap,/cap>> command). +
+Under the hood, typing client tag is used, following this specification:
+https://ircv3.net/specs/client-tags/typing.html.
+
+[[typing_activation]]
+==== Activation
+
+For privacy considerations, the typing feature is disabled by default. +
+If you want to use it, you must enable options in both typing and irc plugins:
+
+----
+/set typing.look.enabled_nicks on
+/set typing.look.enabled_self on
+/set irc.look.typing_status_nicks on
+/set irc.look.typing_status_self on
+----
+
+Then you must add the "typing" bar item in a bar, for example in option
+_weechat.bar.status.items_.
+
+Example of status bar with the "typing" item: "bob" is typing a message and
+"alice" was typing a message but made a pause:
+
+....
+│[12:55] [6] [irc/libera] 3:#test(+n){4} [Typing: bob, (alice)]                   │
+│[@Flashy] █                                                                      │
+└─────────────────────────────────────────────────────────────────────────────────┘
+....
+
+[[typing_signals_sent]]
+==== Signals sent
+
+When you are typing a message (not a command starting with `/`), the typing
+plugin sends signals to inform other plugins (like IRC) that you are typing,
+and these plugins can then send typing notifications to other users.
+
+The following signals are sent when you are typing messages:
+
+[width="100%",cols="1,1,5",options="header"]
+|===
+| Signal              | Arguments        | Description
+| typing_self_typing  | Pointer: buffer. | You are typing a message.
+| typing_self_paused  | Pointer: buffer. | You made a pause while typing a message.
+| typing_self_cleared | Pointer: buffer. | You cleared the command line without sending the message.
+| typing_self_sent    | Pointer: buffer. | You sent the message to the buffer.
+|===
+
+[[typing_signals_caught]]
+==== Signals caught
+
+The typing plugin is catching some signals that can be sent by other plugins
+(like IRC), to update internal hashtables used to store the typing state of
+nicks on buffers. These hashtables are used to build the content of "typing"
+bar item.
+
+The following signals are caught by the typing plugin:
+
+[width="100%",cols="1,4,3",options="header"]
+|===
+| Signal | Arguments | Description
+
+| typing_set_nick |
+  String: buffer pointer + ";" + state (one of: "off", "typing", "paused",
+  "cleared") + ";" + nick. +
+  Example: "0x1234abcd;typing;alice". |
+  Set typing state for a nick on a buffer.
+
+| typing_reset_buffer |
+  Pointer: buffer. |
+  Remove typing state for all nicks on a buffer.
+|===
+
+[[typing_options]]
+==== Opzioni
+
+Sections in file _typing.conf_:
+
+[width="100%",cols="3m,6m,16",options="header"]
+|===
+| Section | Control command    | Description
+| look    | /set typing.look.* | Look and feel.
+|===
+
+Options:
+
+include::includes/autogen_user_options.it.adoc[tag=typing_options]
+
 [[xfer_plugin]]
 === Xfer