[elpa] externals/modus-operandi-theme 52a8c0c 62/99: Clarify customisation symbols and possible values

[Stefan Monnier]

branch: externals/modus-operandi-theme
commit 52a8c0c550ce95d6c00488e8edad4c098ec425e7
Author: Protesilaos Stavrou <info@protesilaos.com>
Commit: Protesilaos Stavrou <info@protesilaos.com>

    Clarify customisation symbols and possible values
---
 README.org | 70 ++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
 1 file changed, 70 insertions(+)

diff --git a/README.org b/README.org
index d1a3afe..99255c8 100644
--- a/README.org
+++ b/README.org
@@ -343,9 +343,16 @@ provide the elements of differentiation.
    :CUSTOM_ID: h:c1c9a380-7a05-4c0d-b714-2acac88f10ad
    :END:
 
+Symbol names:
+
 + =modus-operandi-theme-section-headings=
 + =modus-vivendi-theme-section-headings=
 
+Possible values:
+
+1. =nil= (default)
+2. =t=
+
 Uses a background colour and an overline to mark section headings in
 =org-mode= and =outline-mode=.  These attributes are applied in addition to
 the existing foreground colour and the bold weight and can, therefore,
@@ -369,9 +376,16 @@ text, use this:
    :CUSTOM_ID: h:db0275ea-11c2-47c9-82a9-10b65d8df0f8
    :END:
 
+Symbol names:
+
 + =modus-operandi-theme-scale-headings=
 + =modus-vivendi-theme-scale-headings=
 
+Possible values:
+
+1. =nil= (default)
+2. =t=
+
 Make headings larger in size relative to the main text.  This is
 noticeable in modes like Org.  The default is to use the same size for
 headers and body copy.
@@ -416,9 +430,16 @@ keywords scale accordingly (see [[*Font configurations for 
Org (and others)][iss
    :CUSTOM_ID: h:d989f116-7559-40bc-bf94-ef508d480960
    :END:
 
+Symbol names:
+
 + =modus-operandi-theme-visible-fringe=
 + =modus-vivendi-theme-visible-fringe=
 
+Possible values:
+
+1. =nil= (default)
+2. =t=
+
 When enabled, this will render the fringes in a subtle background
 colour.
 
@@ -431,9 +452,16 @@ space given to them by =fringe-mode= (8px on either side 
by default).
    :CUSTOM_ID: h:cb327797-b303-47c5-8171-4587a911ccc2
    :END:
 
+Symbol names:
+
 + =modus-operandi-theme-slanted-constructs=
 + =modus-vivendi-theme-slanted-constructs=
 
+Possible values:
+
+1. =nil= (default)
+2. =t=
+
 Choose to render more faces in slanted text (italics).  This typically
 affects documentation strings and code comments.
 
@@ -444,9 +472,16 @@ The default is to not use italics unless it is absolutely 
necessary.
    :CUSTOM_ID: h:9a77e814-5eca-488f-9a67-119a95c2d28a
    :END:
 
+Symbol names:
+
 + =modus-operandi-theme-bold-constructs=
 + =modus-vivendi-theme-bold-constructs=
 
+Possible values:
+
+1. =nil= (default)
+2. =t=
+
 Display several constructs in bold weight.  This concerns keywords and
 other important aspects of code syntax.  It also affects certain mode
 line indicators.
@@ -458,9 +493,16 @@ The default is to only use a bold weight when it is 
necessary.
    :CUSTOM_ID: h:ce155208-fdd6-4ada-9e0c-54aab7e2aff8
    :END:
 
+Symbol names:
+
 + =modus-operandi-theme-3d-modeline=
 + =modus-vivendi-theme-3d-modeline=
 
+Possible values:
+
+1. =nil= (default)
+2. =t=
+
 Use a three-dimensional, "released button" effect for the focused
 window's mode line.  When enabled, this option will also affect the
 styles of any inactive mode lines, making them slightly less intense in
@@ -475,9 +517,16 @@ inactive ones.
    :CUSTOM_ID: h:e3933a53-cbd9-4e44-958a-1d6d133f0816
    :END:
 
+Symbol names:
+
 + =modus-operandi-theme-subtle-diff=
 + =modus-vivendi-theme-subtle-diff=
 
+Possible values:
+
+1. =nil= (default)
+2. =t=
+
 Display =diff-mode=, =ediff=, =smerge-mode=, =magit= diff buffers with fewer
 and/or less intense background colours or, where possible, with no
 background colours applied to the presentation of the added and removed
@@ -495,9 +544,16 @@ default equivalent.
    :CUSTOM_ID: h:9f05eef0-9d0d-4305-98a1-c4e49f41e1c8
    :END:
 
+Symbol names:
+
 + =modus-operandi-theme-faint-syntax=
 + =modus-vivendi-theme-faint-syntax=
 
+Possible values:
+
+1. =nil= (default)
+2. =t=
+
 Use less saturated colours in programming modes for highlighting code
 syntax.  The intent is to offer an impression of minimalism.  The
 default is to use saturated colours.
@@ -519,9 +575,16 @@ feedback would be much appreciated.  See 
[[https://gitlab.com/protesilaos/modus-
    :CUSTOM_ID: h:5b0b1e66-8287-4f3f-ba14-011c29320a3f
    :END:
 
+Symbol names:
+
 + =modus-operandi-theme-intense-standard-completions=
 + =modus-vivendi-theme-intense-standard-completions=
 
+Possible values:
+
+1. =nil= (default)
+2. =t=
+
 Display faces for built-in completion frameworks, such as =icomplete=,
 with a combination of background and foreground colours.  This covers
 every completion interface that either is part of the upstream Emacs
@@ -540,9 +603,16 @@ matching characters or items of standard completion tools.
    :CUSTOM_ID: h:33023fa6-6482-45d4-9b5e-3c73c945718f
    :END:
 
+Symbol names:
+
 + =modus-operandi-theme-proportional-fonts=
 + =modus-vivendi-theme-proportional-fonts=
 
+Possible values:
+
+1. =nil= (default)
+2. =t=
+
 Choose to apply a proportionately-spaced typeface to headings (such as
 in Org mode).  The default is to use whatever the main typeface is,
 typically a monospaced family.