diff options
author | Sébastien Helleu <flashcode@flashtux.org> | 2016-06-25 10:56:55 +0200 |
---|---|---|
committer | Sébastien Helleu <flashcode@flashtux.org> | 2016-06-25 10:56:55 +0200 |
commit | 0c2f32fbcd00fe190274342cae883b7e579c0ee6 (patch) | |
tree | 968f3b360f335f46b34e0e45fe3632584c77dc49 /doc/en | |
parent | a9b0c00df7d09d750cb0abd5acac159af50eb3a9 (diff) | |
download | weechat-0c2f32fbcd00fe190274342cae883b7e579c0ee6.zip |
doc: remove "weechat_" prefix in internal links (plugin API reference)
Diffstat (limited to 'doc/en')
-rw-r--r-- | doc/en/weechat_plugin_api.en.adoc | 108 |
1 files changed, 48 insertions, 60 deletions
diff --git a/doc/en/weechat_plugin_api.en.adoc b/doc/en/weechat_plugin_api.en.adoc index d07ac0cd5..da2be3b6a 100644 --- a/doc/en/weechat_plugin_api.en.adoc +++ b/doc/en/weechat_plugin_api.en.adoc @@ -797,7 +797,7 @@ _WeeChat ≥ 0.4.2._ Return number of chars needed on screen to display UTF-8 string. Non-printable chars have a width of 1 (this is the difference with the function -<<_utf8_strlen_screen,weechat_utf8_strlen_screen>>). +<<_utf8_strlen_screen,utf8_strlen_screen>>). Prototype: @@ -931,9 +931,8 @@ Evaluate a path in 3 steps: . replace leading `%h` by WeeChat home directory, . replace leading `+~+` by user home directory (call to - <<_string_expand_home,weechat_string_expand_home>>), -. evaluate variables - (see <<_string_eval_expression,weechat_string_eval_expression>>). + <<_string_expand_home,string_expand_home>>), +. evaluate variables (see <<_string_eval_expression,string_eval_expression>>). Prototype: @@ -949,11 +948,11 @@ Arguments: * _path_: path * _pointers_: hashtable for call to function - <<_string_eval_expression,weechat_string_eval_expression>> + <<_string_eval_expression,string_eval_expression>> * _extra_vars_: hashtable for call to function - <<_string_eval_expression,weechat_string_eval_expression>> + <<_string_eval_expression,string_eval_expression>> * _options_: hashtable for call to function - <<_string_eval_expression,weechat_string_eval_expression>> + <<_string_eval_expression,string_eval_expression>> Return value: @@ -1200,7 +1199,7 @@ _WeeChat ≥ 0.3.7._ Compile a POSIX extended regular expression using optional flags at beginning of string (for format of flags, see -<<_string_regex_flags,weechat_string_regex_flags>>). +<<_string_regex_flags,string_regex_flags>>). Prototype: @@ -1376,8 +1375,7 @@ Arguments: * _string_: string * _regex_: pointer to a regular expression (_regex_t_ structure) compiled with - WeeChat function <<_string_regcomp,weechat_string_regcomp>> or regcomp - (see `man regcomp`) + WeeChat function <<_string_regcomp,string_regcomp>> or regcomp (see `man regcomp`) * _replace_: replacement text, where following references are allowed: ** `+$0+` to `+$99+`: match 0 to 99 in regular expression (0 is the whole match, 1 to 99 are groups captured between parentheses) @@ -1448,7 +1446,7 @@ Arguments: Return value: * array of strings, NULL if problem (must be freed by calling - <<_string_free_split,weechat_string_free_split>> after use) + <<_string_free_split,string_free_split>> after use) C example: @@ -1511,7 +1509,7 @@ Arguments: Return value: * array of strings, NULL if problem (must be freed by calling - <<_string_free_split,weechat_string_free_split>> after use) + <<_string_free_split,string_free_split>> after use) C example: @@ -1545,8 +1543,7 @@ void weechat_string_free_split (char **split_string); Arguments: -* _split_string_: string split by function - <<_string_split,weechat_string_split>> +* _split_string_: string split by function <<_string_split,string_split>> C example: @@ -1576,8 +1573,7 @@ char *weechat_string_build_with_split_string (char **split_string, Arguments: -* _split_string_: string split by function - <<_string_split,weechat_string_split>> +* _split_string_: string split by function <<_string_split,string_split>> * _separator_: string used to separate strings Return value: @@ -1620,7 +1616,7 @@ Arguments: Return value: * array of strings, NULL if problem (must be freed by calling - <<_free_split_command,weechat_free_split_command>> after use) + <<_free_split_command,free_split_command>> after use) C example: @@ -1650,8 +1646,7 @@ void weechat_string_free_split_command (char **split_command); Arguments: -* _split_command_: command split by - <<_string_split_command,weechat_string_split_command>> +* _split_command_: command split by <<_string_split_command,string_split_command>> C example: @@ -1986,9 +1981,9 @@ Arguments: pointer); pointers "window" and "buffer" are automatically added if they are not in hashtable (with pointer to current window/buffer) (can be NULL): ** _regex_: pointer to a regular expression (_regex_t_ structure) compiled with - WeeChat function <<_string_regcomp,weechat_string_regcomp>> or - regcomp (see `man regcomp`); this option is similar to _regex_ in hashtable - _options_ (below), but is used for better performance + WeeChat function <<_string_regcomp,string_regcomp>> or regcomp (see `man regcomp`); + this option is similar to _regex_ in hashtable _options_ (below), + but is used for better performance * _extra_vars_: extra variables that will be expanded (can be NULL) * _options_: a hashtable with some options (keys and values must be string) (can be NULL): @@ -2049,7 +2044,7 @@ expanded to last): | `+${color:name}+` | WeeChat color code (the name of color has optional attributes), - see function <<_color,weechat_color>> for supported formats | + see function <<_color,color>> for supported formats | `+${color:red}red text+` + `+${color:*214}bold orange text+` | `+red text+` (in red) + @@ -2058,7 +2053,7 @@ expanded to last): | `+${info:name}+` + `+${info:name,arguments}+` | Info from WeeChat or a plugin, see function - <<_info_get,weechat_info_get>> | + <<_info_get,info_get>> | `+${info:version}+` + `+${info:irc_nick_color_name,foo}+` | `+1.0+` + @@ -4304,10 +4299,10 @@ Return value: [NOTE] File is NOT created on disk by this function. It will be created by call to -function <<_config_write,weechat_config_write>>. +function <<_config_write,config_write>>. You should call this function only after adding some sections (with -<<_config_new_section,weechat_config_new_section>>) and options (with -<<_config_new_option,weechat_config_new_option>>). +<<_config_new_section,config_new_section>>) and options (with +<<_config_new_option,config_new_option>>). C example: @@ -5238,7 +5233,7 @@ Arguments: [NOTE] You can set value to null only if it is allowed for option (see -<<_config_new_option,weechat_config_new_option>>). +<<_config_new_option,config_new_option>>). Return value: @@ -6581,8 +6576,7 @@ Add new key bindings. [NOTE] Unlike command `/key bind`, this function will never change an existing key -binding, only new keys are created. To remove a key binding, use -<<_key_unbind,weechat_key_unbind>>. +binding, only new keys are created. To remove a key binding, use <<_key_unbind,key_unbind>>. Prototype: @@ -6655,7 +6649,7 @@ int weechat_key_unbind (const char *context, const char *key); Arguments: -* _context_: context for keys (see <<_key_bind,weechat_key_bind>>) +* _context_: context for keys (see <<_key_bind,key_bind>>) * _key_: key to remove or a special value "area:XXX" to remove all keys having _XXX_ as first or second area @@ -7454,8 +7448,8 @@ WeeChat makes an automatic split of the command and its arguments (like the shell does). + If the split is not correct (according to quotes in your command), or if you want to use shell, you can use function -<<_hook_process_hashtable,weechat_hook_process_hashtable>> with -arguments in the hashtable _options_ _(WeeChat ≥ 0.4.0)_. +<<_hook_process_hashtable,hook_process_hashtable>> with arguments in the hashtable +_options_ _(WeeChat ≥ 0.4.0)_. Prototype: @@ -7516,7 +7510,7 @@ unhook (and kill process if it is still running). The command can be an URL with format: "url:http://www.example.com", to download content of URL _(WeeChat ≥ 0.3.7)_. Options are possible for URL -with function <<_hook_process_hashtable,weechat_hook_process_hashtable>>. +with function <<_hook_process_hashtable,hook_process_hashtable>>. The command can also be a function name with format: "func:name", to execute the function "name" _(WeeChat ≥ 1.5)_. This function receives a single argument @@ -7692,8 +7686,7 @@ struct t_hook *weechat_hook_process_hashtable (const char *command, void *callback_data); ---- -Arguments are the same as function <<_hook_process,weechat_hook_process>>, -with an extra argument: +Arguments are the same as function <<_hook_process,hook_process>>, with an extra argument: * _options_: options for command executed; the hashtable is duplicated in function, so it's safe to free it after this call @@ -7716,7 +7709,7 @@ available: _(WeeChat ≥ 0.4.3)_ | (not used) | Create a pipe for writing data on standard input (stdin) of child process - (see function <<_hook_set,weechat_hook_set>>) + (see function <<_hook_set,hook_set>>) | buffer_flush + _(WeeChat ≥ 1.0)_ | @@ -8899,8 +8892,7 @@ int weechat_hook_signal_send (const char *signal, const char *type_data, Arguments: * _signal_: signal to send -* _type_data_: type of data sent with signal (see - <<_hook_signal,weechat_hook_signal>>) +* _type_data_: type of data sent with signal (see <<_hook_signal,hook_signal>>) * _signal_data_: data sent with signal Return value _(WeeChat ≥ 1.0)_: @@ -9555,7 +9547,7 @@ Arguments: ** _struct t_gui_buffer *buffer_: buffer where completion is made ** _struct t_gui_completion *completion_: structure used to add words for completion (see - <<_hook_completion_list_add,weechat_hook_completion_list_add>>) + <<_hook_completion_list_add,hook_completion_list_add>>) ** return value: *** _WEECHAT_RC_OK_ *** _WEECHAT_RC_ERROR_ @@ -9570,13 +9562,12 @@ recommended to choose a name with a unique prefix, like "plugin_xxx" (where "xxx" is your item name). [IMPORTANT] -The callback must only call function -<<_hook_completion_list_add,weechat_hook_completion_list_add>> +The callback must only call function <<_hook_completion_list_add,hook_completion_list_add>> and must *NOT* update the command line. + To update the command line when key[Tab] is pressed, you can use the function -<<_hook_command_run,weechat_hook_command_run>> with command: -"/input complete_next" (and you must return _WEECHAT_RC_OK_EAT_ if your callback -has updated the command line, so that WeeChat will not perform the completion). +<<_hook_command_run,hook_command_run>> with command: "/input complete_next" +(and you must return _WEECHAT_RC_OK_EAT_ if your callback has updated the command line, +so that WeeChat will not perform the completion). Return value: @@ -9701,7 +9692,7 @@ Arguments: ** _WEECHAT_LIST_POS_BEGINNING_: beginning of list ** _WEECHAT_LIST_POS_END_: end of list -C example: see <<_hook_completion,weechat_hook_completion>>. +C example: see <<_hook_completion,hook_completion>>. Script (Python): @@ -11272,7 +11263,7 @@ Properties: "0" to prevent user from clearing buffer with the command `/buffer clear`, "1" to let user clear the buffer (default for a new buffer) (note: even when it is set to "0", the buffer can still be cleared with - the function <<_buffer_clear,weechat_buffer_clear>>) + the function <<_buffer_clear,buffer_clear>>) | filter + _(WeeChat ≥ 1.0)_ | "0" or "1" | @@ -11787,7 +11778,7 @@ Arguments: * _title_: new title for terminal (NULL to reset title); string is evaluated, so variables like `${info:version}` can be used - (see <<_string_eval_expression,weechat_string_eval_expression>>) + (see <<_string_eval_expression,string_eval_expression>>) C example: @@ -12353,8 +12344,7 @@ Properties: | Name | Value | Description | color | WeeChat color option name | - See argument "color" of function - <<_nicklist_add_group,weechat_nicklist_add_group>> + See argument "color" of function <<_nicklist_add_group,nicklist_add_group>> | visible | "0", "1" | "0" = hidden group, "1" = visible group @@ -12558,15 +12548,13 @@ Properties: | Name | Value | Description | color | WeeChat color option name | - See argument "color" of function - <<_nicklist_add_nick,weechat_nicklist_add_nick>> + See argument "color" of function <<_nicklist_add_nick,nicklist_add_nick>> | prefix | any string | Prefix of nick | prefix_color | WeeChat color option name | - See argument "prefix_color" of function - <<_nicklist_add_nick,weechat_nicklist_add_nick>> + See argument "prefix_color" of function <<_nicklist_add_nick,nicklist_add_nick>> | visible | "0", "1" | "0" = hidden nick, "1" = visible nick @@ -12966,7 +12954,7 @@ Arguments: * _bar_: bar pointer * _property_: name, hidden, priority, conditions, position, filling_top_bottom, filling_left_right, size, size_max, color_fg, color_delim, color_bg, - separator, items (see <<_bar_new,weechat_bar_new>>) + separator, items (see <<_bar_new,bar_new>>) * _value_: new value for property Return value: @@ -14158,7 +14146,7 @@ Functions for hdata (raw access to WeeChat or plugins data). Hdata provides read-only access to data. It is *STRICTLY FORBIDDEN* to write something in memory pointed by hdata variables. + The only way to update data is to call function -<<_hdata_update,weechat_hdata_update>>. +<<_hdata_update,hdata_update>>. ==== hdata_new @@ -14206,7 +14194,7 @@ Arguments: ** _void *data_: pointer ** _struct t_hdata *hdata_: pointer to hdata ** _struct t_hashtable *hashtable_: hashtable with variables to update - (see <<_hdata_update,weechat_hdata_update>>) + (see <<_hdata_update,hdata_update>>) ** return value: number of variables updated * _callback_update_data_: pointer given to update callback when it is called by WeeChat _(WeeChat ≥ 0.3.9)_ @@ -14818,7 +14806,7 @@ Arguments: * _hdata_: hdata pointer * _list_: list pointer; if NULL _(WeeChat ≥ 1.0)_, the pointer is checked with the lists in hdata that have flag "check pointers" (see - <<_hdata_new_list,weechat_hdata_new_list>>), and if no such list + <<_hdata_new_list,hdata_new_list>>), and if no such list exists, the pointer is considered as valid * _pointer_: pointer to check @@ -15328,8 +15316,8 @@ Set new value for variable in a hdata. [NOTE] This function can be called only in an update callback -(see <<_hdata_new,weechat_hdata_new>> and -<<_hdata_update,weechat_hdata_update>>), if the variable can be updated. +(see <<_hdata_new,hdata_new>> and <<_hdata_update,hdata_update>>), +if the variable can be updated. Prototype: |