From ea687baebdd173490af60d5a7e7d65ff591ee257 Mon Sep 17 00:00:00 2001 From: Tom Jaspers Date: Thu, 29 Jan 2015 14:05:00 +0100 Subject: [PATCH] Configurable colors: update documentation and changelog --- docs/changelog.rst | 4 ++++ docs/reference/config.rst | 50 +++++++++++++++++++++++++++++++++------ 2 files changed, 47 insertions(+), 7 deletions(-) diff --git a/docs/changelog.rst b/docs/changelog.rst index c10a64981..0cfc279ce 100644 --- a/docs/changelog.rst +++ b/docs/changelog.rst @@ -6,6 +6,10 @@ Changelog Features: +* The colors used are now configurable via the new config option ``colors``, + nested under the option ``ui``. The `color` config option has been moved + from top-level to under ``ui``. Beets will respect the old color setting, + but will warn the user with a deprecation message. :bug:`1238` * A new :doc:`/plugins/filefilter` lets you write regular expressions to automatically avoid importing certain files. Thanks to :user:`mried`. :bug:`1186` diff --git a/docs/reference/config.rst b/docs/reference/config.rst index 7782e4ad8..a64e73749 100644 --- a/docs/reference/config.rst +++ b/docs/reference/config.rst @@ -162,13 +162,6 @@ Either ``yes`` or ``no``, indicating whether the autotagger should use multiple threads. This makes things faster but may behave strangely. Defaults to ``yes``. -color -~~~~~ - -Either ``yes`` or ``no``; whether to use color in console output (currently -only in the ``import`` command). Turn this off if your terminal doesn't -support ANSI colors. - .. _list_format_item: list_format_item @@ -277,6 +270,49 @@ version of ID3. Enable this option to instead use the older ID3v2.3 standard, which is preferred by certain older software such as Windows Media Player. +UI Options +---------- + +The options that allow for customization of the visual appearance +of the console interface. + +These options are available in this section: + +color +~~~~~ + +Either ``yes`` or ``no``; whether to use color in console output (currently +only in the ``import`` command). Turn this off if your terminal doesn't +support ANSI colors. + +.. note:: + + The `color` option was previously a top-level configuration. This is + still respected, but a deprecation message will be shown until your + top-level `color` configuration has been nested under `ui`. + +colors +~~~~~~ + +The colors that are used throughout the user interface. These are only used if +the ``color`` option is set to ``yes``. For example, you might have a section +in your configuration file that looks like this:: + + ui: + color: yes + colors: + text_success: green + text_warning: yellow + text_error: red + text_highlight: red + text_highlight_minor: lightgray + action_default: turquoise + action: blue + +Available colors: black, darkred, darkgreen, brown, darkblue, purple, teal, +lightgray, darkgray, red, green, yellow, blue, fuchsia, turquoise, white + + Importer Options ----------------