Add documentation for paren match overrides

2026-09-10 07:16:30 -04:00 · 2022-12-30 06:03:15 +02:00 · 2022-12-30 06:03:15 +02:00 · 492d31db41
parent 52a848e42c
commit 492d31db41
2 changed files with 169 additions and 107 deletions
--- a/doc/modus-themes.info
+++ b/doc/modus-themes.info
@ -120,6 +120,7 @@ Stylistic variants using palette overrides
 * Make prompts more or less colorful::
 * Make completion matches more or less colorful::
 * Make use of alternative styles for code syntax::
+* Make matching parenthesis more or less intense::
 * Make box buttons more or less gray::
 * Make TODO and DONE more or less intense::
 * Make headings more or less colorful::
@ -1337,6 +1338,7 @@ Palette override presets::).
 * Make prompts more or less colorful::
 * Make completion matches more or less colorful::
 * Make use of alternative styles for code syntax::
+* Make matching parenthesis more or less intense::
 * Make box buttons more or less gray::
 * Make TODO and DONE more or less intense::
 * Make headings more or less colorful::
@ -1551,7 +1553,7 @@ colors to two:
   The user can mix and match to their liking.


-File: modus-themes.info,  Node: Make use of alternative styles for code syntax,  Next: Make box buttons more or less gray,  Prev: Make completion matches more or less colorful,  Up: Stylistic variants using palette overrides
+File: modus-themes.info,  Node: Make use of alternative styles for code syntax,  Next: Make matching parenthesis more or less intense,  Prev: Make completion matches more or less colorful,  Up: Stylistic variants using palette overrides

 4.11.2.6 Make use of alternative styles for code syntax
 .......................................................
@ -1637,9 +1639,38 @@ palette.
             (variable cyan-warmer)))


-File: modus-themes.info,  Node: Make box buttons more or less gray,  Next: Make TODO and DONE more or less intense,  Prev: Make use of alternative styles for code syntax,  Up: Stylistic variants using palette overrides
+File: modus-themes.info,  Node: Make matching parenthesis more or less intense,  Next: Make box buttons more or less gray,  Prev: Make use of alternative styles for code syntax,  Up: Stylistic variants using palette overrides

-4.11.2.7 Make box buttons more or less gray
+4.11.2.7 Make matching parenthesis more or less intense
+.......................................................
+
+This is one of our practical examples to override the semantic colors of
+the Modus themes (*note Stylistic variants using palette overrides::).
+In this code block we show how to change the background of matching
+delimiters when ‘show-paren-mode’ is enabled.  We also demonstrate how
+to enable underlines for those highlights.
+
+     ;; These overrides are common to all Modus themes.  We also provide
+     ;; theme-specific options, such as `modus-operandi-palette-overrides'.
+     ;;
+     ;; In general, the theme-specific overrides are better for overriding
+     ;; color values, such as redefining what `blue-faint' looks like.  The
+     ;; common overrides are best used for changes to semantic color
+     ;; mappings, as we show below.
+
+     ;; Change the background to a shade of magenta
+     (setq modus-themes-common-palette-overrides
+           '((bg-paren-match bg-magenta-intense)))
+
+     ;; Enable underlines by applying a color to them
+     (setq modus-themes-common-palette-overrides
+           '((bg-paren-match bg-magenta-intense)
+             (underline-paren-match fg-main)))
+
+
+File: modus-themes.info,  Node: Make box buttons more or less gray,  Next: Make TODO and DONE more or less intense,  Prev: Make matching parenthesis more or less intense,  Up: Stylistic variants using palette overrides
+
+4.11.2.8 Make box buttons more or less gray
 ...........................................

 This is one of our practical examples to override the semantic colors of
@ -1665,7 +1696,7 @@ gray from the active buttons and amplifies it for the inactive ones.

 File: modus-themes.info,  Node: Make TODO and DONE more or less intense,  Next: Make headings more or less colorful,  Prev: Make box buttons more or less gray,  Up: Stylistic variants using palette overrides

