+colorFormats howto

OpenAF · Mar 20, 2024 · b9f6403 · b9f6403
1 parent 6567b5c
commit b9f6403
Show file tree

Hide file tree

Showing 9 changed files with 38 additions and 0 deletions.
diff --git a/docs/howto/color-formats.md b/docs/howto/color-formats.md
@@ -0,0 +1,38 @@
+---
+layout: default
+title: How To - Change color formats
+parent: How To
+grand_parent: OpenAF docs
+---
+
+# How to - Change color formats
+
+Starting on versions >= 20240318 it's possible to change the colors used by the OpenAF console and functions such as _printTree_, _printMap_, _printTable_ and similar effectively changing out OpenAF outputs look like.
+
+This is controlled by the internal global variable **__colorFormat**. The default values are choosen to work with the majority of terminals and both light and dark backgrounds:
+
+| light | dark |
+|---|---|
+| ![light background](colorFormatLight.png) | ![dark background](colorFormatDark.png) |
+
+On terminals that support 256 colors (or more) it's possible to have other color formats. You can change the values directly on the **__colorFormat** variable or use the ojob ```ojob ojob.io/oaf/colorFormats``` to change to predefined "themes":
+
+| theme | ojob command | output |
+|-------|--------------|--------|
+| **basic** (with rectangular borders) | ```ojob ojob.io/oaf/colorFormats op=set theme=basic``` | ![basic](colorFormatBasic.png) |
+| **default** (the original) | ```ojob ojob.io/oaf/colorFormats op=unset``` | ![light background](colorFormatLight.png) |
+| **thin-light** | ```ojob ojob.io/oaf/colorFormats op=set theme=thin-light``` | ![thin light](colorFormatThinLight.png) |
+| **thin-light-bold** | ```ojob ojob.io/oaf/colorFormats op=set theme=thin-light-bold``` | ![thing light bold](colorFormatThinLightBold.png) |
+| **thin** | ```ojob ojob.io/oaf/colorFormats op=set theme=thin``` | ![thin](colorFormatThin.png) |
+| **thin-bold** | ```ojob ojob.io/oaf/colorFormats op=set theme=thin-bold``` | ![thin bold](colorFormatThinBold.png) |
+| **mono2** | ```ojob ojob.io/oaf/colorFormats op=set theme=mono2``` | ![mono2](colorFormatMono2.png) |
+
+You can explore these and other themes by executing: 
+
+```bash
+ojob ojob.io/oaf/colorFormats op=list
+```
+
+On the provided list there is also the necessary value change to the **__colorFormat** global variable for each theme. You can, of course, customize it to what suits your needs and eyes.
+
+> This is a per user setting stored in $HOME/.openaf_profile or $OAF_HOME/.openaf_profile.
diff --git a/docs/howto/colorFormatBasic.png b/docs/howto/colorFormatBasic.png
diff --git a/docs/howto/colorFormatDark.png b/docs/howto/colorFormatDark.png
diff --git a/docs/howto/colorFormatLight.png b/docs/howto/colorFormatLight.png
diff --git a/docs/howto/colorFormatMono2.png b/docs/howto/colorFormatMono2.png
diff --git a/docs/howto/colorFormatThin.png b/docs/howto/colorFormatThin.png
diff --git a/docs/howto/colorFormatThinBold.png b/docs/howto/colorFormatThinBold.png
diff --git a/docs/howto/colorFormatThinLight.png b/docs/howto/colorFormatThinLight.png
diff --git a/docs/howto/colorFormatThinLightBold.png b/docs/howto/colorFormatThinLightBold.png