doc: split list of modifiers into two tables (plugin API reference)

v2.8-utf8proc
Sébastien Helleu 2018-08-17 19:33:46 +02:00
parent 85681772f0
commit fad6768318
4 changed files with 218 additions and 187 deletions

View File

@ -10944,44 +10944,6 @@ List of modifiers used by WeeChat and plugins:
|===
| Modifier | Modifier data | String | Output
| [[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 |
plugin.buffer_name |
Any string. |
String encoded from UTF-8 to charset found for plugin/buffer.
| [[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 |
"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)_ |
"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)_ |
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)_ |
Server name |
Message displayed after `/msg` sent to nickserv. |
Message with hidden password.
| [[hook_modifier_irc_in_xxx]] irc_in_xxx ^(1)^ |
Server name |
Content of message received from IRC server (before charset decoding). |
@ -11006,12 +10968,6 @@ List of modifiers used by WeeChat and plugins:
(to fit in 512 bytes by default). |
New content of message.
| [[hook_modifier_color_decode_ansi]] color_decode_ansi +
_(WeeChat ≥ 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_bar_condition_yyy]] bar_condition_yyy ^(2)^ |
String with window pointer ("0x123..") |
Empty string. |
@ -11123,6 +11079,57 @@ Return value:
* string modified, NULL if error occurred
List of modifiers defined by WeeChat and plugins that can be used:
[width="100%",cols="^2,3,4,4",options="header"]
|===
| Modifier | Modifier data | String | Output
| [[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 |
plugin.buffer_name |
Any string. |
String encoded from UTF-8 to charset found for plugin/buffer.
| [[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 |
"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)_ |
"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)_ |
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)_ |
Server name |
Message displayed after `/msg` sent to nickserv. |
Message with hidden password.
| [[hook_modifier_color_decode_ansi]] color_decode_ansi +
_(WeeChat ≥ 1.0)_ |
"1" to keep colors, "0" to remove colors |
Any string. |
String with ANSI colors converted to WeeChat colors (or ANSI colors removed).
|===
C example:
[source,C]

View File

@ -11173,48 +11173,6 @@ Liste des modificateurs utilisés par WeeChat et les extensions :
|===
| Modificateur | Données du modificateur | Chaîne | Sortie
| [[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 |
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 |
"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 |
"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)_ |
"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)_ |
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)_ |
Nom du serveur |
Message affiché après `msg` envoyé à nickserv. |
Message avec le mot de passe caché.
| [[hook_modifier_irc_in_xxx]] irc_in_xxx ^(1)^ |
Nom de serveur |
Contenu du message reçu du serveur IRC (avant décodage du jeu de caractères). |
@ -11239,13 +11197,6 @@ Liste des modificateurs utilisés par WeeChat et les extensions :
(pour tenir dans les 512 octets par défaut). |
Nouveau contenu du message.
| [[hook_modifier_color_decode_ansi]] color_decode_ansi +
_(WeeChat ≥ 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_bar_condition_yyy]] bar_condition_yyy ^(2)^ |
Chaîne avec un pointeur vers la fenêtre ("0x123..") |
Chaîne vide. |
@ -11360,6 +11311,63 @@ Valeur de retour :
* chaîne modifiée, NULL en cas d'erreur
Liste des modificateurs définis par WeeChat et les extensions qui peuvent être
utilisés :
[width="100%",cols="^2,3,4,4",options="header"]
|===
| Modificateur | Données du modificateur | Chaîne | Sortie
| [[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 |
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 |
"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 |
"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)_ |
"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)_ |
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)_ |
Nom du serveur |
Message affiché après `msg` envoyé à nickserv. |
Message avec le mot de passe caché.
| [[hook_modifier_color_decode_ansi]] color_decode_ansi +
_(WeeChat ≥ 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).
|===
Exemple en C :
[source,C]

View File

@ -11377,49 +11377,6 @@ List of modifiers used by WeeChat and plugins:
|===
| Modificatore | Dati modificatore | Stringa | Output
| [[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 |
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 |
"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 |
"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)_ |
"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)_ |
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)_ |
Nome server |
Message displayed after `/msg` sent to nickserv. |
Message with hidden password.
| [[hook_modifier_irc_in_xxx]] irc_in_xxx ^(1)^ |
Nome server |
Contenuto del messaggio ricevuto dal server IRC (prima della codifica del set caratteri). |
@ -11446,13 +11403,6 @@ List of modifiers used by WeeChat and plugins:
(to fit in 512 bytes by default). |
Nuovo contenuto del messaggio.
// TRANSLATION MISSING
| [[hook_modifier_color_decode_ansi]] color_decode_ansi +
_(WeeChat ≥ 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).
| [[hook_modifier_bar_condition_yyy]] bar_condition_yyy ^(2)^ |
Stringa con puntatore alla finestra ("0x123..") |
Stringa vuota. |
@ -11565,6 +11515,64 @@ Valore restituito:
* stringa modificata, NULL in caso di errore
// TRANSLATION MISSING
List of modifiers defined by WeeChat and plugins that can be used:
[width="100%",cols="^2,3,4,4",options="header"]
|===
| Modificatore | Dati modificatore | Stringa | Output
| [[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 |
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 |
"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 |
"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)_ |
"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)_ |
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)_ |
Nome server |
Message displayed after `/msg` sent to nickserv. |
Message with hidden password.
// TRANSLATION MISSING
| [[hook_modifier_color_decode_ansi]] color_decode_ansi +
_(WeeChat ≥ 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).
|===
Esempio in C:
[source,C]

View File

@ -10916,44 +10916,6 @@ WeeChat とプラグインが使う修飾子のリスト:
|===
| 修飾子 | 修飾子データ | 文字列 | 出力
| [[hook_modifier_charset_decode]] charset_decode |
plugin.buffer_name |
任意の文字列 |
プラグインおよびバッファの文字セットから UTF-8 にデコードされた文字列
| [[hook_modifier_charset_encode]] charset_encode |
plugin.buffer_name |
任意の文字列 |
UTF-8 からプラグインおよびバッファの文字セットにエンコードされた文字列
| [[hook_modifier_irc_color_decode]] irc_color_decode |
色を保持する場合は "1"、削除する場合は "0" |
任意の文字列 |
WeeChat 色コードに変換された IRC 色コードを含む (または IRC 色コードを削除された) 文字列
| [[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 以上で利用可)_ |
色を保持する場合は "1"、削除する場合は "0" |
任意の文字列 |
IRC 色コードに変換された ANSI 色コードを含む (または ANSI 色コードを削除された) 文字列
| [[hook_modifier_irc_command_auth]] irc_command_auth +
_(WeeChat バージョン 0.4.1 以上で利用可)_ |
サーバ名 |
認証コマンド (例: `+/msg nickserv identify password+`) |
パスワードを隠したコマンド (例: `+/msg nickserv identify ********+`)
| [[hook_modifier_irc_message_auth]] irc_message_auth +
_(WeeChat バージョン 0.4.1 以上で利用可)_ |
サーバ名 |
`/msg` をサーバに送信した後に表示されるメッセージ |
パスワードを隠したメッセージ
| [[hook_modifier_irc_in_xxx]] irc_in_xxx ^(1)^ |
サーバ名 |
IRC サーバから受信したメッセージの内容 (文字セットをデコードする前) |
@ -10978,12 +10940,6 @@ WeeChat とプラグインが使う修飾子のリスト:
(自動分割後、自動分割はデフォルトでメッセージを 512 バイト内に収まるように分割します)。|
メッセージの新しい内容
| [[hook_modifier_color_decode_ansi]] color_decode_ansi +
_(WeeChat バージョン 1.0 以上で利用可)_ |
色を保持する場合は "1"、削除する場合は "0" |
任意の文字列 |
WeeChat 色コードに変換された ANSI 色コードを含む (または ANSI 色コードを削除された) 文字列
| [[hook_modifier_bar_condition_yyy]] bar_condition_yyy ^(2)^ |
ウィンドウへのポインタの文字列 ("0x123..") |
空文字列 |
@ -11096,6 +11052,58 @@ char *weechat_hook_modifier_exec (const char *modifier,
* 修正された文字列、エラーが起きた場合は NULL
// TRANSLATION MISSING
List of modifiers defined by WeeChat and plugins that can be used:
[width="100%",cols="^2,3,4,4",options="header"]
|===
| 修飾子 | 修飾子データ | 文字列 | 出力
| [[hook_modifier_charset_decode]] charset_decode |
plugin.buffer_name |
任意の文字列 |
プラグインおよびバッファの文字セットから UTF-8 にデコードされた文字列
| [[hook_modifier_charset_encode]] charset_encode |
plugin.buffer_name |
任意の文字列 |
UTF-8 からプラグインおよびバッファの文字セットにエンコードされた文字列
| [[hook_modifier_irc_color_decode]] irc_color_decode |
色を保持する場合は "1"、削除する場合は "0" |
任意の文字列 |
WeeChat 色コードに変換された IRC 色コードを含む (または IRC 色コードを削除された) 文字列
| [[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 以上で利用可)_ |
色を保持する場合は "1"、削除する場合は "0" |
任意の文字列 |
IRC 色コードに変換された ANSI 色コードを含む (または ANSI 色コードを削除された) 文字列
| [[hook_modifier_irc_command_auth]] irc_command_auth +
_(WeeChat バージョン 0.4.1 以上で利用可)_ |
サーバ名 |
認証コマンド (例: `+/msg nickserv identify password+`) |
パスワードを隠したコマンド (例: `+/msg nickserv identify ********+`)
| [[hook_modifier_irc_message_auth]] irc_message_auth +
_(WeeChat バージョン 0.4.1 以上で利用可)_ |
サーバ名 |
`/msg` をサーバに送信した後に表示されるメッセージ |
パスワードを隠したメッセージ
| [[hook_modifier_color_decode_ansi]] color_decode_ansi +
_(WeeChat バージョン 1.0 以上で利用可)_ |
色を保持する場合は "1"、削除する場合は "0" |
任意の文字列 |
WeeChat 色コードに変換された ANSI 色コードを含む (または ANSI 色コードを削除された) 文字列
|===
C 言語での使用例:
[source,C]