From a2f2d41ddadf61fd755e1e210674122be7908cb3 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?S=C3=A9bastien=20Helleu?= Date: Mon, 21 Aug 2017 20:29:28 +0200 Subject: [PATCH] doc: add links to other docs in user's guide --- doc/de/weechat_user.de.adoc | 49 ++++++++++++++++++----------- doc/en/weechat_user.en.adoc | 50 ++++++++++++++++++------------ doc/fr/weechat_user.fr.adoc | 52 +++++++++++++++++++------------ doc/it/weechat_user.it.adoc | 48 ++++++++++++++++------------ doc/ja/weechat_user.ja.adoc | 62 +++++++++++++++++++++++-------------- doc/pl/weechat_user.pl.adoc | 50 +++++++++++++++++++----------- 6 files changed, 193 insertions(+), 118 deletions(-) diff --git a/doc/de/weechat_user.de.adoc b/doc/de/weechat_user.de.adoc index 029c7d0c2..602e51a7a 100644 --- a/doc/de/weechat_user.de.adoc +++ b/doc/de/weechat_user.de.adoc @@ -1845,7 +1845,8 @@ einigen Terminals, wie z.B. iTerm, muß die Taste kbd:[Alt] anstelle von kbd:[Shift] verwendet werden). [NOTE] -Sollten Probleme bei der Mausunterstützung auftreten, dann sollte Bitte die _WeeChat FAQ_ gelesen werden. +Sollten Probleme bei der Mausunterstützung auftreten, dann sollte Bitte die +link:weechat_faq.de.html#mouse[WeeChat FAQ / Mausunterstützung]. [[mouse_bind_events]] ==== Befehle einem Maus-Ereignis zuweisen @@ -2134,7 +2135,8 @@ Standarderweiterungen: |=== Um mehr über Erweiterungen- und Skriptenprogrammierung (mittels API) zu erfahren, -sollten Sie die _WeeChat Plugin API Reference_ oder _WeeChat Scripting Guide_ lesen. +sollten Sie die link:weechat_plugin_api.en.html[Anleitung für API Erweiterung] (Englisch) oder +link:weechat_scripting.de.html[WeeChat scripting guide] lesen. [[alias_plugin]] === Alias @@ -2394,7 +2396,7 @@ Um sich alle genutzten Zeichensätze anzeigen zu lassen wird folgender Befehl ge ==== Fehlersuche sollten Probleme bei der Zeichensatzdarstellung auftreten dann werfen Sie bitte -einen Blick in die _WeeChat FAQ_. +einen Blick in die link:weechat_faq.de.html#charset[WeeChat FAQ / Charset]. [[charset_commands]] ==== Befehle @@ -3353,7 +3355,7 @@ Skripten, aus dem Skript-Repository, installiert und deinstalliert werden. Das S kann unter folgender URL eingesehen werden: https://weechat.org/scripts Sollten wir Ihr Interesse geweckt haben, selber Skripten für WeeChat zu programmieren, dann lesen Sie -bitte die _WeeChat Scripting Guide_. +bitte die link:weechat_scripting.de.html[WeeChat scripting Guide]. [[script_commands]] ==== Skript Befehle @@ -3421,9 +3423,10 @@ Daten kann verändert werden, es können ein- oder mehrere Befehle ausgeführt werden. Eine Bedingung kann genutzt werden um damit zu verhindern, dass der Trigger unter bestimmten Umständen ausgeführt wird. +// TRANSLATION MISSING Um Trigger nutzen zu können ist es erforderlich zu wissen wie signals, -modifiers, ... in WeeChat funktionieren. Dazu sollte man das Kapitel -_Hooks_ in der _Anleitung für API Erweiterung_ lesen. +modifiers, ... in WeeChat funktionieren. So you might consider reading the +link:weechat_plugin_api.en.html#hooks[Anleitung für API Erweiterung / Hooks] (Englisch). [[trigger_anatomy]] ==== Aufbau eines Triggers @@ -3441,7 +3444,7 @@ Ein Trigger hat folgende Optionen (Benennung ist | hook | `signal`, `hsignal`, `modifier`, `print`, `command`, `command_run`, `timer`, `config`, `focus` | Der hook welcher durch Trigger genutzt werden soll. Für weitere Informationen siehe - _Anleitung für API Erweiterung_, Kapitel _Hooks_. + link:weechat_plugin_api.en.html#hooks[Anleitung für API Erweiterung / Hooks] (Englisch). | arguments | string | Argumente welche der Hook nutzen soll. Dies ist davon abhängig welcher Hook-Typ genutzt wird. @@ -3501,9 +3504,10 @@ abgearbeitet: Die Argumente sind abhängig von dem genutzten Hook und werden durch ein Semikolon getrennt. -[width="100%",cols="2,6,7",options="header"] +[width="100%",cols="2,6,7,2",options="header"] |=== -| Hook | Argumente | Beispiele +// TRANSLATION MISSING +| Hook | Argumente | Beispiele | Documentation (API) | signal | 1. Signalname (Priorität erlaubt) (erforderlich) + @@ -3511,20 +3515,23 @@ ein Semikolon getrennt. 3. ... | `+*,irc_in_privmsg+` + `+*,irc_in_privmsg;*,irc_in_notice+` + - `+signal_sigwinch+` + `+signal_sigwinch+` | + link:weechat_plugin_api.en.html#_hook_signal[hook_signal] (Englisch) | hsignal | 1. Signalname (Priorität erlaubt) (erforderlich) + 2. Signalname (Priorität erlaubt) + 3. ... | - `+nicklist_nick_added+` + `+nicklist_nick_added+` | + link:weechat_plugin_api.en.html#_hook_hsignal[hook_hsignal] (Englisch) | modifier | 1. modifier-Name (Priorität erlaubt) (erforderlich) + 2. modifier-Name (Priorität erlaubt) + 3. ... | `+weechat_print+` + - `+5000\|input_text_display;5000\|history_add+` + `+5000\|input_text_display;5000\|history_add+` | + link:weechat_plugin_api.en.html#_hook_modifier[hook_modifier] (Englisch) | print | 1. Buffername + @@ -3534,7 +3541,8 @@ ein Semikolon getrennt. `+irc.freenode.*+` + `+irc.freenode.#weechat+` + `+irc.freenode.#weechat;irc_notice+` + - `+*;;;1+` + `+*;;;1+` | + link:weechat_plugin_api.en.html#_hook_print[hook_print] (Englisch) | command | 1. Befehlsname (Priorität erlaubt) (erforderlich) + @@ -3543,32 +3551,37 @@ ein Semikolon getrennt. 4. Beschreibung der Argumente + 5. Vervollständigung | `+test+` + - `+5000\|test+` + `+5000\|test+` | + link:weechat_plugin_api.en.html#_hook_command[hook_command] (Englisch) | command_run | 1. Befehl (Priorität erlaubt) (erforderlich) + 2. Befehl (Priorität erlaubt) + 3. ... | - `+/cmd arguments+` + `+/cmd arguments+` | + link:weechat_plugin_api.en.html#_hook_command_run[hook_command_run] (Englisch) | timer | 1. Intervall in Millisekunden (erforderlich) + 2. Abgleich der Sekunden (Standardwert: 0) + 3. max. Anzahl an Aufrufen (Standardwert: 0, was "unendlich" bedeutet) | `+3600000+` + - `+60000;0;5+` + `+60000;0;5+` | + link:weechat_plugin_api.en.html#_hook_timer[hook_timer] (Englisch) | config | 1. Name der Option (Priorität erlaubt) (erforderlich) + 2. Name der Option (Priorität erlaubt) + 3. ... | - `+weechat.look.*+` + `+weechat.look.*+` | + link:weechat_plugin_api.en.html#_hook_config[hook_config] (Englisch) | focus | 1. area Name (Priorität erlaubt) (erforderlich) + 2. area Name (Priorität erlaubt) + 3. ... | - `+buffer_nicklist+` + `+buffer_nicklist+` | + link:weechat_plugin_api.en.html#_hook_focus[hook_focus] (Englisch) |=== [[trigger_conditions]] diff --git a/doc/en/weechat_user.en.adoc b/doc/en/weechat_user.en.adoc index aade57e28..9eae8905e 100644 --- a/doc/en/weechat_user.en.adoc +++ b/doc/en/weechat_user.en.adoc @@ -1808,7 +1808,8 @@ as if the mouse was disabled (on some terminals like iTerm, you have to use kbd:[Alt] instead of kbd:[Shift]). [NOTE] -For any problem with mouse, please look at _WeeChat FAQ_. +For any problem with mouse, please look at +link:weechat_faq.en.html#mouse[WeeChat FAQ / Mouse]. [[mouse_bind_events]] ==== Bind mouse events to commands @@ -2087,8 +2088,9 @@ Default plugins are: | xfer | File transfer and direct chat. |=== -To learn more about plugin or script development (through API), please read -_WeeChat Plugin API Reference_ or _WeeChat Scripting Guide_. +To learn more about plugin or script development (through API), please read the +link:weechat_plugin_api.en.html[WeeChat plugin API reference] or the +link:weechat_scripting.en.html[WeeChat scripting guide]. [[alias_plugin]] === Alias @@ -2340,7 +2342,8 @@ To see all charsets used, use following command: [[charset_troubleshooting]] ==== Troubleshooting -For any problem with charsets, please look at _WeeChat FAQ_. +For any problem with charsets, please look at +link:weechat_faq.en.html#charset[WeeChat FAQ / Charset]. [[charset_commands]] ==== Commands @@ -3271,7 +3274,7 @@ scripts of any language, and install/remove scripts of WeeChat scripts repository, which are visible at this URL: https://weechat.org/scripts For more information about how to write scripts, or WeeChat API for -scripts, please read _WeeChat Scripting Guide_. +scripts, please read the link:weechat_scripting.en.html[WeeChat scripting guide]. [[script_commands]] ==== Script commands @@ -3339,8 +3342,8 @@ commands. A condition can be used to prevent the trigger to run in some circumstances. Using triggers require you to know how the signals, modifiers, ... are working. -So you might consider reading the _Hooks_ chapter in the -_WeeChat Plugin API Reference_. +So you might consider reading the +link:weechat_plugin_api.en.html#hooks[WeeChat plugin API reference / Hooks]. [[trigger_anatomy]] ==== Anatomy of a trigger @@ -3359,7 +3362,7 @@ A trigger has the following options (names are | hook | `signal`, `hsignal`, `modifier`, `print`, `command`, `command_run`, `timer`, `config`, `focus` | The hook used in trigger. For more information, see - _WeeChat Plugin API Reference_, chapter _Hooks_. + link:weechat_plugin_api.en.html#hooks[WeeChat plugin API reference / Hooks]. | arguments | string | The arguments for the hook, it depends on the hook type used. @@ -3416,9 +3419,9 @@ order, if triggers are globally enabled and if the trigger itself is enabled: The arguments depend on the hook used. They are separated by semicolons. -[width="100%",cols="2,6,7",options="header"] +[width="100%",cols="2,6,7,2",options="header"] |=== -| Hook | Arguments | Examples +| Hook | Arguments | Examples | Documentation (API) | signal | 1. signal name (priority allowed) (required) + @@ -3426,20 +3429,23 @@ The arguments depend on the hook used. They are separated by semicolons. 3. ... | `+*,irc_in_privmsg+` + `+*,irc_in_privmsg;*,irc_in_notice+` + - `+signal_sigwinch+` + `+signal_sigwinch+` | + link:weechat_plugin_api.en.html#_hook_signal[hook_signal] | hsignal | 1. signal name (priority allowed) (required) + 2. signal name (priority allowed) + 3. ... | - `+nicklist_nick_added+` + `+nicklist_nick_added+` | + link:weechat_plugin_api.en.html#_hook_hsignal[hook_hsignal] | modifier | 1. modifier name (priority allowed) (required) + 2. modifier name (priority allowed) + 3. ... | `+weechat_print+` + - `+5000\|input_text_display;5000\|history_add+` + `+5000\|input_text_display;5000\|history_add+` | + link:weechat_plugin_api.en.html#_hook_modifier[hook_modifier] | print | 1. buffer name + @@ -3449,7 +3455,8 @@ The arguments depend on the hook used. They are separated by semicolons. `+irc.freenode.*+` + `+irc.freenode.#weechat+` + `+irc.freenode.#weechat;irc_notice+` + - `+*;;;1+` + `+*;;;1+` | + link:weechat_plugin_api.en.html#_hook_print[hook_print] | command | 1. command name (priority allowed) (required) + @@ -3458,32 +3465,37 @@ The arguments depend on the hook used. They are separated by semicolons. 4. description of arguments + 5. completion | `+test+` + - `+5000\|test+` + `+5000\|test+` | + link:weechat_plugin_api.en.html#_hook_command[hook_command] | command_run | 1. command (priority allowed) (required) + 2. command (priority allowed) + 3. ... | - `+/cmd arguments+` + `+/cmd arguments+` | + link:weechat_plugin_api.en.html#_hook_command_run[hook_command_run] | timer | 1. interval in milliseconds (required) + 2. alignment on second (default: 0) + 3. max number of calls (default: 0, which means "no end") | `+3600000+` + - `+60000;0;5+` + `+60000;0;5+` | + link:weechat_plugin_api.en.html#_hook_timer[hook_timer] | config | 1. option name (priority allowed) (required) + 2. option name (priority allowed) + 3. ... | - `+weechat.look.*+` + `+weechat.look.*+` | + link:weechat_plugin_api.en.html#_hook_config[hook_config] | focus | 1. area name (priority allowed) (required) + 2. area name (priority allowed) + 3. ... | - `+buffer_nicklist+` + `+buffer_nicklist+` | + link:weechat_plugin_api.en.html#_hook_focus[hook_focus] |=== [[trigger_conditions]] diff --git a/doc/fr/weechat_user.fr.adoc b/doc/fr/weechat_user.fr.adoc index 96145e82b..87b444acc 100644 --- a/doc/fr/weechat_user.fr.adoc +++ b/doc/fr/weechat_user.fr.adoc @@ -1865,7 +1865,8 @@ terminal, comme si la souris était désactivée (sous certains terminaux comme iTerm, vous devez utiliser kbd:[Alt] au lieu de kbd:[Shift]). [NOTE] -Pour tout problème avec la souris, merci de consulter la _FAQ WeeChat_. +Pour tout problème avec la souris, merci de consulter la +link:weechat_faq.fr.html#mouse[FAQ WeeChat / Souris]. [[mouse_bind_events]] ==== Associer des évènements souris à des commandes @@ -2158,8 +2159,9 @@ Les extensions par défaut sont : |=== Pour en apprendre plus sur le développement d'extension ou de script (via -l'API), merci de consulter la _Référence API Extension WeeChat_ ou le -_Guide pour Scripts WeeChat_. +l'API), merci de consulter la +link:weechat_plugin_api.fr.html[Référence API extension WeeChat] ou le +link:weechat_scripting.fr.html[Guide pour scripts WeeChat]. [[alias_plugin]] === Alias @@ -2423,7 +2425,7 @@ Pour voir tous les jeux de caractères utilisés, utilisez la commande suivante ==== En cas de problème Pour tout problème avec les jeux de caractères, merci de consulter la -_FAQ WeeChat_. +link:weechat_faq.fr.html#charset[FAQ WeeChat / Accents]. [[charset_commands]] ==== Commandes @@ -3380,7 +3382,8 @@ installer/supprimer des scripts du dépôt WeeChat, qui sont visibles à cette URL : https://weechat.org/scripts Pour plus d'informations sur comment écrire des scripts, ou sur l'API -WeeChat pour les scripts, merci de lire le _Le Guide pour Scripts WeeChat_. +WeeChat pour les scripts, merci de lire le +link:weechat_scripting.fr.html[Guide pour scripts WeeChat]. [[script_commands]] ==== Commandes Script @@ -3448,8 +3451,8 @@ une ou plusieurs commandes. Une condition peut être utilisée pour empêcher le trigger de s'exécuter dans certaines circonstances. Utiliser les triggers nécessite de connaître le fonctionnement des signaux, -modificateurs, etc... Il peut être utile de lire le chapitre sur les _Hooks_ -dans la _Référence API Extension WeeChat_. +modificateurs, etc... Il peut être utile de lire la +link:weechat_plugin_api.fr.html#hooks[Référence API extension WeeChat / Hooks]. [[trigger_anatomy]] ==== Anatomie d'un trigger @@ -3467,8 +3470,8 @@ Un trigger a les options suivantes (les noms sont | hook | `signal`, `hsignal`, `modifier`, `print`, `command`, `command_run`, `timer`, `config`, `focus` | - Le "hook" utilisé dans le trigger. Pour plus d'information, voir le chapitre - _Hooks_ dans la _Référence API Extension WeeChat_. + Le "hook" utilisé dans le trigger. Pour plus d'information, voir la + link:weechat_plugin_api.fr.html#hooks[Référence API extension WeeChat / Hooks]. | arguments | chaîne | Les paramètres pour le "hook", ils dépendent du type de hook utilisé. @@ -3530,9 +3533,9 @@ le trigger lui-même est activé : Les paramètres dépendent du type de "hook" utilisé. Ils sont séparés par des points-virgules. -[width="100%",cols="2,6,7",options="header"] +[width="100%",cols="2,6,7,2",options="header"] |=== -| Hook | Paramètres | Exemples +| Hook | Paramètres | Exemples | Documentation (API) | signal | 1. nom de signal (priorité autorisée) (obligatoire) + @@ -3540,20 +3543,23 @@ points-virgules. 3. ... | `+*,irc_in_privmsg+` + `+*,irc_in_privmsg;*,irc_in_notice+` + - `+signal_sigwinch+` + `+signal_sigwinch+` | + link:weechat_plugin_api.fr.html#_hook_signal[hook_signal] | hsignal | 1. nom de signal (priorité autorisée) (obligatoire) + 2. nom de signal (priorité autorisée) + 3. ... | - `+nicklist_nick_added+` + `+nicklist_nick_added+` | + link:weechat_plugin_api.fr.html#_hook_hsignal[hook_hsignal] | modifier | 1. nom de modificateur (priorité autorisée) (obligatoire) + 2. nom de modificateur (priorité autorisée) + 3. ... | `+weechat_print+` + - `+5000\|input_text_display;5000\|history_add+` + `+5000\|input_text_display;5000\|history_add+` | + link:weechat_plugin_api.fr.html#_hook_modifier[hook_modifier] | print | 1. nom de tampon + @@ -3563,7 +3569,8 @@ points-virgules. `+irc.freenode.*+` + `+irc.freenode.#weechat+` + `+irc.freenode.#weechat;irc_notice+` + - `+*;;;1+` + `+*;;;1+` | + link:weechat_plugin_api.fr.html#_hook_print[hook_print] | command | 1. nom de commande (priorité autorisée) (obligatoire) + @@ -3572,32 +3579,37 @@ points-virgules. 4. description des paramètres + 5. complétion | `+test+` + - `+5000\|test+` + `+5000\|test+` | + link:weechat_plugin_api.fr.html#_hook_command[hook_command] | command_run | 1. commande (priorité autorisée) (obligatoire) + 2. commande (priorité autorisée) + 3. ... | - `+/cmd paramètres+` + `+/cmd paramètres+` | + link:weechat_plugin_api.fr.html#_hook_command_run[hook_command_run] | timer | 1. intervalle, en millisecondes (obligatoire) + 2. alignement sur la seconde (par défaut : 0) + 3. nombre maximum d'appels (par défaut : 0, qui signifie "sans fin") | `+3600000+` + - `+60000;0;5+` + `+60000;0;5+` | + link:weechat_plugin_api.fr.html#_hook_timer[hook_timer] | config | 1. nom d'option (priorité autorisée) (obligatoire) + 2. nom d'option (priorité autorisée) + 3. ... | - `+weechat.look.*+` + `+weechat.look.*+` | + link:weechat_plugin_api.fr.html#_hook_config[hook_config] | focus | 1. nom d'aire (priorité autorisée) (obligatoire) + 2. nom d'aire (priorité autorisée) + 3. ... | - `+buffer_nicklist+` + `+buffer_nicklist+` | + link:weechat_plugin_api.fr.html#_hook_focus[hook_focus] |=== [[trigger_conditions]] diff --git a/doc/it/weechat_user.it.adoc b/doc/it/weechat_user.it.adoc index 0cb626518..efd425629 100644 --- a/doc/it/weechat_user.it.adoc +++ b/doc/it/weechat_user.it.adoc @@ -1922,7 +1922,8 @@ as if the mouse was disabled (on some terminals like iTerm, you have to use kbd:[Alt] instead of kbd:[Shift]). [NOTE] -Per qualunque problema con il mouse, consultare _FAQ di WeeChat_. +Per qualunque problema con il mouse, consultare +link:weechat_faq.it.html#mouse[FAQ di WeeChat / Mouse]. [[mouse_bind_events]] ==== Associare gli eventi del mouse a comandi @@ -2218,8 +2219,8 @@ I plugin predefiniti sono: |=== Per saperne di più riguardo lo sviluppo di plugin o script (tramite le API), per -favore consultare _Riferimento API dei Plugin per WeeChat_ oppure -_Guida allo Scripting di WeeChat_. +favore consultare link:weechat_plugin_api.it.html[Riferimento API dei Plugin per WeeChat] +oppure link:weechat_scripting.it.html[Guida allo Scripting di WeeChat]. [[alias_plugin]] === Alias @@ -2492,7 +2493,7 @@ Per visualizzare tutti i set caratteri utilizzati, utilizzare il comando seguent ==== Risoluzione problemi Per qualunque problema con i set caratteri, per favore consultare -le _Domande Frequenti di WeeChat_. +le link:weechat_faq.it.html#charset[Domande Frequenti di WeeChat / Charset]. [[charset_commands]] ==== Comandi @@ -3493,7 +3494,7 @@ scripts of any language, and install/remove scripts of WeeChat scripts repository, which are visible at this URL: https://weechat.org/scripts Per maggiori informazioni su come scrivere gli script, o le API WeeChat -per gli script, consultare la _Guida allo Scripting di WeeChat_. +per gli script, consultare la link:weechat_scripting.it.html[Guida allo Scripting di WeeChat]. [[script_commands]] ==== Comandi Script @@ -3566,8 +3567,8 @@ commands. A condition can be used to prevent the trigger to run in some circumstances. Using triggers require you to know how the signals, modifiers, ... are working. -So you might consider reading the _Hooks_ chapter in the -_WeeChat Plugin API Reference_. +So you might consider reading the +link:weechat_plugin_api.it.html#hooks[WeeChat plugin API reference / Hooks]. [[trigger_anatomy]] ==== Anatomy of a trigger @@ -3586,7 +3587,7 @@ A trigger has the following options (names are | hook | `signal`, `hsignal`, `modifier`, `print`, `command`, `command_run`, `timer`, `config`, `focus` | The hook used in trigger. For more information, see - _WeeChat Plugin API Reference_, chapter _Hooks_. + link:weechat_plugin_api.it.html#hooks[WeeChat plugin API reference / Hooks]. | arguments | string | The arguments for the hook, it depends on the hook type used. @@ -3643,9 +3644,9 @@ order, if triggers are globally enabled and if the trigger itself is enabled: The arguments depend on the hook used. They are separated by semicolons. -[width="100%",cols="2,6,7",options="header"] +[width="100%",cols="2,6,7,2",options="header"] |=== -| Hook | Arguments | Examples +| Hook | Arguments | Examples | Documentation (API) | signal | 1. signal name (priority allowed) (required) + @@ -3653,20 +3654,23 @@ The arguments depend on the hook used. They are separated by semicolons. 3. ... | `+*,irc_in_privmsg+` + `+*,irc_in_privmsg;*,irc_in_notice+` + - `+signal_sigwinch+` + `+signal_sigwinch+` | + link:weechat_plugin_api.it.html#_hook_signal[hook_signal] | hsignal | 1. signal name (priority allowed) (required) + 2. signal name (priority allowed) + 3. ... | - `+nicklist_nick_added+` + `+nicklist_nick_added+` | + link:weechat_plugin_api.it.html#_hook_hsignal[hook_hsignal] | modifier | 1. modifier name (priority allowed) (required) + 2. modifier name (priority allowed) + 3. ... | `+weechat_print+` + - `+5000\|input_text_display;5000\|history_add+` + `+5000\|input_text_display;5000\|history_add+` | + link:weechat_plugin_api.it.html#_hook_modifier[hook_modifier] | print | 1. buffer name + @@ -3676,7 +3680,8 @@ The arguments depend on the hook used. They are separated by semicolons. `+irc.freenode.*+` + `+irc.freenode.#weechat+` + `+irc.freenode.#weechat;irc_notice+` + - `+*;;;1+` + `+*;;;1+` | + link:weechat_plugin_api.it.html#_hook_print[hook_print] | command | 1. command name (priority allowed) (required) + @@ -3685,32 +3690,37 @@ The arguments depend on the hook used. They are separated by semicolons. 4. description of arguments + 5. completion | `+test+` + - `+5000\|test+` + `+5000\|test+` | + link:weechat_plugin_api.it.html#_hook_command[hook_command] | command_run | 1. command (priority allowed) (required) + 2. command (priority allowed) + 3. ... | - `+/cmd arguments+` + `+/cmd arguments+` | + link:weechat_plugin_api.it.html#_hook_command_run[hook_command_run] | timer | 1. interval in milliseconds (required) + 2. alignment on second (default: 0) + 3. max number of calls (default: 0, which means "no end") | `+3600000+` + - `+60000;0;5+` + `+60000;0;5+` | + link:weechat_plugin_api.it.html#_hook_timer[hook_timer] | config | 1. option name (priority allowed) (required) + 2. option name (priority allowed) + 3. ... | - `+weechat.look.*+` + `+weechat.look.*+` | + link:weechat_plugin_api.it.html#_hook_config[hook_config] | focus | 1. area name (priority allowed) (required) + 2. area name (priority allowed) + 3. ... | - `+buffer_nicklist+` + `+buffer_nicklist+` | + link:weechat_plugin_api.it.html#_hook_focus[hook_focus] |=== [[trigger_conditions]] diff --git a/doc/ja/weechat_user.ja.adoc b/doc/ja/weechat_user.ja.adoc index 3b74227e5..dda968cee 100644 --- a/doc/ja/weechat_user.ja.adoc +++ b/doc/ja/weechat_user.ja.adoc @@ -1810,7 +1810,7 @@ WeeChat でマウスを有効化した場合、すべてのマウスイベント (一部の端末、例えば iTerm などでは kbd:[Shift] の代わりに kbd:[Alt] を使ってください)。 [NOTE] -マウスに関するトラブルがあれば _WeeChat FAQ_ を参照してください。 +マウスに関するトラブルがあれば link:weechat_faq.ja.html#mouse[WeeChat FAQ / Mouse] を参照してください。 [[mouse_bind_events]] ==== コマンドに対してマウスイベントを割り当てる @@ -2087,8 +2087,10 @@ _スクリプト_ とは `/python` 等のコマンドで _python_ | xfer | ファイル転送とダイレクトチャット |=== -API を使ったプラグインやスクリプトの開発についてより詳しく学ぶには、_WeeChat -プラグイン API リファレンス_ または _WeeChat スクリプト作成ガイド_ を参照してください。 +// TRANSLATION MISSING +To learn more about plugin or script development (through API), please read the +link:weechat_plugin_api.ja.html[WeeChat plugin API reference] or the +link:weechat_scripting.ja.html[WeeChat scripting guide]. [[alias_plugin]] === Alias @@ -2339,7 +2341,7 @@ IRC サーバの全てのチャンネルおよびプライベートバッファ [[charset_troubleshooting]] ==== トラブルシューティング -文字コードに関する問題があれば、_WeeChat FAQ_ を参照してください。 +文字コードに関する問題があれば、link:weechat_faq.ja.html#charset[WeeChat FAQ / Charset] を参照してください。 [[charset_commands]] ==== コマンド @@ -3266,8 +3268,9 @@ Python、Perl、Ruby、Lua、Tcl、Guile スクリプトリポジトリ (https://weechat.org/scripts から参照可能) のスクリプトをインストール/削除したりする事が可能です。 -スクリプトの書き方やスクリプト用の WeeChat API -についての詳しい情報は、_WeeChat スクリプト作成ガイド_ を参照してください。 +// TRANSLATION MISSING +For more information about how to write scripts, or WeeChat API for +scripts, please read the link:weechat_scripting.ja.html[WeeChat scripting guide]. [[script_commands]] ==== Script コマンド @@ -3334,9 +3337,10 @@ include::autogen/user/script_options.adoc[] (signal、modifier、print、...) をフックして、データの内容を書き換えたり、複数のコマンドを実行することができます。条件をつけることで一部の場合だけトリガを実行するように設定することもできます。 -トリガを使うにはシグナル、修飾子、... -がどのように動いているかを知らなければいけません。これを知るには _WeeChat -プラグイン API リファレンス_ の _フック_ の章を読むことをお勧めします。 +// TRANSLATION MISSING +Using triggers require you to know how the signals, modifiers, ... are working. +So you might consider reading the +link:weechat_plugin_api.ja.html#hooks[WeeChat plugin API reference / Hooks]. [[trigger_anatomy]] ==== トリガの構造 @@ -3352,10 +3356,10 @@ include::autogen/user/script_options.adoc[] オプションが `off` の場合、トリガは無効化され、アクションは実行されません。 -| hook | `signal`、`hsignal`、`modifier`、`print`、`command`、`command_run`、`timer`、`config`、`focus` - | - トリガの中で使われるフック。より詳しい情報は、_WeeChat - プラグイン API リファレンス_ の _フック_ の章を参照してください。 +// TRANSLATION MISSING +| hook | `signal`、`hsignal`、`modifier`、`print`、`command`、`command_run`、`timer`、`config`、`focus` | + The hook used in trigger. For more information, see + link:weechat_plugin_api.ja.html#hooks[WeeChat plugin API reference / Hooks]. | arguments | 文字列 | フックに対する引数、指定したフックの型に依存します。 @@ -3411,9 +3415,10 @@ trigger.trigger.beep.post_action = none 引数は使用するフックの種類に依存します。引数はセミコロンで区切ってください。 -[width="100%",cols="2,6,7",options="header"] +[width="100%",cols="2,6,7,2",options="header"] |=== -| フック | 引数 | 例 +// TRANSLATION MISSING +| フック | 引数 | 例 | Documentation (API) | signal | 1. シグナル名 (優先度の指定も可) (必須) + @@ -3421,20 +3426,23 @@ trigger.trigger.beep.post_action = none 3. ... | `+*,irc_in_privmsg+` + `+*,irc_in_privmsg;*,irc_in_notice+` + - `+signal_sigwinch+` + `+signal_sigwinch+` | + link:weechat_plugin_api.ja.html#_hook_signal[hook_signal] | hsignal | 1. シグナル名 (優先度の指定も可) (必須) + 2. シグナル名 (優先度の指定も可) + 3. ... | - `+nicklist_nick_added+` + `+nicklist_nick_added+` | + link:weechat_plugin_api.ja.html#_hook_hsignal[hook_hsignal] | modifier | 1. 修飾子名 (優先度の指定も可) (必須) + 2. 修飾子名 (優先度の指定も可) + 3. ... | `+weechat_print+` + - `+5000\|input_text_display;5000\|history_add+` + `+5000\|input_text_display;5000\|history_add+` | + link:weechat_plugin_api.ja.html#_hook_modifier[hook_modifier] | print | 1. バッファ名 + @@ -3444,7 +3452,8 @@ trigger.trigger.beep.post_action = none `+irc.freenode.*+` + `+irc.freenode.#weechat+` + `+irc.freenode.#weechat;irc_notice+` + - `+*;;;1+` + `+*;;;1+` | + link:weechat_plugin_api.ja.html#_hook_print[hook_print] | command | 1. コマンド名 (優先度の指定も可) (必須) + @@ -3453,32 +3462,37 @@ trigger.trigger.beep.post_action = none 4. 引数の説明 + 5. 補完 | `+test+` + - `+5000\|test+` + `+5000\|test+` | + link:weechat_plugin_api.ja.html#_hook_command[hook_command] | command_run | 1. コマンド (優先度の指定も可) (必須) + 2. コマンド (優先度の指定も可) + 3. ... | - `+/cmd arguments+` + `+/cmd arguments+` | + link:weechat_plugin_api.ja.html#_hook_command_run[hook_command_run] | timer | 1. インターバルするミリ秒数 (必須) + 2. 秒の調整 (デフォルト: 0) + 3. 呼び出し回数の最大値 (デフォルト: 0、「無限に」呼び出すことを意味します) | `+3600000+` + - `+60000;0;5+` + `+60000;0;5+` | + link:weechat_plugin_api.ja.html#_hook_timer[hook_timer] | config | 1. オプション名 (優先度の指定も可) (必須) + 2. オプション名 (優先度の指定も可) + 3. ... | - `+weechat.look.*+` + `+weechat.look.*+` | + link:weechat_plugin_api.ja.html#_hook_config[hook_config] | focus | 1. エリア名 (優先度の指定も可) (必須) + 2. エリア名 (優先度の指定も可) + 3. ... | - `+buffer_nicklist+` + `+buffer_nicklist+` | + link:weechat_plugin_api.ja.html#_hook_focus[hook_focus] |=== [[trigger_conditions]] diff --git a/doc/pl/weechat_user.pl.adoc b/doc/pl/weechat_user.pl.adoc index c54afda49..59be6e26e 100644 --- a/doc/pl/weechat_user.pl.adoc +++ b/doc/pl/weechat_user.pl.adoc @@ -1831,7 +1831,8 @@ do terminala, tak jakby obsługa myszy była wyłączona (w niektórych terminal jak iTerm, należy użyc klawisza kbd:[Alt] zamiast kbd:[Shift]). [NOTE] -W razie jakichkolwiek problemów z obsługą myszy, zajrzyj do _WeeChat FAQ_. +W razie jakichkolwiek problemów z obsługą myszy, zajrzyj do +link:weechat_faq.pl.html#mouse[WeeChat FAQ / Obsługa myszy]. [[mouse_bind_events]] ==== Przypisanie zdarzeń myszy do komend @@ -2115,7 +2116,8 @@ Domyślne wtyczki: |=== Więcej informacji o wtyczkach i tworzeniu skryptów (przez API), można znaleźć w -_Opisie API wtyczek_ i _Poradniku pisania skryptów_. +link:weechat_plugin_api.en.html[Opisie API wtyczek] (Angielski) i +link:weechat_scripting.pl.html[Poradniku pisania skryptów]. [[alias_plugin]] === Alias @@ -2376,7 +2378,7 @@ W celu wyświetlenia wszystkich ustawionych kodowań, wykonaj: [[charset_troubleshooting]] ==== Rozwiązywanie problemów -W razie jakichś problemów z kodowaniem, zajrzyj do _WeeChat FAQ_. +W razie jakichś problemów z kodowaniem, zajrzyj do link:weechat_faq.pl.html#charset[WeeChat FAQ / Charset]. [[charset_commands]] ==== Komendy @@ -3329,7 +3331,7 @@ skryptów z repozytorium skryptów WeeChat, dostępnego pod adresem: https://weechat.org/scripts Więcej informacji o tym jak pisać skrypty lub o API WeeChat dla skryptów można -znaleźć w _Poradniku pisania skryptów_. +znaleźć w link:weechat_scripting.pl.html[Poradniku pisania skryptów]. [[script_commands]] ==== Komendy wtyczki script @@ -3397,8 +3399,10 @@ Trigger to scyzoryk szwajcarski dla WeeChat: może być podpięty do wielu rzecz jedną lub więcej komend. Można użyć warunków w celu ograniczenia działania w określonych przypadkach. -Używanie triggerów wymaga wiedzy na temat działania sygnałów, modyfikatorów, ... -Dlatego warto rozważyć przeczytanie rozdziału _Hooks_ w _WeeChat Plugin API Reference_. +// TRANSLATION MISSING +Using triggers require you to know how the signals, modifiers, ... are working. +So you might consider reading the +link:weechat_plugin_api.en.html#hooks[WeeChat plugin API reference / Hooks] (Angielski). [[trigger_anatomy]] ==== Anatomia triggera @@ -3416,7 +3420,7 @@ Trigger posiada następujące opcje (nazwy to `trigger.trigger..`) | hook | `signal`, `hsignal`, `modifier`, `print`, `command`, `command_run`, `timer`, `config`, `focus` | Zdarzenia używane przez trigger. Więcej informacji można znaleźć w - _WeeChat Plugin API Reference_, rozdział _Hooks_. + link:weechat_plugin_api.en.html#hooks[WeeChat Plugin API Reference / Hooks] (Angielski). | arguments | string | Argumenty dla zdarzenia, zależą od jego typu. @@ -3473,9 +3477,10 @@ kolejności, jeśli triggery są globalnie włączone i jeśli sam trigger jest Argumenty zależą od rodzaju uchwytu. Są oddzielane średnikami. -[width="100%",cols="2,6,7",options="header"] +[width="100%",cols="2,6,7,2",options="header"] |=== -| Uchwyt | Argumenty | Przykłady +// TRANSLATION MISSING +| Uchwyt | Argumenty | Przykłady | Documentation (API) | signal | 1. nazwa sygnału (dozwolony priorytet) (wymagane) + @@ -3483,20 +3488,23 @@ Argumenty zależą od rodzaju uchwytu. Są oddzielane średnikami. 3. ... | `+*,irc_in_privmsg+` + `+*,irc_in_privmsg;*,irc_in_notice+` + - `+signal_sigwinch+` + `+signal_sigwinch+` | + link:weechat_plugin_api.en.html#_hook_signal[hook_signal] (Angielski) | hsignal | 1. nazwa sygnału (dozwolony priorytet) (wymagane) + 2. nazwa sygnału (dozwolony priorytet) + 3. ... | - `+nicklist_nick_added+` + `+nicklist_nick_added+` | + link:weechat_plugin_api.en.html#_hook_hsignal[hook_hsignal] (Angielski) | modifier | 1. nazwa modyfikatora (dozwolony priorytet) (wymagane) + 2. nazwa modyfikatora (dozwolony priorytet) + 3. ... | `+weechat_print+` + - `+5000\|input_text_display;5000\|history_add+` + `+5000\|input_text_display;5000\|history_add+` | + link:weechat_plugin_api.en.html#_hook_modifier[hook_modifier] (Angielski) | print | 1. nazwa buforu + @@ -3506,7 +3514,8 @@ Argumenty zależą od rodzaju uchwytu. Są oddzielane średnikami. `+irc.freenode.*+` + `+irc.freenode.#weechat+` + `+irc.freenode.#weechat;irc_notice+` + - `+*;;;1+` + `+*;;;1+` | + link:weechat_plugin_api.en.html#_hook_print[hook_print] (Angielski) | command | 1. nazwa komendy dozwolony priorytet) (wymagane) + @@ -3515,32 +3524,37 @@ Argumenty zależą od rodzaju uchwytu. Są oddzielane średnikami. 4. opis argumentów + 5. dopełnienie | `+test+` + - `+5000\|test+` + `+5000\|test+` | + link:weechat_plugin_api.en.html#_hook_command[hook_command] (Angielski) | command_run | 1. komenda (dozwolony priorytet) (wymagane) + 2. komenda (dozwolony priorytet) + 3. ... | - `+/cmd argumenty+` + `+/cmd argumenty+` | + link:weechat_plugin_api.en.html#_hook_command_run[hook_command_run] (Angielski) | timer | 1. interwał w milisekundach (wymagane) + 2. wyrównanie na sekundę (domyślnie: 0) + 3. maksymalna ilość wywołań (domyślnie: 0, co oznacza "brak końca") | `+3600000+` + - `+60000;0;5+` + `+60000;0;5+` | + link:weechat_plugin_api.en.html#_hook_timer[hook_timer] (Angielski) | config | 1. nazwa opcji (dozwolony priorytet) (wymagane) + 2. nazwa opcji (dozwolony priorytet) + 3. ... | - `+weechat.look.*+` + `+weechat.look.*+` | + link:weechat_plugin_api.en.html#_hook_config[hook_config] (Angielski) | focus | 1. nazwa obszaru (dozwolony priorytet) (wymagane) + 2. nazwa obszaru (dozwolony priorytet) + 3. ... | - `+buffer_nicklist+` + `+buffer_nicklist+` | + link:weechat_plugin_api.en.html#_hook_focus[hook_focus] (Angielski) |=== [[trigger_conditions]]