From 41d0a17ea591afb3da7543b687fa8e5f1c7f14a5 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Daniel=20Ekl=C3=B6f?= Date: Thu, 24 Sep 2020 17:03:36 +0200 Subject: [PATCH] doc: yambar-tags: document the :hex and :oct suffixes --- doc/yambar-tags.5.scd | 14 +++++++++++--- 1 file changed, 11 insertions(+), 3 deletions(-) diff --git a/doc/yambar-tags.5.scd b/doc/yambar-tags.5.scd index 9b31712..32132cf 100644 --- a/doc/yambar-tags.5.scd +++ b/doc/yambar-tags.5.scd @@ -25,14 +25,22 @@ The available tag *types* are: | range : Value is an integer, with a minimum and maximum value associated with it. By default, the _string_ particle renders the value. The - _:min_ or _:max_ suffixes by be added to instead render the mininum - or maximum value (_\"{tag_name:min}\"_). + *:min* or *:max* suffixes may be added to instead render the + mininum or maximum value (_\"{tag_name:min}\"_). | realtime : Value is an integer that changes in a predictable manner (in "realtime"). This allows the particle to update itself periodically. Only supported by the *yambar-particle-progress-bar*(5). Other particles can still render - the tag's value. And, the _string_ particle recognizes the _:unit_ + the tag's value. And, the _string_ particle recognizes the *:unit* suffix, which will be translated to a "s" for a tag with "seconds" resolution, or "ms" for one with "milliseconds" resolution. +# FORMATTING + +As mentioned above, each tag type has a default representation that is +used when the tag is rendered by a string particle. + +All integer, floating point and boolean tag types can be modified to +instead be rendered in hexadecimal or octal form, by appending either +the *:hex* or *:oct* suffixes. For example, _\"{tag_name:hex}\"_. \ No newline at end of file