-4.11.2.8 Make TODO and DONE more or less intense
+4.11.2.9 Make TODO and DONE more or less intense
 ................................................

 This is one of our practical examples to override the semantic colors of
@ -1702,8 +1733,8 @@ subdue them.

 File: modus-themes.info,  Node: Make headings more or less colorful,  Next: Make Org agenda more or less colorful,  Prev: Make TODO and DONE more or less intense,  Up: Stylistic variants using palette overrides

-4.11.2.9 Make headings more or less colorful
-............................................
+4.11.2.10 Make headings more or less colorful
+.............................................

 This is one of our practical examples to override the semantic colors of
 the Modus themes (*note Stylistic variants using palette overrides::).
@ -1759,7 +1790,7 @@ less intense.

 File: modus-themes.info,  Node: Make Org agenda more or less colorful,  Prev: Make headings more or less colorful,  Up: Stylistic variants using palette overrides

-4.11.2.10 Make Org agenda more or less colorful
+4.11.2.11 Make Org agenda more or less colorful
 ...............................................

 This is one of our practical examples to override the semantic colors of
@ -5072,106 +5103,107 @@ B.3 Concept index

 Tag Table:
 Node: Top874
-Node: Overview6753
-Node: How do the themes look like9151
-Node: Learn about the latest changes9510
-Node: Installation9898
-Node: Install manually from source10828
-Node: Install from the archives11653
-Node: Install on GNU/Linux12252
-Node: Debian 11 Bullseye12745
-Node: GNU Guix13155
-Node: Dealing with byte compilation errors13438
-Node: Enable and load14596
-Node: Sample configuration with and without use-package17286
-Node: Differences between loading and enabling20084
-Node: Customization options22130
-Node: Custom reload theme26068
-Node: Bold constructs27066
-Node: Italic constructs27902
-Node: Mixed fonts28673
-Node: Command prompts29669
-Node: Completion UIs31621
-Node: Active region34619
-Node: Org mode blocks36044
-Node: Heading styles37923
-Node: UI typeface42505
-Node: Palette overrides43436
-Node: Palette override presets47868
-Node: Stylistic variants using palette overrides49528
-Node: Make the mode line borderless50634
-Node: Make the active mode line colorful51778
-Node: Make links use subtle or no underlines53683
-Node: Make prompts more or less colorful54678
-Node: Make completion matches more or less colorful56348
-Node: Make use of alternative styles for code syntax60163
-Node: Make box buttons more or less gray63708
-Node: Make TODO and DONE more or less intense65018
-Node: Make headings more or less colorful66663
-Node: Make Org agenda more or less colorful69067
-Node: Advanced customization71748
-Node: More accurate colors in terminal emulators73177
-Node: Range of color with terminal emulators74418
-Node: Preview theme colors77132
-Node: Per-theme customization settings78869
-Node: Use the theme colors in custom code (modus-themes-with-colors)80242
-Node: Remap face with local value82076
-Node: Font configurations for Org and others84543
-Ref: Font configurations for Org and others-Footnote-187450
-Node: Configure bold and italic faces87637
-Node: Custom Org todo keyword and priority faces91800
-Node: Custom Org emphasis faces95363
-Node: Update Org block delimiter fontification100186
-Node: Measure color contrast102103
-Node: Load theme depending on time of day104801
-Node: Backdrop for pdf-tools105809
-Node: Toggle themes without reloading them108672
-Node: A theme-agnostic hook for theme loading109948
-Node: Custom hl-todo colors112370
-Node: Add support for solaire-mode113895
-Node: Face coverage116814
-Node: Supported packages117266
-Node: Indirectly covered packages122659
-Node: Notes on individual packages124012
-Node: Note on calendarel weekday and weekend colors125112
-Node: Note on git-gutter in Doom Emacs126260
-Node: Note on php-mode multiline comments128612
-Node: Note on underlines in compilation buffers129365
-Node: Note on inline Latex in Org buffers130202
-Node: Note on dimmerel130812
-Node: Note on display-fill-column-indicator-mode132297
-Node: Note on highlight-parenthesesel133704
-Node: Note on mmm-modeel background colors139682
-Node: Note for prism141990
-Node: Note on company-mode overlay pop-up145166
-Ref: Note on company-mode overlay pop-up-Footnote-1145896
-Ref: Note on company-mode overlay pop-up-Footnote-2145963
-Node: Note on ERC escaped color sequences146018
-Ref: Note on ERC escaped color sequences-Footnote-1147446
-Node: Note on powerline or spaceline147556
-Node: Note on SHR colors147970
-Node: Note on SHR fonts148394
-Node: Note on Ement colors and fonts149033
-Node: Note on pdf-tools link hints150543
-Node: Note on the Notmuch logo153003
-Node: Note on goto-address-mode faces153541
-Node: Frequently Asked Questions154653
-Node: Is the contrast ratio about adjacent colors?155284
-Node: What does it mean to avoid exaggerations?156791
-Node: Why are colors mostly variants of blue magenta cyan?158641
-Node: What is the best setup for legibility?162947
-Node: Are these color schemes?165592
-Node: Port the Modus themes to other platforms?169274
-Node: Contributing172046
-Node: Sources of the themes172443
-Node: Issues you can help with173338
-Node: Patches require copyright assignment to the FSF174729
-Node: Acknowledgements176949
-Node: GNU Free Documentation License180688
-Node: Indices206052
-Node: Function index206231
-Node: Variable index207271
-Node: Concept index209170
+Node: Overview6804
+Node: How do the themes look like9202
+Node: Learn about the latest changes9561
+Node: Installation9949
+Node: Install manually from source10879
+Node: Install from the archives11704
+Node: Install on GNU/Linux12303
+Node: Debian 11 Bullseye12796
+Node: GNU Guix13206
+Node: Dealing with byte compilation errors13489
+Node: Enable and load14647
+Node: Sample configuration with and without use-package17337
+Node: Differences between loading and enabling20135
+Node: Customization options22181
+Node: Custom reload theme26119
+Node: Bold constructs27117
+Node: Italic constructs27953
+Node: Mixed fonts28724
+Node: Command prompts29720
+Node: Completion UIs31672
+Node: Active region34670
+Node: Org mode blocks36095
+Node: Heading styles37974
+Node: UI typeface42556
+Node: Palette overrides43487
+Node: Palette override presets47919
+Node: Stylistic variants using palette overrides49579
+Node: Make the mode line borderless50736
+Node: Make the active mode line colorful51880
+Node: Make links use subtle or no underlines53785
+Node: Make prompts more or less colorful54780
+Node: Make completion matches more or less colorful56450
+Node: Make use of alternative styles for code syntax60265
+Node: Make matching parenthesis more or less intense63822
+Node: Make box buttons more or less gray65262
+Node: Make TODO and DONE more or less intense66572
+Node: Make headings more or less colorful68217
+Node: Make Org agenda more or less colorful70623
+Node: Advanced customization73304
+Node: More accurate colors in terminal emulators74733
+Node: Range of color with terminal emulators75974
+Node: Preview theme colors78688
+Node: Per-theme customization settings80425
+Node: Use the theme colors in custom code (modus-themes-with-colors)81798
+Node: Remap face with local value83632
+Node: Font configurations for Org and others86099
+Ref: Font configurations for Org and others-Footnote-189006
+Node: Configure bold and italic faces89193
+Node: Custom Org todo keyword and priority faces93356
+Node: Custom Org emphasis faces96919
+Node: Update Org block delimiter fontification101742
+Node: Measure color contrast103659
+Node: Load theme depending on time of day106357
+Node: Backdrop for pdf-tools107365
+Node: Toggle themes without reloading them110228
+Node: A theme-agnostic hook for theme loading111504
+Node: Custom hl-todo colors113926
+Node: Add support for solaire-mode115451
+Node: Face coverage118370
+Node: Supported packages118822
+Node: Indirectly covered packages124215
+Node: Notes on individual packages125568
+Node: Note on calendarel weekday and weekend colors126668
+Node: Note on git-gutter in Doom Emacs127816
+Node: Note on php-mode multiline comments130168
+Node: Note on underlines in compilation buffers130921
+Node: Note on inline Latex in Org buffers131758
+Node: Note on dimmerel132368
+Node: Note on display-fill-column-indicator-mode133853
+Node: Note on highlight-parenthesesel135260
+Node: Note on mmm-modeel background colors141238
+Node: Note for prism143546
+Node: Note on company-mode overlay pop-up146722
+Ref: Note on company-mode overlay pop-up-Footnote-1147452
+Ref: Note on company-mode overlay pop-up-Footnote-2147519
+Node: Note on ERC escaped color sequences147574
+Ref: Note on ERC escaped color sequences-Footnote-1149002
+Node: Note on powerline or spaceline149112
+Node: Note on SHR colors149526
+Node: Note on SHR fonts149950
+Node: Note on Ement colors and fonts150589
+Node: Note on pdf-tools link hints152099
+Node: Note on the Notmuch logo154559
+Node: Note on goto-address-mode faces155097
+Node: Frequently Asked Questions156209
+Node: Is the contrast ratio about adjacent colors?156840
+Node: What does it mean to avoid exaggerations?158347
+Node: Why are colors mostly variants of blue magenta cyan?160197
+Node: What is the best setup for legibility?164503
+Node: Are these color schemes?167148
+Node: Port the Modus themes to other platforms?170830
+Node: Contributing173602
+Node: Sources of the themes173999
+Node: Issues you can help with174894
+Node: Patches require copyright assignment to the FSF176285
+Node: Acknowledgements178505
+Node: GNU Free Documentation License182244
+Node: Indices207608
+Node: Function index207787
+Node: Variable index208827
+Node: Concept index210726

 End Tag Table

