Doc: document named placeholders

Author: CarterLi

CHANGELOG.md

@@ -6,12 +6,19 @@ Features:
 * Apply default color palettes in `--file` and `--data` (Logo)
 * Print all presets in `--list-presets` for better Windows support (Windows)
 * Support for guix package manager detection (Packages, Linux)
-* Support named module output formatting placeholders (#796)
-    * Besides the meaningless `--title-format '{6}{7}{8}'`, `--title-format '{user-name-colored}{at-symbol-colored}{host-name-colored}'` is now supported
+* Support named variable placeholders in custom module formattion string (#796)
+    * `--title-format '{user-name-colored}{at-symbol-colored}{host-name-colored}'` is equivalent to `--title-format '{6}{7}{8}'`
+* Support named color placeholders in custom module formattion string
+    * `--<module>-format '{#red}'` is equivalent to `--<module>-format '{#31}'`
+    * `'{#red}'` or `'{#31}'` is preferred over `\u001b[31m` because is more readable and `--pipe` aware (will be ignored in pipe mode)
+    * Supported in `Custom` module too
+    * See `fastfetch -h format` for detail
+* Add option `--color-separator` to set the color of key-value separators
 
 Bugfixes:
 * Don't detect `.conf` files in `--list-config-paths`
 * Don't try to detect terminals in MSYS shell with process backtracing (Windows)
+* Fix `outputColor` doesn't work if module keys are disabled
 
 Logos:
 * Add Cereus Linux

src/data/help_format.txt

@@ -4,6 +4,10 @@ For example the format string "Values: {1} ({2})", with the values "First" and "
 The format string can contain placeholders in any order and have multiple occurrences.
 To include spaces when setting from the command line, surround the whole string with double quotes (").
 
+In 2.14.0 or newer, the value indices can be meaningful named tags.
+For example: "--title-format '{user-name-colored}{at-symbol-colored}{host-name-colored}'" is equivalent to "--title-format '{6}{7}{8}'"
+See "fastfetch -h title-format" for all supported tags.
+
 If the value index is missing, meaning the placeholder is "{}", an internal counter sets the value index.
 This means that the format string "Values: {1} ({2})" is equivalent to "Values: {} ({})".
 Note that this counter only counts empty placeholders, so the format string "{2} {} {}" will contain the second value, then the first, and then the second again.
@@ -24,7 +28,7 @@ To stop formatting at any point in the format string, use "{-}".
 To print something with color, start a placeholder with a '#' and then the linux terminal color encoding.
 "\033[" at the start, and an 'm' at the end is automatically added, so don't do that.
 A "{#}" is equivalent to a "{#0}" and resets everything to normal.
-For example to print something pink and underline, use "{#4;35}...{#}". "{#underline_magenta}" is also supported.
+For example to print something pink and underline, use "{#4;35}...{#}". "{#underline_magenta}" is also supported. See `fastfetch -h color` for detail.
 Information about what the numbers mean can be found here: https://en.wikipedia.org/wiki/ANSI_escape_code#SGR_(Select_Graphic_Rendition)_parameters.
 Which escape codes are supported and how they look is defined by your terminal.