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

2 files changed, 145 insertions, 0 deletions

diff --git a/doc/de/includes/autogen_user_options.de.adoc b/doc/de/includes/autogen_user_options.de.adoc
index f47de91de..e65a5c865 100644
--- a/doc/de/includes/autogen_user_options.de.adoc
+++ b/doc/de/includes/autogen_user_options.de.adoc
@@ -1845,6 +1845,38 @@
 ** Standardwert: `+"${weechat_runtime_dir}/weechat_fifo_${info:pid}"+`
 // end::fifo_options[]
 
+// tag::typing_options[]
+* [[option_typing.look.delay_purge_paused]] *typing.look.delay_purge_paused*
+** Beschreibung: pass:none[number of seconds after paused status has been set: if reached, the typing status is removed]
+** Typ: integer
+** Werte: 1 .. 3600
+** Standardwert: `+30+`
+
+* [[option_typing.look.delay_purge_typing]] *typing.look.delay_purge_typing*
+** Beschreibung: pass:none[number of seconds after typing status has been set: if reached, the typing status is removed]
+** Typ: integer
+** Werte: 1 .. 3600
+** Standardwert: `+6+`
+
+* [[option_typing.look.delay_set_paused]] *typing.look.delay_set_paused*
+** Beschreibung: pass:none[number of seconds after typing last char: if reached, the typing status becomes "paused" and no more typing signals are sent]
+** Typ: integer
+** Werte: 1 .. 3600
+** Standardwert: `+10+`
+
+* [[option_typing.look.enabled_nicks]] *typing.look.enabled_nicks*
+** Beschreibung: pass:none[typing enabled for other nicks (display typing info for nicks typing in the current buffer)]
+** Typ: boolesch
+** Werte: on, off
+** Standardwert: `+off+`
+
+* [[option_typing.look.enabled_self]] *typing.look.enabled_self*
+** Beschreibung: pass:none[typing enabled for self messages (send typing info to other users)]
+** Typ: boolesch
+** Werte: on, off
+** Standardwert: `+off+`
+// end::typing_options[]
+
 // tag::xfer_options[]
 * [[option_xfer.color.status_aborted]] *xfer.color.status_aborted*
 ** Beschreibung: pass:none[Textfarbe für Status: "abgebrochen"]
@@ -2520,6 +2552,18 @@
 ** Werte: on, off
 ** Standardwert: `+off+`
 
+* [[option_irc.look.typing_status_nicks]] *irc.look.typing_status_nicks*
+** Beschreibung: 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)]
+** Typ: boolesch
+** Werte: on, off
+** Standardwert: `+off+`
+
+* [[option_irc.look.typing_status_self]] *irc.look.typing_status_self*
+** Beschreibung: 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)]
+** Typ: boolesch
+** Werte: on, off
+** Standardwert: `+off+`
+
 * [[option_irc.network.autoreconnect_delay_growing]] *irc.network.autoreconnect_delay_growing*
 ** Beschreibung: pass:none[Multiplikator für die Verzögerung bei der automatischen Wiederverbindung zum Server (1 = immer die selbe Verzögerung nutzen, 2 = Verzögerung*2 für jeden weiteren Versuch, usw.)]
 ** Typ: integer
diff --git a/doc/de/weechat_user.de.adoc b/doc/de/weechat_user.de.adoc
index af1353295..73f670c8e 100644
--- a/doc/de/weechat_user.de.adoc
+++ b/doc/de/weechat_user.de.adoc
@@ -291,6 +291,9 @@ Liste von häufig verwendeten Optionen:
 | ENABLE_TRIGGER | `ON`, `OFF` | ON |
   kompiliert <<trigger_plugin,Trigger Erweiterung>>.
 
+| ENABLE_TYPING | `ON`, `OFF` | ON |
+  kompiliert <<typing_plugin,Typing Erweiterung>>.
+
 | ENABLE_XFER | `ON`, `OFF` | ON |
   kompiliert <<xfer_plugin,Xfer Erweiterung>>.
 
@@ -732,6 +735,7 @@ Folgende Dateien befinden sich im WeeChat-Heimatverzeichnis:
 | spell.conf      | Konfiguration für _spell_-Erweiterung      | Nein.
 | tcl.conf        | Konfiguration für _tcl_-Erweiterung        | Nein.
 | trigger.conf    | Konfiguration für _trigger_-Erweiterung    | möglich, hängt von den Triggern ab.
+| typing.conf     | Konfiguration für _typing_-Erweiterung     | Nein.
 | xfer.conf       | Konfiguration für _xfer_-Erweiterung       | Nein.
 | weechat.log     | WeeChat Logdateien                         | Nein.
 |===
@@ -2580,6 +2584,8 @@ Standarderweiterungen:
 | php         | PHP-Skript API.
 | spell       | Rechtschreibprüfung für Befehlszeile.
 | trigger     | Veränderung von Text und Ausführen von Befehlen bei einem Ereignis, welche durch WeeChat oder eine Erweiterung ausgelöst werden.
+// TRANSLATION MISSING
+| typing      | Display users currently writing messages.
 | xfer        | Datentransfer und Direktchat.
 |===
 
@@ -4786,6 +4792,101 @@ Optionen:
 
 include::includes/autogen_user_options.de.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]]
+==== Optionen
+
+Sektionen in Datei _typing.conf_:
+
+[width="100%",cols="3m,6m,16",options="header"]
+|===
+| Sektion | Steuerbefehl       | Beschreibung
+| look    | /set typing.look.* | Erscheinungsbild.
+|===
+
+Optionen:
+
+include::includes/autogen_user_options.de.adoc[tag=typing_options]
+
 [[xfer_plugin]]
 === Xfer