Merge remote-tracking branch 'origin/master' into module_mpris

doc/meson.build

@@ -47,6 +47,12 @@ endif
 if plugin_network_enabled
   plugin_pages += ['yambar-modules-network.5.scd']
 endif
+if plugin_niri_language_enabled
+  plugin_pages += ['yambar-modules-niri-language.5.scd']
+endif
+if plugin_niri_workspaces_enabled
+  plugin_pages += ['yambar-modules-niri-workspaces.5.scd']
+endif
 if plugin_pipewire_enabled
   plugin_pages += ['yambar-modules-pipewire.5.scd']
 endif

doc/yambar-decorations.5.scd

@@ -137,7 +137,7 @@ content:
 
 # STACK
 
-This particles combines multiple decorations.
+This particle combines multiple decorations.
 
 ## CONFIGURATION
 

doc/yambar-modules-disk-io.5.scd

@@ -17,8 +17,8 @@ currently present in the machine.
    for the machine
 |  is_disk
 :  boolean
-:  whether or not the device is a disk (e.g. sda, sdb) or a partition
-   (e.g. sda1, sda2, ...). "Total" is advertised as a disk.
+:  whether or not the device is a disk (e.g., sda, sdb) or a partition
+   (e.g., sda1, sda2, ...). "Total" is advertised as a disk.
 |  read_speed
 :  int
 :  bytes read, in bytes/s

doc/yambar-modules-i3.5.scd

@@ -26,6 +26,9 @@ with the _application_ and _title_ tags to replace the X11-only
 |  name
 :  string
 :  The workspace name
+|  output
+:  string
+:  The output (monitor) the workspace is on
 |  visible
 :  bool
 :  True if the workspace is currently visible (on any output)

doc/yambar-modules-mpd.5.scd

@@ -20,6 +20,9 @@ mpd - This module provides MPD status such as currently playing artist/album/son
 |  consume
 :  bool
 :  True if the *consume* flag is set
+|  single
+:  bool
+:  True if the *single* flag is set
 |  volume
 :  range
 :  Volume of MPD in percentage

doc/yambar-modules-niri-language.5.scd

