[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]
[elpa] externals/modus-operandi-theme d09be79 030/153: Expand docstring
From: |
Stefan Monnier |
Subject: |
[elpa] externals/modus-operandi-theme d09be79 030/153: Expand docstring of new headings' alist option |
Date: |
Thu, 18 Mar 2021 13:47:32 -0400 (EDT) |
branch: externals/modus-operandi-theme
commit d09be79c223eb48352d18e70cdb670da36d52ead
Author: Protesilaos Stavrou <info@protesilaos.com>
Commit: Protesilaos Stavrou <info@protesilaos.com>
Expand docstring of new headings' alist option
* modus-operandi-theme.el (modus-operandi-theme-headings): Expand
documentation string with practical examples and a description of
what each value represents.
* modus-vivendi-theme.el (modus-vivendi-theme-headings): Expand
documentation string with practical examples and a description of
what each value represents.
For an ongoing discussion, refer to issue 81:
https://gitlab.com/protesilaos/modus-themes/-/issues/81
---
modus-operandi-theme.el | 78 +++++++++++++++++++++++++++++++++++++++++++++----
modus-vivendi-theme.el | 78 +++++++++++++++++++++++++++++++++++++++++++++----
2 files changed, 144 insertions(+), 12 deletions(-)
diff --git a/modus-operandi-theme.el b/modus-operandi-theme.el
index 5d6e923..f07863f 100644
--- a/modus-operandi-theme.el
+++ b/modus-operandi-theme.el
@@ -459,20 +459,86 @@ between foreground and background is >= 7:1)."
(defcustom modus-operandi-theme-headings
'((t . nil))
- "Alist of styles for headings."
+ "Alist of styles for headings, with optional value per level.
+
+To control faces per level from 1-8, use something like this:
+
+ (setq modus-operandi-theme-headings
+ '((1 . highlight)
+ (2 . line)
+ (t . rainbow-line-no-bold)))
+
+To set a uniform value for all heading levels, use this pattern:
+
+ (setq modus-operandi-theme-headings
+ '((t . rainbow-line-no-bold)))
+
+The default uses a fairly desaturated foreground value in
+combination with a bold typographic weight. To specify this
+style for a given level N (assuming you wish to have another
+fallback option), just specify the value t like this:
+
+ (setq modus-operandi-theme-headings
+ '((1 . t)
+ (2 . line)
+ (t . rainbow-line-no-bold)))
+
+A description of all possible values:
+
++ `no-bold' retains the default text colour while removing
+ the typographic weight.
+
++ `line' is the same as the default plus an overline over the
+ heading.
+
++ `line-no-bold' is the same as `line' without bold weight.
+
++ `rainbow' uses a more colourful foreground in combination
+ with bold weight.
+
++ `rainbow-line' is the same as `rainbow' plus an overline.
+
++ `rainbow-line-no-bold' is the same as `rainbow-line' without
+ the bold weight.
+
++ `highlight' retains the default style of a fairly desaturated
+ foreground combined with a bold weight and add to it a subtle
+ accented background.
+
++ `highlight-no-bold' is the same as `highlight' without a bold
+ weight.
+
++ `rainbow-highlight' is the same as `highlight' but with a more
+ colourful foreground.
+
++ `rainbow-highlight-no-bold' is the same as `rainbow-highlight'
+ without a bold weight.
+
++ `section' retains the default looks and adds to them both an
+ overline and a slightly accented background. It is, in effect,
+ a combination of the `line' and `highlight' values.
+
++ `section-no-bold' is the same as `section' without a bold
+ weight.
+
++ `rainbow-section' is the same as `section' but with a more
+ colourful foreground.
+
++ `rainbow-section-no-bold' is the same as `rainbow-section'
+ without a bold weight."
:type
'(alist
:key-type symbol
:value-type
- (choice (const :tag "Fairly desaturated foreground with bold weight
(default)" nil)
- (const :tag "Like `nil' without bold weight" no-bold)
- (const :tag "Like `nil' plus overline" line)
+ (choice (const :tag "Fairly desaturated foreground with bold weight
(default)" t)
+ (const :tag "Like the default without bold weight" no-bold)
+ (const :tag "Like the default plus overline" line)
(const :tag "Like `line' without bold weight" line-no-bold)
- (const :tag "Like `nil' but with more colourful foreground"
rainbow)
+ (const :tag "Like the default but with more colourful foreground"
rainbow)
(const :tag "Like `rainbow' plus overline" rainbow-line)
(const :tag "Like `rainbow' without bold weight" rainbow-no-bold)
(const :tag "Like `rainbow-line' without bold weight"
rainbow-line-no-bold)
- (const :tag "Like `nil' plus subtle background" highlight)
+ (const :tag "Like the default plus subtle background" highlight)
(const :tag "Like `highlight' without bold weight"
highlight-no-bold)
(const :tag "Like `highlight' with more colourful foreground"
rainbow-highlight)
(const :tag "Like `rainbow-highlight' without bold weight"
rainbow-highlight-no-bold)
diff --git a/modus-vivendi-theme.el b/modus-vivendi-theme.el
index 6518324..5e4978b 100644
--- a/modus-vivendi-theme.el
+++ b/modus-vivendi-theme.el
@@ -459,20 +459,86 @@ between foreground and background is >= 7:1)."
(defcustom modus-vivendi-theme-headings
'((t . nil))
- "Alist of styles for headings."
+ "Alist of styles for headings, with optional value per level.
+
+To control faces per level from 1-8, use something like this:
+
+ (setq modus-vivendi-theme-headings
+ '((1 . highlight)
+ (2 . line)
+ (t . rainbow-line-no-bold)))
+
+To set a uniform value for all heading levels, use this pattern:
+
+ (setq modus-vivendi-theme-headings
+ '((t . rainbow-line-no-bold)))
+
+The default uses a fairly desaturated foreground value in
+combination with a bold typographic weight. To specify this
+style for a given level N (assuming you wish to have another
+fallback option), just specify the value t like this:
+
+ (setq modus-vivendi-theme-headings
+ '((1 . t)
+ (2 . line)
+ (t . rainbow-line-no-bold)))
+
+A description of all possible values:
+
++ `no-bold' retains the default text colour while removing
+ the typographic weight.
+
++ `line' is the same as the default plus an overline over the
+ heading.
+
++ `line-no-bold' is the same as `line' without bold weight.
+
++ `rainbow' uses a more colourful foreground in combination
+ with bold weight.
+
++ `rainbow-line' is the same as `rainbow' plus an overline.
+
++ `rainbow-line-no-bold' is the same as `rainbow-line' without
+ the bold weight.
+
++ `highlight' retains the default style of a fairly desaturated
+ foreground combined with a bold weight and add to it a subtle
+ accented background.
+
++ `highlight-no-bold' is the same as `highlight' without a bold
+ weight.
+
++ `rainbow-highlight' is the same as `highlight' but with a more
+ colourful foreground.
+
++ `rainbow-highlight-no-bold' is the same as `rainbow-highlight'
+ without a bold weight.
+
++ `section' retains the default looks and adds to them both an
+ overline and a slightly accented background. It is, in effect,
+ a combination of the `line' and `highlight' values.
+
++ `section-no-bold' is the same as `section' without a bold
+ weight.
+
++ `rainbow-section' is the same as `section' but with a more
+ colourful foreground.
+
++ `rainbow-section-no-bold' is the same as `rainbow-section'
+ without a bold weight."
:type
'(alist
:key-type symbol
:value-type
- (choice (const :tag "Fairly desaturated foreground with bold weight
(default)" nil)
- (const :tag "Like `nil' without bold weight" no-bold)
- (const :tag "Like `nil' plus overline" line)
+ (choice (const :tag "Fairly desaturated foreground with bold weight
(default)" t)
+ (const :tag "Like the default without bold weight" no-bold)
+ (const :tag "Like the default plus overline" line)
(const :tag "Like `line' without bold weight" line-no-bold)
- (const :tag "Like `nil' but with more colourful foreground"
rainbow)
+ (const :tag "Like the default but with more colourful foreground"
rainbow)
(const :tag "Like `rainbow' plus overline" rainbow-line)
(const :tag "Like `rainbow' without bold weight" rainbow-no-bold)
(const :tag "Like `rainbow-line' without bold weight"
rainbow-line-no-bold)
- (const :tag "Like `nil' plus subtle background" highlight)
+ (const :tag "Like the default plus subtle background" highlight)
(const :tag "Like `highlight' without bold weight"
highlight-no-bold)
(const :tag "Like `highlight' with more colourful foreground"
rainbow-highlight)
(const :tag "Like `rainbow-highlight' without bold weight"
rainbow-highlight-no-bold)
- [elpa] externals/modus-operandi-theme 2968c4a 002/153: The themes are now part of upstream GNU Emacs, (continued)
- [elpa] externals/modus-operandi-theme 2968c4a 002/153: The themes are now part of upstream GNU Emacs, Stefan Monnier, 2021/03/18
- [elpa] externals/modus-operandi-theme 53606c6 011/153: Remove support for obsolete objed-extend face, Stefan Monnier, 2021/03/18
- [elpa] externals/modus-operandi-theme 9fed8eb 033/153: Update the manual's example to include new option, Stefan Monnier, 2021/03/18
- [elpa] externals/modus-operandi-theme d9fa0ff 021/153: Add missing metadata to info manual, Stefan Monnier, 2021/03/18
- [elpa] externals/modus-operandi-theme e596487 025/153: Add README in markdown format, Stefan Monnier, 2021/03/18
- [elpa] externals/modus-operandi-theme 619e48b 045/153: Tweak custom fonts section in the manual, Stefan Monnier, 2021/03/18
- [elpa] externals/modus-operandi-theme 113ab25 032/153: Simplify style of org-special-keyword, Stefan Monnier, 2021/03/18
- [elpa] externals/modus-operandi-theme 00f8a28 044/153: Update README to note that the manual is available, Stefan Monnier, 2021/03/18
- [elpa] externals/modus-operandi-theme 72c0714 038/153: Add support for eshell-syntax-highlighting, Stefan Monnier, 2021/03/18
- [elpa] externals/modus-operandi-theme 0633c2a 047/153: Recompile manual (cover 619e48bbc and decf274f4), Stefan Monnier, 2021/03/18
- [elpa] externals/modus-operandi-theme d09be79 030/153: Expand docstring of new headings' alist option,
Stefan Monnier <=
- [elpa] externals/modus-operandi-theme d5b6321 028/153: Initial implementation of reviewed headings option, Stefan Monnier, 2021/03/18
- [elpa] externals/modus-operandi-theme 7789ae9 004/153: Clarify the version numbers that ship with Emacs, Stefan Monnier, 2021/03/18
- [elpa] externals/modus-operandi-theme 95ac8b4 020/153: Re-organise new doc files, Stefan Monnier, 2021/03/18
- [elpa] externals/modus-operandi-theme 49872b0 031/153: Expand manual with new heading styles alist option, Stefan Monnier, 2021/03/18
- [elpa] externals/modus-operandi-theme 3d00716 049/153: Use distinct colour for info-menu-star, Stefan Monnier, 2021/03/18
- [elpa] externals/modus-operandi-theme a745281 053/153: Minor tweaks to custom modeline 'moody' option, Stefan Monnier, 2021/03/18
- [elpa] externals/modus-operandi-theme decf274 046/153: Add manual entry on Org user faces (DIY), Stefan Monnier, 2021/03/18
- [elpa] externals/modus-operandi-theme 0e45c0a 056/153: Reword manual's entry on Org user faces, Stefan Monnier, 2021/03/18
- [elpa] externals/modus-operandi-theme ab61e17 029/153: Several refinements to new headings custom alist, Stefan Monnier, 2021/03/18
- [elpa] externals/modus-operandi-theme 6fee2d0 055/153: Make the README a bit more informative, Stefan Monnier, 2021/03/18