blackbeard420/weechat
1
0
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity

doc: add column for min WeeChat version in function hook_modifier_exec (plugin API reference)

Browse Source
This commit is contained in:
Sébastien Helleu 2021-07-03 21:51:41 +02:00
parent 134f4374f8
commit c127d1693a
5 changed files with 73 additions and 110 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

36
doc/en/weechat_plugin_api.en.adoc
View File

@ -11602,76 +11602,68 @@ Return value:
List of modifiers defined by WeeChat and plugins that can be used:
[width="100%",cols="^2,3,4,4",options="header"]
[width="100%",cols="^2,^1,3,4,4",options="header"]
|===
| Modifier | Modifier data | String | Output
| Modifier | Min WeeChat | Modifier data | String | Output
| [[hook_modifier_charset_decode]] charset_decode |
| [[hook_modifier_charset_decode]] charset_decode | |
plugin.buffer_name |
Any string. |
String decoded from charset found for plugin/buffer to UTF-8.
| [[hook_modifier_charset_encode]] charset_encode |
| [[hook_modifier_charset_encode]] charset_encode | |
plugin.buffer_name |
Any string. |
String encoded from UTF-8 to charset found for plugin/buffer.
| [[hook_modifier_irc_color_decode]] irc_color_decode |
| [[hook_modifier_irc_color_decode]] irc_color_decode | |
"1" to keep colors, "0" to remove colors |
Any string. |
String with IRC colors converted to WeeChat colors (or IRC colors removed).
| [[hook_modifier_irc_color_encode]] irc_color_encode |
| [[hook_modifier_irc_color_encode]] irc_color_encode | |
"1" to keep colors, "0" to remove colors |
Any string. |
String with IRC colors (or IRC colors removed).
| [[hook_modifier_irc_color_decode_ansi]] irc_color_decode_ansi +
_(WeeChat ≥ 1.0)_ |
| [[hook_modifier_irc_color_decode_ansi]] irc_color_decode_ansi | 1.0 |
"1" to keep colors, "0" to remove colors |
Any string. |
String with ANSI colors converted to IRC colors (or ANSI colors removed).
| [[hook_modifier_irc_command_auth]] irc_command_auth +
_(WeeChat ≥ 0.4.1)_ |
| [[hook_modifier_irc_command_auth]] irc_command_auth | 0.4.1 |
Server name |
Authentication command (for example: `+/msg nickserv identify password+`). |
command with hidden password (for example: `+/msg nickserv identify ********+`).
| [[hook_modifier_irc_message_auth]] irc_message_auth +
_(WeeChat ≥ 0.4.1)_ |
| [[hook_modifier_irc_message_auth]] irc_message_auth | 0.4.1 |
Server name |
Message displayed after `/msg` sent to nickserv. |
Message with hidden password.
| [[hook_modifier_irc_tag_escape_value]] irc_tag_escape_value +
_(WeeChat ≥ 3.3)_ |
| [[hook_modifier_irc_tag_escape_value]] irc_tag_escape_value | 3.3 |
- |
Any string. |
String with IRC tag value escaped,
see: https://ircv3.net/specs/extensions/message-tags#escaping-values.
| [[hook_modifier_irc_tag_unescape_value]] irc_tag_unescape_value +
_(WeeChat ≥ 3.3)_ |
| [[hook_modifier_irc_tag_unescape_value]] irc_tag_unescape_value | 3.3 |
- |
Any string. |
String with IRC tag value unescaped,
see: https://ircv3.net/specs/extensions/message-tags#escaping-values.
| [[hook_modifier_color_decode_ansi]] color_decode_ansi +
_(WeeChat ≥ 1.0)_ |
| [[hook_modifier_color_decode_ansi]] color_decode_ansi | 1.0 |
"1" to keep colors, "0" to remove colors |
Any string. |
String with ANSI colors converted to WeeChat colors (or ANSI colors removed).
| [[hook_modifier_color_encode_ansi]] color_encode_ansi +
_(WeeChat ≥ 2.7)_ |
| [[hook_modifier_color_encode_ansi]] color_encode_ansi | 2.7 |
- |
Any string. |
String with WeeChat colors converted to ANSI colors.
| [[hook_modifier_eval_path_home]] eval_path_home +
_(WeeChat ≥ 2.7)_ |
| [[hook_modifier_eval_path_home]] eval_path_home | 2.7 |
Optional: `directory=xxx` where `xxx` can be: `config`, `data`, `cache`, `runtime` |
Any string. |
Evaluated path, result of the function

