Add the "Themes" section to user guides and plugin API references in
every language where the corresponding adoc exists.
User guide (10 files): English (the new prose) and French (a full
translation, with section title "Thèmes"). For the other languages —
German, Italian, Japanese, Polish, Serbian — the body is the English
text with only the section title localized where the existing Colors
section is localized (Themen / Motywy / Теме); Italian and Japanese
keep the English "Themes" title to match their existing English-only
section titles. Coverage by file:
- doc/en/weechat_user.en.adoc (new English section)
- doc/fr/weechat_user.fr.adoc (full French translation)
- doc/de/weechat_user.de.adoc (English body, "Themen" title)
- doc/it/weechat_user.it.adoc (English body and title)
- doc/ja/weechat_user.ja.adoc (English body and title)
- doc/pl/weechat_user.pl.adoc (English body, "Motywy" title)
- doc/sr/weechat_user.sr.adoc (English body, "Теме" title)
Plugin API reference (5 files): same approach — English plus full
French translation; Italian, Japanese and Serbian keep the English
body with their conventional section title:
- doc/en/weechat_plugin_api.en.adoc (new English section)
- doc/fr/weechat_plugin_api.fr.adoc (full French translation)
- doc/it/weechat_plugin_api.it.adoc (English body and title)
- doc/ja/weechat_plugin_api.ja.adoc (English body and title)
- doc/sr/weechat_plugin_api.sr.adoc (English body, "Теме" title)
User-guide content covers themable options, /theme apply with the
automatic backup mechanism, /theme save and /theme delete with the
reserved-name rules, the .theme file format with a sample, and the
user-file-shadows-built-in resolution order. The API-reference content
documents weechat_theme_register (prototype, arguments, return value,
C example, Python example) with notes on the themable flag and
per-script auto-cleanup on script unload.
The /theme command's CMD_ARGS_DESC help text and the cmdline option
descriptions are picked up automatically by the doc generator
(doc-autogen), so no manual entries are needed there.
For now the only supported flag is:
- "stop_on_error": stop execution of callbacks immediately after an
error (ie return code of callback is WEECHAT_RC_ERROR) and return this code
(by default execute all callbacks and return the last return code, or return
WEECHAT_RC_EAT immediately if a callback returns this)
Example:
hook_signal_send("[flags:stop_on_error]my_signal", WEECHAT_HOOK_SIGNAL_STRING, "test");
Syntax is one of:
- `hdata_count:name[list]`: uses a hdata name and list
- `hdata_count:name[pointer]`: uses a hdata name and pointer (count starts at
this pointer)
The id is a "long long" variable with the current time (microseconds
precision).
It is guaranteed to be unique for all groups and nicks inside the buffer, and
the same number is never used again in the same buffer, during the lifetime of
the process.
It persists and is unchanged after `/upgrade`.
Sébastien Helleu