doc: add links to other docs in plugin API reference

v2.8-utf8proc
Sébastien Helleu 2017-08-22 23:10:41 +02:00
parent 7a1511001e
commit 3d8980d91a
4 changed files with 48 additions and 33 deletions

View File

@ -5577,7 +5577,8 @@ option5 = weechat.config_new_option(config_file, section, "option5", "color",
[NOTE]
In Ruby, the 3 callbacks + data (6 strings) must be given in an array of 6
strings (due to a Ruby limitation of 15 arguments by function), see the
_WeeChat Scripting Guide_ for more info _(fixed in version 0.4.1)_.
link:++weechat_scripting.en.html#_ruby++[WeeChat scripting guide] for more info
_(fixed in version 0.4.1)_.
==== config_search_option
@ -7642,8 +7643,8 @@ Arguments:
* _tags_: comma separated list of tags (NULL means no tags)
* _message_: message to display
See chapter about line tags in _WeeChat User's guide_ for a list of commonly
used tags in WeeChat.
See the link:weechat_user.en.html#lines_tags[WeeChat user's guide / Lines tags]
for a list of commonly used tags in WeeChat.
C example:
@ -13636,7 +13637,8 @@ Arguments:
** _active_: bar is displayed in active window only
** _inactive_: bar is displayed in inactive windows only
** _nicklist_: bar is displayed in windows with nicklist
** evaluated expression: see chapter about bars in _WeeChat User's guide_
** evaluated expression: see the
link:weechat_user.en.html#bar_conditions[WeeChat user's guide / Bar conditions]
* _position_: _top_, _bottom_, _left_ or _right_
* _filling_top_bottom_:
** _horizontal_: items are filled horizontally (space after each item)
@ -14083,8 +14085,8 @@ if (hashtable_in)
----
[NOTE]
See the _WeeChat Scripting Guide_ for more info about "irc_message_parse"
output.
See the link:weechat_scripting.en.html#irc_message_parse[WeeChat scripting guide / Parse message]
for more info about "irc_message_parse" output.
Script (Python):
@ -15688,7 +15690,8 @@ Arguments:
* _pointer_: pointer to a WeeChat/plugin object
* _search_: expression to evaluate, default pointer in expression is the name of
hdata (and this pointer changes for each element in list); for help on
expression, see command `/eval` in _WeeChat User's guide_
expression, see the
link:weechat_user.en.html#command_weechat_eval[WeeChat user's guide / Command /eval]
* _move_: number of jump(s) to execute after unsuccessful search (negative or
positive integer, different from 0)

View File

@ -5669,7 +5669,8 @@ option5 = weechat.config_new_option(config_file, section, "option5", "color",
[NOTE]
En Ruby, les 3 fonctions de rappel + "data" (6 chaînes) doivent être données
dans un tableau de 6 chaînes de caractères (en raison d'une limitation de Ruby
à 15 paramètres par fonction), voir le _Guide pour Scripts WeeChat_ pour plus
à 15 paramètres par fonction), voir le
link:++weechat_scripting.fr.html#_ruby++[Guide pour scripts WeeChat] pour plus
d'infos _(corrigé dans la version 0.4.1)_.
==== config_search_option
@ -7765,7 +7766,7 @@ Paramètres :
étiquette)
* _message_ : message à afficher
Voir le chapitre sur les étiquettes des lignes dans le _Guide utilisateur WeeChat_
Voir le link:weechat_user.fr.html#lines_tags[Guide utilisateur WeeChat / Étiquettes des lignes]
pour une liste des étiquettes couramment utilisées dans WeeChat.
Exemple en C :
@ -13921,8 +13922,8 @@ Paramètres :
** _inactive_ : la barre est affichée dans les fenêtres inactives seulement
** _nicklist_ : la barre est affichée dans les fenêtres possédant une liste des
pseudos
** expression évaluée : voir le chapitre sur les barres dans le
_Guide utilisateur WeeChat_
** expression évaluée : voir le
link:weechat_user.fr.html#bar_conditions[Guide utilisateur WeeChat / Conditions de barres]
* _position_ : _top_ (en haut), _bottom_ (en bas), _left_ (à gauche) ou _right_
(à droite)
* _filling_top_bottom_ :
@ -14379,8 +14380,8 @@ if (hashtable_in)
----
[NOTE]
Voir le _Guide pour Scripts WeeChat_ pour plus d'infos sur la sortie de
"irc_message_parse".
Voir le link:weechat_scripting.fr.html#irc_message_parse[Guide pour scripts WeeChat / Analyser un message]
pour plus d'infos sur la sortie de "irc_message_parse".
Script (Python) :
@ -16012,8 +16013,8 @@ Paramètres :
* _pointer_ : pointeur vers un objet WeeChat ou d'une extension
* _search_ : expression à évaluer, le pointeur par défaut dans l'expression est
le nom du hdata (et ce pointeur change pour chaque élément dans la liste);
pour l'aide sur l'expression, voir la commande `/eval` dans le
_Guide utilisateur WeeChat_
pour l'aide sur l'expression, voir le
link:weechat_user.fr.html#command_weechat_eval[Guide utilisateur WeeChat / Commande /eval]
* _move_ : nombre de saut(s) à exécuter après une recherche infructueuse (entier
négatif ou positif, différent de 0)

View File