36
doc/fr/weechat_plugin_api.fr.adoc
View File

@ -11850,81 +11850,73 @@ Valeur de retour :
Liste des modificateurs définis par WeeChat et les extensions qui peuvent être
utilisés :
[width="100%",cols="^2,3,4,4",options="header"]
[width="100%",cols="^2,^1,3,4,4",options="header"]
|===
| Modificateur | Données du modificateur | Chaîne | Sortie
| Modificateur | WeeChat mini | Données du modificateur | Chaîne | Sortie
| [[hook_modifier_charset_decode]] charset_decode |
| [[hook_modifier_charset_decode]] charset_decode | |
extension.nom_tampon |
Toute chaîne. |
Chaîne décodée depuis le jeu de caractères trouvé pour l'extension/tampon
vers UTF-8.
| [[hook_modifier_charset_encode]] charset_encode |
| [[hook_modifier_charset_encode]] charset_encode | |
extension.nom_tampon |
Toute chaîne. |
Chaîne encodée depuis UTF-8 vers le jeu de caractères trouvé pour
l'extension/tampon.
| [[hook_modifier_irc_color_decode]] irc_color_decode |
| [[hook_modifier_irc_color_decode]] irc_color_decode | |
"1" pour garder les couleurs, "0" pour les supprimer |
Toute chaîne. |
Chaîne avec les couleurs IRC converties en couleurs WeeChat (ou avec les
couleurs IRC supprimées).
| [[hook_modifier_irc_color_encode]] irc_color_encode |
| [[hook_modifier_irc_color_encode]] irc_color_encode | |
"1" pour garder les couleurs, "0" pour les supprimer |
Toute chaîne. |
Chaîne avec les couleurs IRC (ou avec les couleurs IRC supprimées).
| [[hook_modifier_irc_color_decode_ansi]] irc_color_decode_ansi +
_(WeeChat ≥ 1.0)_ |
| [[hook_modifier_irc_color_decode_ansi]] irc_color_decode_ansi | 1.0 |
"1" pour garder les couleurs, "0" pour les supprimer |
Toute chaîne. |
Chaîne avec les couleurs ANSI converties en couleurs IRC (ou avec les couleurs
ANSI supprimées).
| [[hook_modifier_irc_command_auth]] irc_command_auth +
_(WeeChat ≥ 0.4.1)_ |
| [[hook_modifier_irc_command_auth]] irc_command_auth | 0.4.1 |
Nom du serveur |
Commande d'authentification (par exemple : `+/msg nickserv identify password+`). |
Commande avec le mot de passe caché (par exemple : `+/msg nickserv identify ********+`).
| [[hook_modifier_irc_message_auth]] irc_message_auth +
_(WeeChat ≥ 0.4.1)_ |
| [[hook_modifier_irc_message_auth]] irc_message_auth | 0.4.1 |
Nom du serveur |
Message affiché après `msg` envoyé à nickserv. |
Message avec le mot de passe caché.
| [[hook_modifier_irc_tag_escape_value]] irc_tag_escape_value +
_(WeeChat ≥ 3.3)_ |
| [[hook_modifier_irc_tag_escape_value]] irc_tag_escape_value | 3.3 |
- |
Toute chaîne. |
Chaîne avec la valeur de l'étiquette IRC échappée,
voir : https://ircv3.net/specs/extensions/message-tags#escaping-values.
| [[hook_modifier_irc_tag_unescape_value]] irc_tag_unescape_value +
_(WeeChat ≥ 3.3)_ |
| [[hook_modifier_irc_tag_unescape_value]] irc_tag_unescape_value | 3.3 |
- |
Toute chaîne. |
Chaîne avec la valeur de l'étiquette IRC sans échappements,
voir : https://ircv3.net/specs/extensions/message-tags#escaping-values.
| [[hook_modifier_color_decode_ansi]] color_decode_ansi +
_(WeeChat ≥ 1.0)_ |
| [[hook_modifier_color_decode_ansi]] color_decode_ansi | 1.0 |
"1" pour garder les couleurs, "0" pour les supprimer |
Toute chaîne. |
Chaîne avec les couleurs ANSI converties en couleurs WeeChat (ou avec les
couleurs ANSI supprimées).
| [[hook_modifier_color_encode_ansi]] color_encode_ansi +
_(WeeChat ≥ 2.7)_ |
| [[hook_modifier_color_encode_ansi]] color_encode_ansi | 2.7 |
- |
Toute chaîne. |
Chaîne avec les couleurs WeeChat converties en couleurs ANSI.
| [[hook_modifier_eval_path_home]] eval_path_home +
_(WeeChat ≥ 2.7)_ |
| [[hook_modifier_eval_path_home]] eval_path_home | 2.7 |
Facultatif : `directory=xxx` où `xxx` peut être : `config`, `data`, `cache`, `runtime` |
Toute chaîne. |
Chemin évalué, résultat de la fonction

