pegasus/weechat
1
0
Fork 0
mirror of https://github.com/weechat/weechat.git synced 2026-06-30 14:56:39 +02:00
Code Activity

doc/user: add chapter on custom bar items

Browse Source
This commit is contained in:
Sébastien Helleu
2022-06-07 21:04:34 +02:00
parent d81813cd6a
commit 55a796f30b
7 changed files with 253 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files
doc/de/weechat_user.de.adoc
+36
View File
@@ -2810,6 +2810,42 @@ heißt hierbei _bitlist_ und der Name des bitlbee Servers _bitlbee_):
/set weechat.bar.bitlist.items "@irc.bitlbee.&bitlbee:buffer_nicklist"
----
// TRANSLATION MISSING
[[custom_bar_items]]
===== Custom bar items
Custom bar items can be added with the <<command_weechat_item,/item>> command,
each new item having two properties defined via configuration options:
* `conditions`: evaluated conditions to display the bar item, for example to
restrict the bar item to some specific buffers (if empty, the bar item is
displayed everywhere)
* `content`: evaluated content of bar item.
In both options, the following variables can be used:
* `window`: pointer to the window where the bar is displayed (`NULL` for root bars)
* `buffer`: pointer to buffer where the bar is displayed (current buffer for root bars).
Examples of conditions:
[width="100%",cols="2,10",options="header"]
|===
| Condition | Description
| `${window}` | Displayed in window bars only
| `${buffer.number} == 1` | Displayed in all buffers with number = 1
| `${buffer.plugin.name} == irc` | Displayed in all IRC buffers
| `${type} == channel` | Displayed in all buffers where local variable `type` is set to `channel` (example: all IRC channels)
| `${type} == private` | Displayed in all buffers where local variable `type` is set to `private` (example: all IRC private buffers)
|===
[NOTE]
There's no builtin way to refresh the custom bar items. You can use the
<<trigger,Trigger>> plugin to force the refresh, for example via one or more
signals received.
For more information and examples, see the <<command_weechat_item,/item>> command.
[[bar_filling]]
==== Darstellung innerhalb einer Bar
doc/en/weechat_user.en.adoc
+35
View File
@@ -2760,6 +2760,41 @@ _bitlist_ and if bitlbee server is called _bitlbee_):
/set weechat.bar.bitlist.items "@irc.bitlbee.&bitlbee:buffer_nicklist"
----
[[custom_bar_items]]
===== Custom bar items
Custom bar items can be added with the <<command_weechat_item,/item>> command,
each new item having two properties defined via configuration options:
* `conditions`: evaluated conditions to display the bar item, for example to
restrict the bar item to some specific buffers (if empty, the bar item is
displayed everywhere)
* `content`: evaluated content of bar item.
In both options, the following variables can be used:
* `window`: pointer to the window where the bar is displayed (`NULL` for root bars)
* `buffer`: pointer to buffer where the bar is displayed (current buffer for root bars).
Examples of conditions:
[width="100%",cols="2,10",options="header"]
|===
| Condition | Description
| `${window}` | Displayed in window bars only
| `${buffer.number} == 1` | Displayed in all buffers with number = 1
| `${buffer.plugin.name} == irc` | Displayed in all IRC buffers
| `${type} == channel` | Displayed in all buffers where local variable `type` is set to `channel` (example: all IRC channels)
| `${type} == private` | Displayed in all buffers where local variable `type` is set to `private` (example: all IRC private buffers)
|===
[NOTE]
There's no builtin way to refresh the custom bar items. You can use the
<<trigger,Trigger>> plugin to force the refresh, for example via one or more
signals received.
For more information and examples, see the <<command_weechat_item,/item>> command.
[[bar_filling]]
==== Filling
doc/fr/weechat_user.fr.adoc
+38
View File
@@ -2848,6 +2848,44 @@ s'appelle _bitlist_ et si le serveur bitlbee s'appelle _bitlbee_) :
/set weechat.bar.bitlist.items "@irc.bitlbee.&bitlbee:buffer_nicklist"
----
[[custom_bar_items]]
===== Objets de barre personnalisés
Des objets de barre personnalisés peuvent être ajoutés avec la commande
<<command_weechat_item,/item>>, chaque nouvel objet ayant deux propriétés
définies via des options de configuration :
* `conditions` : conditions évaluées pour afficher l'objet de barre, par exemple
pour restreindre l'objet de barre à certains tampons (si vide, l'objet de barre
est affiché partout)
* `content` : contenu évalué de l'objet de barre.
Dans chacune des options, les variables suivantes peuvent être utilisées :
* `window` : pointeur vers la fenêtre où la barre est affichée (`NULL` pour une
barre de type "root")
* `buffer` : pointeur vers le tampon où la barre est affichée (tampon courant
pour les barres de type "root").
Exemples de conditions :
[width="100%",cols="2,10",options="header"]
|===
| Condition | Description
| `${window}` | Affiché seulement dans les barres de type "window"
| `${buffer.number} == 1` | Affiché dans tous les tampons avec "number" = 1
| `${buffer.plugin.name} == irc` | Affiché dans tous les tampons IRC
| `${type} == channel` | Affiché dans tous les tampons où la variable locale `type` est `channel` (exemple : tous les canaux IRC)
| `${type} == private` | Affiché dans tous les tampons où la variable locale `type` est `private` (exemple : tous les tampons privés IRC)
|===
[NOTE]
Il n'y a pas de moyen intégré de rafraîchir les objets de barre personnalisés.
Vous pouvez utiliser l'extension <<trigger,Trigger>> pour forcer un rafraîchissement,
par exemple sur un ou plusieurs signaux reçus.
Pour plus d'informations et des exemples, voir la commande <<command_weechat_item,/item>>.
[[bar_filling]]
==== Remplissage
doc/it/weechat_user.it.adoc
+36
View File
@@ -3000,6 +3000,42 @@ _bitlist_ and if bitlbee server is called _bitlbee_):
/set weechat.bar.bitlist.items "@irc.bitlbee.&bitlbee:buffer_nicklist"
----
// TRANSLATION MISSING
[[custom_bar_items]]
===== Custom bar items
Custom bar items can be added with the <<command_weechat_item,/item>> command,
each new item having two properties defined via configuration options:
* `conditions`: evaluated conditions to display the bar item, for example to
restrict the bar item to some specific buffers (if empty, the bar item is
displayed everywhere)
* `content`: evaluated content of bar item.
In both options, the following variables can be used:
* `window`: pointer to the window where the bar is displayed (`NULL` for root bars)
* `buffer`: pointer to buffer where the bar is displayed (current buffer for root bars).
Examples of conditions:
[width="100%",cols="2,10",options="header"]
|===
| Condition | Description
| `${window}` | Displayed in window bars only
| `${buffer.number} == 1` | Displayed in all buffers with number = 1
| `${buffer.plugin.name} == irc` | Displayed in all IRC buffers
| `${type} == channel` | Displayed in all buffers where local variable `type` is set to `channel` (example: all IRC channels)
| `${type} == private` | Displayed in all buffers where local variable `type` is set to `private` (example: all IRC private buffers)
|===
[NOTE]
There's no builtin way to refresh the custom bar items. You can use the
<<trigger,Trigger>> plugin to force the refresh, for example via one or more
signals received.
For more information and examples, see the <<command_weechat_item,/item>> command.
[[bar_filling]]
==== Filling
doc/ja/weechat_user.ja.adoc
+36
View File
@@ -2875,6 +2875,42 @@ Example of bar with items
/set weechat.bar.bitlist.items "@irc.bitlbee.&bitlbee:buffer_nicklist"
----
// TRANSLATION MISSING
[[custom_bar_items]]
===== Custom bar items
Custom bar items can be added with the <<command_weechat_item,/item>> command,
each new item having two properties defined via configuration options:
* `conditions`: evaluated conditions to display the bar item, for example to
restrict the bar item to some specific buffers (if empty, the bar item is
displayed everywhere)
* `content`: evaluated content of bar item.
In both options, the following variables can be used:
* `window`: pointer to the window where the bar is displayed (`NULL` for root bars)
* `buffer`: pointer to buffer where the bar is displayed (current buffer for root bars).
Examples of conditions:
[width="100%",cols="2,10",options="header"]
|===
| Condition | Description
| `${window}` | Displayed in window bars only
| `${buffer.number} == 1` | Displayed in all buffers with number = 1
| `${buffer.plugin.name} == irc` | Displayed in all IRC buffers
| `${type} == channel` | Displayed in all buffers where local variable `type` is set to `channel` (example: all IRC channels)
| `${type} == private` | Displayed in all buffers where local variable `type` is set to `private` (example: all IRC private buffers)
|===
[NOTE]
There's no builtin way to refresh the custom bar items. You can use the
<<trigger,Trigger>> plugin to force the refresh, for example via one or more
signals received.
For more information and examples, see the <<command_weechat_item,/item>> command.
[[bar_filling]]
==== バーフィリング
doc/pl/weechat_user.pl.adoc
+36
View File
@@ -2791,6 +2791,42 @@ i serwer bitlbee nazywa sie _bitlbee_):
/set weechat.bar.bitlist.items "@irc.bitlbee.&bitlbee:buffer_nicklist"
----
// TRANSLATION MISSING
[[custom_bar_items]]
===== Custom bar items
Custom bar items can be added with the <<command_weechat_item,/item>> command,
each new item having two properties defined via configuration options:
* `conditions`: evaluated conditions to display the bar item, for example to
restrict the bar item to some specific buffers (if empty, the bar item is
displayed everywhere)
* `content`: evaluated content of bar item.
In both options, the following variables can be used:
* `window`: pointer to the window where the bar is displayed (`NULL` for root bars)
* `buffer`: pointer to buffer where the bar is displayed (current buffer for root bars).
Examples of conditions:
[width="100%",cols="2,10",options="header"]
|===
| Condition | Description
| `${window}` | Displayed in window bars only
| `${buffer.number} == 1` | Displayed in all buffers with number = 1
| `${buffer.plugin.name} == irc` | Displayed in all IRC buffers
| `${type} == channel` | Displayed in all buffers where local variable `type` is set to `channel` (example: all IRC channels)
| `${type} == private` | Displayed in all buffers where local variable `type` is set to `private` (example: all IRC private buffers)
|===
[NOTE]
There's no builtin way to refresh the custom bar items. You can use the
<<trigger,Trigger>> plugin to force the refresh, for example via one or more
signals received.
For more information and examples, see the <<command_weechat_item,/item>> command.
[[bar_filling]]
==== Wypełnienie
doc/sr/weechat_user.sr.adoc
+36
View File
@@ -2582,6 +2582,42 @@ Example of bar with items
/set weechat.bar.bitlist.items "@irc.bitlbee.&bitlbee:buffer_nicklist"
----
// TRANSLATION MISSING
[[custom_bar_items]]
===== Custom bar items
Custom bar items can be added with the <<command_weechat_item,/item>> command,
each new item having two properties defined via configuration options:
* `conditions`: evaluated conditions to display the bar item, for example to
restrict the bar item to some specific buffers (if empty, the bar item is
displayed everywhere)
* `content`: evaluated content of bar item.
In both options, the following variables can be used:
* `window`: pointer to the window where the bar is displayed (`NULL` for root bars)
* `buffer`: pointer to buffer where the bar is displayed (current buffer for root bars).
Examples of conditions:
[width="100%",cols="2,10",options="header"]
|===
| Condition | Description
| `${window}` | Displayed in window bars only
| `${buffer.number} == 1` | Displayed in all buffers with number = 1
| `${buffer.plugin.name} == irc` | Displayed in all IRC buffers
| `${type} == channel` | Displayed in all buffers where local variable `type` is set to `channel` (example: all IRC channels)
| `${type} == private` | Displayed in all buffers where local variable `type` is set to `private` (example: all IRC private buffers)
|===
[NOTE]
There's no builtin way to refresh the custom bar items. You can use the
<<trigger,Trigger>> plugin to force the refresh, for example via one or more
signals received.
For more information and examples, see the <<command_weechat_item,/item>> command.
[[bar_filling]]
==== Испуна