doc/user: add chapter on custom bar items

7 files changed, 253 insertions, 0 deletions

diff --git a/doc/de/weechat_user.de.adoc b/doc/de/weechat_user.de.adoc
index 78b64f0da..068f173c2 100644
--- a/doc/de/weechat_user.de.adoc
+++ b/doc/de/weechat_user.de.adoc
@@ -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
 
diff --git a/doc/en/weechat_user.en.adoc b/doc/en/weechat_user.en.adoc
index b6eb38977..f3e0d61d9 100644
--- a/doc/en/weechat_user.en.adoc
+++ b/doc/en/weechat_user.en.adoc
@@ -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
 
diff --git a/doc/fr/weechat_user.fr.adoc b/doc/fr/weechat_user.fr.adoc
index 5e89382b8..5f0dc4d09 100644
--- a/doc/fr/weechat_user.fr.adoc
+++ b/doc/fr/weechat_user.fr.adoc
@@ -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
 
diff --git a/doc/it/weechat_user.it.adoc b/doc/it/weechat_user.it.adoc
index d6743e92a..aca98518b 100644
--- a/doc/it/weechat_user.it.adoc
+++ b/doc/it/weechat_user.it.adoc
@@ -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
 
diff --git a/doc/ja/weechat_user.ja.adoc b/doc/ja/weechat_user.ja.adoc
index 48f5a5cab..261ab7cf0 100644
--- a/doc/ja/weechat_user.ja.adoc
+++ b/doc/ja/weechat_user.ja.adoc
@@ -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]]
 ==== バーフィリング
 
diff --git a/doc/pl/weechat_user.pl.adoc b/doc/pl/weechat_user.pl.adoc
index 01aa3c97b..715cd3c23 100644
--- a/doc/pl/weechat_user.pl.adoc
+++ b/doc/pl/weechat_user.pl.adoc
@@ -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
 
diff --git a/doc/sr/weechat_user.sr.adoc b/doc/sr/weechat_user.sr.adoc
index a9316de8c..5f46088c6 100644
--- a/doc/sr/weechat_user.sr.adoc
+++ b/doc/sr/weechat_user.sr.adoc
@@ -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]]
 ==== Испуна