--- a/doc/modus-themes.org
+++ b/doc/modus-themes.org
@ -1514,6 +1514,36 @@ theme palette.
        (variable cyan-warmer)))
 #+end_src

+**** Make matching parenthesis more or less intense
+:PROPERTIES:
+:CUSTOM_ID: h:259cf8f5-48ec-4b13-8a69-5d6387094468
+:END:
+
+This is one of our practical examples to override the semantic colors
+of the Modus themes ([[#h:df1199d8-eaba-47db-805d-6b568a577bf3][Stylistic variants using palette overrides]]).  In
+this code block we show how to change the background of matching
+delimiters when ~show-paren-mode~ is enabled.  We also demonstrate how
+to enable underlines for those highlights.
+
+#+begin_src emacs-lisp
+;; These overrides are common to all Modus themes.  We also provide
+;; theme-specific options, such as `modus-operandi-palette-overrides'.
+;;
+;; In general, the theme-specific overrides are better for overriding
+;; color values, such as redefining what `blue-faint' looks like.  The
+;; common overrides are best used for changes to semantic color
+;; mappings, as we show below.
+
+;; Change the background to a shade of magenta
+(setq modus-themes-common-palette-overrides
+      '((bg-paren-match bg-magenta-intense)))
+
+;; Enable underlines by applying a color to them
+(setq modus-themes-common-palette-overrides
+      '((bg-paren-match bg-magenta-intense)
+        (underline-paren-match fg-main)))
+#+end_src
+
 **** Make box buttons more or less gray
 :PROPERTIES:
 :CUSTOM_ID: h:4f6b6ca3-f5bb-4830-8312-baa232305360