@@ -0,0 +1,34 @@
+yambar-modules-niri-language(5)
+
+# NAME
+niri-language - This module provides information about niri's currently
+selected language.
+
+# TAGS
+
+[[ *Name*
+:[ *Type*
+:< *Description*
+|  language
+:  string
+:  The currently selected language.
+
+# CONFIGURATION
+
+No additional attributes supported, only the generic ones (see
+*GENERIC CONFIGURATION* in *yambar-modules*(5))
+
+# EXAMPLES
+
+```
+bar:
+  left:
+    - niri-language:
+        content:
+		  string: {text: "{language}"}
+```
+
+# SEE ALSO
+
+*yambar-modules*(5), *yambar-particles*(5), *yambar-tags*(5), *yambar-decorations*(5)
+

doc/yambar-modules-niri-workspaces.5.scd

@@ -0,0 +1,60 @@
+yambar-modules-niri-workspaces(5)
+
+# NAME
+niri-workspaces - This module provides information about niri workspaces.
+
+# DESCRIPTION
+
+This module provides a map of each workspace present in niri.
+
+Each workspace has its _id_, _name_, and its status (_focused_,
+_active_, _empty_). The workspaces are sorted by their ids.
+
+This module will *only* track the monitor where yambar was launched.
+If you have a multi monitor setup, please launch yambar on each
+individual monitor to track its workspaces.
+
+# TAGS
+
+[[ *Name*
+:[ *Type*
+:< *Description*
+|  id
+:  int
+:  The workspace id.
+|  name
+:  string
+:  The name of the workspace.
+|  active
+:  bool
+:  True if the workspace is currently visible on the current output.
+|  focused
+:  bool
+:  True if the workspace is currently focused.
+|  empty
+:  bool
+:  True if the workspace contains no window.
+
+# CONFIGURATION
+
+No additional attributes supported, only the generic ones (see
+*GENERIC CONFIGURATION* in *yambar-modules*(5))
+
+# EXAMPLES
+
+```
+bar:
+  left:
+    - niri-workspaces:
+        content:
+		  map:
+		    default: {string: {text: "| {id}"}}
+			conditions:
+			  active: {string: {text: "-> {id}"}}
+			  ~empty: {string: {text: "@ {id}"}}
+```
+
+# SEE ALSO
+
+*yambar-modules*(5), *yambar-particles*(5), *yambar-tags*(5), *yambar-decorations*(5)
+

doc/yambar-modules-pipewire.5.scd

@@ -19,10 +19,10 @@ pipewire - Monitors pipewire for volume, mute/unmute, device change
 :  Current device description
 |  form_factor
 :  string
-:  Current device form factor (headset, speaker, mic, etc)
+:  Current device form factor (headset, speaker, mic, etc.)
 |  bus
 :  string
-:  Current device bus (bluetooth, alsa, etc)
+:  Current device bus (bluetooth, alsa, etc.)
 |  icon
 :  string
 :  Current device icon name

doc/yambar-modules-script.5.scd

@@ -16,7 +16,7 @@ configurable amount of time.
 In continuous mode, the script is executed once. It will typically run
 in a loop, sending an updated tag set whenever it needs, or wants
 to. The last tag set is used (displayed) by yambar until a new tag set
-is received. This mode is intended to be used by scripts that depends
+is received. This mode is intended to be used by scripts that depend
 on non-polling methods to update their state.
 
 Tag sets, or _transactions_, are separated by an empty line

doc/yambar-modules.5.scd

@@ -174,6 +174,10 @@ Available modules have their own pages:
 
 *yambar-modules-sway*(5)
 
+*yambar-modules-niri-language*(5)
+
+*yambar-modules-niri-workspaces*(5)
+
 *yambar-modules-xkb*(5)
 
 *yambar-modules-xwindow*(5)

doc/yambar-particles.5.scd

@@ -155,7 +155,7 @@ content:
 
 This particle is a list (or sequence, if you like) of other
 particles. It can be used to render e.g. _string_ particles with
-different font and/or color formatting. Or ay other particle
+different font and/or color formatting. Or any other particle
 combinations.
 
 But note that this means you *cannot* set any attributes on the _list_
@@ -265,6 +265,26 @@ To match for empty strings, use ' "" ':
 <tag> == ""
 ```
 
+String glob matching
+
+To perform string matching using globbing with "\*" & "?" characters:
+\* Match any zero or more characters.  ? Match exactly any one
+character.
+
+```
+<tag> ~~ "hello*"
+```
+
+Will match any string starting with "hello", including "hello",
+"hello1", "hello123", etc.
+
+```
+<tag> ~~ "hello?"
+```
+
+Will match any string starting with "hello" followed by any single
+character, including "hello1", "hello-", but not "hello".
+
 Furthermore, you may use the boolean operators:
 
 [-  &&
@@ -456,7 +476,7 @@ itself when needed.
 
 ```
 content:
-  progres-bar:
+  progress-bar:
     tag: tag_name
     length: 20
     start: {string: {text: ├}}

doc/yambar-tags.5.scd

@@ -86,11 +86,10 @@ be used.
 :  format
 :  Range tags
 :  Renders a range tag's value as a percentage value
-|  b
+|  /N
 :  format
 :  All tag types
-:  Renders a tag's value (in decimal) divided by 8. Note: no unit
-   suffix is appended
+:  Renders a tag's value (in decimal) divided by N
 |  kb, mb, gb
 :  format
 :  All tag types

doc/yambar.1.scd

@@ -25,7 +25,7 @@ yambar - modular status panel for X11 and Wayland
 *-p*,*--print-pid*=_FILE_|_FD_
 	Print PID to this file, or FD, when successfully started. The file
 	(or FD) is closed immediately after writing the PID. When a _FILE_
-	as been specified, the file is unlinked exit.
+	as been specified, the file is unlinked upon exiting.
 
 *-d*,*--log-level*={*info*,*warning*,*error*,*none*}
 	Log level, used both for log output on stderr as well as