@ -5764,7 +5764,8 @@ option5 = weechat.config_new_option(config_file, section, "option5", "color",
[NOTE]
In Ruby, the 3 callbacks + data (6 strings) must be given in an array of 6
strings (due to a Ruby limitation of 15 arguments by function), see the
_WeeChat Scripting Guide_ for more info _(fixed in version 0.4.1)_.
link:++weechat_scripting.it.html#_ruby++[WeeChat Scripting Guide] for more info
_(fixed in version 0.4.1)_.
==== config_search_option
@ -7878,8 +7879,8 @@ Argomenti:
* _message_: messaggio da visualizzare
// TRANSLATION MISSING
See chapter about line tags in _WeeChat User's guide_ for a list of commonly
used tags in WeeChat.
See the link:weechat_user.it.html#lines_tags[WeeChat user's guide / Lines tags]
for a list of commonly used tags in WeeChat.
Esempio in C:
@ -14154,7 +14155,8 @@ Argomenti:
** _inactive_: la barra viene visualizzata solo nelle finestre inattive
** _nicklist_: la barra viene visualizzata nelle finestre con liste nick
// TRANSLATION MISSING
** evaluated expression: see chapter about bars in _WeeChat User's guide_
** evaluated expression: see the
link:weechat_user.it.html#bar_conditions[WeeChat user's guide / Bar conditions]
* _position_: _top_, _bottom_, _left_ o _right_
* _filling_top_bottom_:
** _horizontal_: gli elementi sono posizionati in orizzontale
@ -14626,8 +14628,8 @@ if (hashtable_in)
// TRANSLATION MISSING
[NOTE]
See the _WeeChat Scripting Guide_ for more info about "irc_message_parse"
output.
See the link:weechat_scripting.it.html#irc_message_parse[Guida allo Scripting di WeeChat / Verifica messaggio]
for more info about "irc_message_parse" output.
Script (Python):
@ -16274,7 +16276,8 @@ Argomenti:
// TRANSLATION MISSING
* _search_: expression to evaluate, default pointer in expression is the name of
hdata (and this pointer changes for each element in list); for help on
expression, see command `/eval` in _WeeChat User's guide_
expression, see the
link:weechat_user.it.html#command_weechat_eval[WeeChat user's guide / Command /eval]
// TRANSLATION MISSING
* _move_: number of jump(s) to execute after unsuccessful search (negative or
positive integer, different from 0)

View File

@ -5578,10 +5578,12 @@ option5 = weechat.config_new_option(config_file, section, "option5", "color",
"", "")
----
// TRANSLATION MISSING
[NOTE]
Ruby では、3 組のコールバックとデータ (合わせて 6 つの文字列) を渡すために必ず 6 つの文字列をからなる配列を
1 つ渡してください (これは Ruby が 関数に 15 個以上の引数を渡せないことが原因です)、より詳しい内容は
_WeeChat スクリプト作成ガイド_ を参照してください _(WeeChat バージョン 0.4.1 で修正済み)_。
In Ruby, the 3 callbacks + data (6 strings) must be given in an array of 6
strings (due to a Ruby limitation of 15 arguments by function), see the
link:++weechat_scripting.ja.html#_ruby++[WeeChat Scripting Guide] for more info
_(fixed in version 0.4.1)_.
==== config_search_option
@ -7647,8 +7649,9 @@ void weechat_printf_date_tags (struct t_gui_buffer *buffer, time_t date,
* _tags_: タグのコンマ区切りリスト (タグを指定しない場合は NULL)
* _message_: 表示するメッセージ
WeeChat で共通に使われるタグのリストは _WeeChat ユーザーズガイド_
の行のタグに関する章をご覧ください
// TRANSLATION MISSING
See the link:weechat_user.ja.html#lines_tags[WeeChat user's guide / Lines tags]
for a list of commonly used tags in WeeChat.
C 言語での使用例:
@ -13642,7 +13645,9 @@ struct t_gui_bar *weechat_bar_new (const char *name,
** _active_: アクティブウィンドウのみに表示されているバー
** _inactive_: 非アクティブウィンドウのみに表示されているバー
** _nicklist_: ニックネームリストを持つウィンドウに表示されているバー
** 評価された式: _WeeChat ユーザーズガイド_ のバーに関する章を参照
// TRANSLATION MISSING
** evaluated expression: see the
link:weechat_user.ja.html#bar_conditions[WeeChat user's guide / Bar conditions]
* _position_: _top_、_bottom_、_left_、_right_
* _filling_top_bottom_:
** _horizontal_: 要素は水平方向に詰め込まれている (各要素の後に間隔)
@ -14086,9 +14091,10 @@ if (hashtable_in)
}
----
// TRANSLATION MISSING
[NOTE]
"irc_message_parse" の出力に関するより詳しい内容を得るには
_WeeChat スクリプト作成ガイド_ をご覧ください。
See the link:weechat_scripting.ja.html#irc_message_parse[WeeChat scripting guide / Parse message]
for more info about "irc_message_parse" output.
スクリプト (Python) での使用例:
@ -15690,9 +15696,11 @@ void *weechat_hdata_search (struct t_hdata *hdata, void *pointer, const char *se
* _hdata_: hdata へのポインタ
* _pointer_: WeeChat および plugin オブジェクトへのポインタ
* _search_: 評価する式、式中のデフォルトポインタは hdata の名前
(デフォルトポインタはリストに含まれる各要素で置換される); 式に関する詳細は
_WeeChat ユーザーズガイド_ のコマンド `/eval` を参照
// TRANSLATION MISSING
* _search_: expression to evaluate, default pointer in expression is the name of
hdata (and this pointer changes for each element in list); for help on
expression, see the
link:weechat_user.ja.html#command_weechat_eval[WeeChat user's guide / Command /eval]
* _move_: 検索に失敗した後に移動を実行する回数
(負および正の整数、ゼロは禁止)