37
doc/it/weechat_plugin_api.it.adoc
View File

@ -12075,86 +12075,79 @@ Valore restituito:
// TRANSLATION MISSING
List of modifiers defined by WeeChat and plugins that can be used:
[width="100%",cols="^2,3,4,4",options="header"]
[width="100%",cols="^2,^1,3,4,4",options="header"]
|===
| Modificatore | Dati modificatore | Stringa | Output
// TRANSLATION MISSING
| Modificatore | Min WeeChat | Dati modificatore | Stringa | Output
| [[hook_modifier_charset_decode]] charset_decode |
| [[hook_modifier_charset_decode]] charset_decode | |
plugin.buffer_name |
Qualsiasi stringa. |
Stringa codificata dal set caratteri trovato per plugin/buffer in UTF-8.
| [[hook_modifier_charset_encode]] charset_encode |
| [[hook_modifier_charset_encode]] charset_encode | |
plugin.buffer_name |
Qualsiasi stringa. |
Stringa codificata da UTF-8 al set caratteri trovato per il plugin/buffer.
// TRANSLATION MISSING
| [[hook_modifier_irc_color_decode]] irc_color_decode |
| [[hook_modifier_irc_color_decode]] irc_color_decode | |
"1" per mantenere i colori, "0" per rimuovere i colori |
Qualsiasi stringa. |
String with IRC colors converted to WeeChat colors (or IRC colors removed).
// TRANSLATION MISSING
| [[hook_modifier_irc_color_encode]] irc_color_encode |
| [[hook_modifier_irc_color_encode]] irc_color_encode | |
"1" per mantenere i colori, "0" per rimuovere i colori |
Qualsiasi stringa. |
String with IRC colors (or IRC colors removed).
// TRANSLATION MISSING
| [[hook_modifier_irc_color_decode_ansi]] irc_color_decode_ansi +
_(WeeChat ≥ 1.0)_ |
| [[hook_modifier_irc_color_decode_ansi]] irc_color_decode_ansi | 1.0 |
"1" per mantenere i colori, "0" per rimuovere i colori |
Qualsiasi stringa. |
String with ANSI colors converted to IRC colors (or ANSI colors removed).
// TRANSLATION MISSING
| [[hook_modifier_irc_command_auth]] irc_command_auth +
_(WeeChat ≥ 0.4.1)_ |
| [[hook_modifier_irc_command_auth]] irc_command_auth | 0.4.1 |
Nome server |
Authentication command (for example: `+/msg nickserv identify password+`). |
Command with hidden password (for example: `+/msg nickserv identify ********+`).
// TRANSLATION MISSING
| [[hook_modifier_irc_message_auth]] irc_message_auth +
_(WeeChat ≥ 0.4.1)_ |
| [[hook_modifier_irc_message_auth]] irc_message_auth | 0.4.1 |
Nome server |
Message displayed after `/msg` sent to nickserv. |
Message with hidden password.
// TRANSLATION MISSING
| [[hook_modifier_irc_tag_escape_value]] irc_tag_escape_value +
_(WeeChat ≥ 3.3)_ |
| [[hook_modifier_irc_tag_escape_value]] irc_tag_escape_value | 3.3 |
- |
Any string. |
String with IRC tag value escaped,
see: https://ircv3.net/specs/extensions/message-tags#escaping-values.
// TRANSLATION MISSING
| [[hook_modifier_irc_tag_unescape_value]] irc_tag_unescape_value +
_(WeeChat ≥ 3.3)_ |
| [[hook_modifier_irc_tag_unescape_value]] irc_tag_unescape_value | 3.3 |
- |
Any string. |
String with IRC tag value unescaped,
see: https://ircv3.net/specs/extensions/message-tags#escaping-values.
// TRANSLATION MISSING
| [[hook_modifier_color_decode_ansi]] color_decode_ansi +
_(WeeChat ≥ 1.0)_ |
| [[hook_modifier_color_decode_ansi]] color_decode_ansi | 1.0 |
"1" per mantenere i colori, "0" per rimuovere i colori |
Qualsiasi stringa. |
String with ANSI colors converted to WeeChat colors (or ANSI colors removed).
// TRANSLATION MISSING
| [[hook_modifier_color_encode_ansi]] color_encode_ansi +
_(WeeChat ≥ 2.7)_ |
| [[hook_modifier_color_encode_ansi]] color_encode_ansi | 2.7 |
- |
Any string. |
String with WeeChat colors converted to ANSI colors.
// TRANSLATION MISSING
| [[hook_modifier_eval_path_home]] eval_path_home +
_(WeeChat ≥ 2.7)_ |
| [[hook_modifier_eval_path_home]] eval_path_home | 2.7 |
Optional: `directory=xxx` where `xxx` can be: `config`, `data`, `cache`, `runtime` |
Any string. |
Evaluated path, result of the function

37
doc/ja/weechat_plugin_api.ja.adoc
View File

@ -11640,80 +11640,73 @@ char *weechat_hook_modifier_exec (const char *modifier,
WeeChat とプラグインが定義する修飾子のリスト:
[width="100%",cols="^2,3,4,4",options="header"]
[width="100%",cols="^2,^1,3,4,4",options="header"]
|===
| 修飾子 | 修飾子データ | 文字列 | 出力
// TRANSLATION MISSING
| 修飾子 | Min WeeChat | 修飾子データ | 文字列 | 出力
| [[hook_modifier_charset_decode]] charset_decode |
| [[hook_modifier_charset_decode]] charset_decode | |
plugin.buffer_name |
任意の文字列 |
プラグインおよびバッファの文字セットから UTF-8 にデコードされた文字列
| [[hook_modifier_charset_encode]] charset_encode |
| [[hook_modifier_charset_encode]] charset_encode | |
plugin.buffer_name |
任意の文字列 |
UTF-8 からプラグインおよびバッファの文字セットにエンコードされた文字列
| [[hook_modifier_irc_color_decode]] irc_color_decode |
| [[hook_modifier_irc_color_decode]] irc_color_decode | |
色を保持する場合は "1"、削除する場合は "0" |
任意の文字列 |
WeeChat 色コードに変換された IRC 色コードを含む (または IRC 色コードを削除された) 文字列
| [[hook_modifier_irc_color_encode]] irc_color_encode |
| [[hook_modifier_irc_color_encode]] irc_color_encode | |
色を保持する場合は "1"、削除する場合は "0" |
任意の文字列 |
IRC 色コードを含む (または IRC 色コードを削除された) 文字列
| [[hook_modifier_irc_color_decode_ansi]] irc_color_decode_ansi +
_(WeeChat バージョン 1.0 以上で利用可)_ |
| [[hook_modifier_irc_color_decode_ansi]] irc_color_decode_ansi | 1.0 |
色を保持する場合は "1"、削除する場合は "0" |
任意の文字列 |
IRC 色コードに変換された ANSI 色コードを含む (または ANSI 色コードを削除された) 文字列
| [[hook_modifier_irc_command_auth]] irc_command_auth +
_(WeeChat バージョン 0.4.1 以上で利用可)_ |
| [[hook_modifier_irc_command_auth]] irc_command_auth | 0.4.1 |
サーバ名 |
認証コマンド (例: `+/msg nickserv identify password+`) |
パスワードを隠したコマンド (例: `+/msg nickserv identify ********+`)
| [[hook_modifier_irc_message_auth]] irc_message_auth +
_(WeeChat バージョン 0.4.1 以上で利用可)_ |
| [[hook_modifier_irc_message_auth]] irc_message_auth | 0.4.1 |
サーバ名 |
`/msg` をサーバに送信した後に表示されるメッセージ |
パスワードを隠したメッセージ
// TRANSLATION MISSING
| [[hook_modifier_irc_tag_escape_value]] irc_tag_escape_value +
_(WeeChat ≥ 3.3)_ |
| [[hook_modifier_irc_tag_escape_value]] irc_tag_escape_value | 3.3 |
- |
Any string. |
String with IRC tag value escaped,
see: https://ircv3.net/specs/extensions/message-tags#escaping-values.
// TRANSLATION MISSING
| [[hook_modifier_irc_tag_unescape_value]] irc_tag_unescape_value +
_(WeeChat ≥ 3.3)_ |
| [[hook_modifier_irc_tag_unescape_value]] irc_tag_unescape_value | 3.3 |
- |
Any string. |
String with IRC tag value unescaped,
see: https://ircv3.net/specs/extensions/message-tags#escaping-values.
| [[hook_modifier_color_decode_ansi]] color_decode_ansi +
_(WeeChat バージョン 1.0 以上で利用可)_ |
| [[hook_modifier_color_decode_ansi]] color_decode_ansi | 1.0 |
色を保持する場合は "1"、削除する場合は "0" |
任意の文字列 |
WeeChat 色コードに変換された ANSI 色コードを含む (または ANSI 色コードを削除された) 文字列
// TRANSLATION MISSING
| [[hook_modifier_color_encode_ansi]] color_encode_ansi +
_(WeeChat バージョン 2.7 以上で利用可)_ |
| [[hook_modifier_color_encode_ansi]] color_encode_ansi | 2.7 |
- |
任意の文字列 |
String with WeeChat colors converted to ANSI colors.
// TRANSLATION MISSING
| [[hook_modifier_eval_path_home]] eval_path_home +
_(WeeChat バージョン 2.7 以上で利用可)_ |
| [[hook_modifier_eval_path_home]] eval_path_home | 2.7 |
Optional: `directory=xxx` where `xxx` can be: `config`, `data`, `cache`, `runtime` |
Any string. |
Evaluated path, result of the function

37
doc/sr/weechat_plugin_api.sr.adoc
View File

@ -11204,78 +11204,71 @@ char *weechat_hook_modifier_exec (const char *modifier,
Листа модификатора за употребу које дефинишу програм WeeChat и додаци:
[width="100%", cols="^2,3,4,4", options="header"]
[width="100%", cols="^2,^1,3,4,4", options="header"]
|===
| Модификатор | Подаци модификатора | Стринг | Излаз
// TRANSLATION MISSING
| Модификатор | Min WeeChat | Подаци модификатора | Стринг | Излаз
| [[hook_modifier_charset_decode]] charset_decode |
| [[hook_modifier_charset_decode]] charset_decode | |
plugin.buffer_name |
Било који стринг. |
Стринг декодиран из скупа карактера пронађеног за додатак/бафер у UTF-8.
| [[hook_modifier_charset_encode]] charset_encode |
| [[hook_modifier_charset_encode]] charset_encode | |
plugin.buffer_name |
Било који стринг. |
Стринг кодиран из UTF-8 у скуп карактера пронађен за додатак/бафер.
| [[hook_modifier_irc_color_decode]] irc_color_decode |
| [[hook_modifier_irc_color_decode]] irc_color_decode | |
"1" да се боје задрже, "0" да се боје уклоне |
Било који стринг. |
Стринг у којем су IRC боје конвертоване у WeeChat боје (или су уклоњене IRC боје).
| [[hook_modifier_irc_color_encode]] irc_color_encode |
| [[hook_modifier_irc_color_encode]] irc_color_encode | |
"1" да се боје задрже, "0" да се боје уклоне |
Било који стринг. |
Стринг са IRC бојама (или са уклоњеним IRC бојама).
| [[hook_modifier_irc_color_decode_ansi]] irc_color_decode_ansi +
_(WeeChat ≥ 1.0)_ |
| [[hook_modifier_irc_color_decode_ansi]] irc_color_decode_ansi | 1.0 |
"1" да се боје задрже, "0" да се боје уклоне |
Било који стринг. |
Стринг у којем су ANSI боје конвертоване у IRC боје (или су уклоњене ANSI боје).
| [[hook_modifier_irc_command_auth]] irc_command_auth +
_(WeeChat ≥ 0.4.1)_ |
| [[hook_modifier_irc_command_auth]] irc_command_auth | 0.4.1 |
Име сервера |
Команда аутентификације (на пример: `+/msg nickserv identify лозинка+`). |
Команда са скривеном лозинком (на пример: `+/msg nickserv identify ********+`).
| [[hook_modifier_irc_message_auth]] irc_message_auth +
_(WeeChat ≥ 0.4.1)_ |
| [[hook_modifier_irc_message_auth]] irc_message_auth | 0.4.1 |
Име сервера |
Порука која се приказује након што се `/msg` пошаље nickserv боту. |
Порука са скривеном лозинком.
// TRANSLATION MISSING
| [[hook_modifier_irc_tag_escape_value]] irc_tag_escape_value +
_(WeeChat ≥ 3.3)_ |
| [[hook_modifier_irc_tag_escape_value]] irc_tag_escape_value | 3.3 |
- |
Any string. |
String with IRC tag value escaped,
see: https://ircv3.net/specs/extensions/message-tags#escaping-values.
// TRANSLATION MISSING
| [[hook_modifier_irc_tag_unescape_value]] irc_tag_unescape_value +
_(WeeChat ≥ 3.3)_ |
| [[hook_modifier_irc_tag_unescape_value]] irc_tag_unescape_value | 3.3 |
- |
Any string. |
String with IRC tag value unescaped,
see: https://ircv3.net/specs/extensions/message-tags#escaping-values.
| [[hook_modifier_color_decode_ansi]] color_decode_ansi +
_(WeeChat ≥ 1.0)_ |
| [[hook_modifier_color_decode_ansi]] color_decode_ansi | 1.0 |
"1" да се боје задрже, "0" да се боје уклоне |
Било који стринг. |
Стринг у којем су ANSI боје конвертоване у WeeChat боје (или су уклоњене WeeChat боје).
| [[hook_modifier_color_encode_ansi]] color_encode_ansi +
_(WeeChat ≥ 2.7)_ |
| [[hook_modifier_color_encode_ansi]] color_encode_ansi | 2.7 |
- |
Било који стринг. |
Стринг са WeeChat бојама конвертованим у ANSI боје.
| [[hook_modifier_eval_path_home]] eval_path_home +
_(WeeChat ≥ 2.7)_ |
| [[hook_modifier_eval_path_home]] eval_path_home | 2.7 |
Није обавезно: `directory=xxx` где `xxx` може бити: `config`, `data`, `cache`, `runtime` |
Било који стринг. |
Израчуната путања, резултат функције