branch: externals/modus-themes
commit a1149ce5e7070dd303ec8d09af057d05f8c6e227
Author: Protesilaos Stavrou <[email protected]>
Commit: Protesilaos Stavrou <[email protected]>

    Clarify that a derivative theme has to be in a file among 
custom-theme-load-path
    
    Thanks to Ashton Wiersdorf for asking for clarification about this in
    issue 171: <https://github.com/protesilaos/modus-themes/issues/171>.
---
 doc/modus-themes.info | 177 +++++++++++++++++++++++++-------------------------
 doc/modus-themes.org  |  79 +++++++++++-----------
 2 files changed, 131 insertions(+), 125 deletions(-)

diff --git a/doc/modus-themes.info b/doc/modus-themes.info
index 8a8cd05031..dd6af827c4 100644
--- a/doc/modus-themes.info
+++ b/doc/modus-themes.info
@@ -4321,12 +4321,15 @@ two such case.  Developers may do so to benefit from 
the extensive
 customization of the Modus themes and the fact that they are part of
 core Emacs.
 
-   A new theme can be instantiated with the function
-‘modus-themes-theme’.  It takes care to (i) declare the theme, (ii) add
-to it relevant ‘theme-properties’, (iii) register it in the
-‘modus-themes-registered-items’, (iv) make it work with all the faces
-and customizations documented in this manual, and (v) ‘provide-theme’
-the theme.
+   A new theme exists in a file whose directory is in the
+‘custom-theme-load-path’.  The theme file is named ‘NAME-theme.el’.  For
+example, the ‘modus-operandi’ theme is in the file
+‘modus-operandi-theme.el’.  A theme object can be instantiated with the
+function ‘modus-themes-theme’.  This function takes care to (i) declare
+the theme, (ii) add to it relevant ‘theme-properties’, (iii) register it
+in the ‘modus-themes-registered-items’, (iv) make it work with all the
+faces and customizations documented in this manual, and (v)
+‘provide-theme’ the theme.
 
    Concretely, ‘modus-themes-theme’ expects the following mandatory
 arguments:
@@ -6141,40 +6144,40 @@ Ideas and user feedback
      Aaron Jensen, Adam Porter, Adam Spiers, Adrian Manea, Aleksei
      Pirogov, Alex Griffin, Alex Koen, Alex Peitsinis, Alexandr Semenov,
      Alexey Shmalko, Alok Singh, Anders Johansson, André Alexandre
-     Gomes, Andrew Tropin, Antonio Hernández Blas, Arif Rezai, Augusto
-     Stoffel, Basil L. Contovounesios, Bernd Rellermeyer, Burgess Chang,
-     Charlotte Van Petegem, Christian Tietze, Christopher Dimech,
-     Christopher League, Damien Cassou, Daniel Mendler, Dario
-     Gjorgjevski, David Edmondson, Davor Rotim, Divan Santana, Eliraz
-     Kedmi, Emanuele Michele Alberto Monterosso, Eshel Yaron, Farasha
-     Euker, Feng Shu, Filippo Argiolas, Gautier Ponsinet, Gerry
-     Agbobada, Gianluca Recchia, Gonçalo Marrafa, Guilherme Semente,
-     Gustavo Barros, Hörmetjan Yiltiz, Ilja Kocken, Imran Khan, Iris
-     Garcia, Ivan Popovych, Jabir Ali Ouassou, James Ferguson, Jeremy
-     Friesen, Jerry Zhang, Johannes Grødem, John Haman, John Sullivan,
-     John Wick, Jonas Collberg, Jorge Morais, Joshua O'Connor, Julio C.
-     Villasante, Kenta Usami, Kevin Fleming, Kévin Le Gouguec, Kevin
-     Kainan Li, Kostadin Ninev, Laith Bahodi, Lasse Lindner, Len Trigg,
-     Lennart C. Karssen, Luis Miguel Castañeda, Magne Hov, Manuel
-     Giraud, Manuel Uberti, Mark Bestley, Mark Burton, Mark Simpson,
-     Marko Kocic, Markus Beppler, Matt Armstrong, Matthias Fuchs,
-     Mattias Engdegård, Mauro Aranda, Maxime Tréca, Michael Goldenberg,
-     Morgan Smith, Morgan Willcock, Murilo Pereira, Nicky van Foreest,
-     Nicolas De Jaeghere, Nicolas Semrau, Olaf Meeuwissen, Oliver Epper,
-     Pablo Stafforini, Paul Poloskov, Pengji Zhang, Pete Kazmier, Peter
-     Wu, Philip Kaludercic, Pierre Téchoueyres, Przemysław Kryger,
-     Robert Hepple, Roman Rudakov, Russell Sim, Ryan Phillips, Rytis
-     Paškauskas, Rudolf Adamkovič, Sam Kleinman, Samuel Culpepper, Saša
-     Janiška, Shreyas Ragavan, Simon Pugnet, Steve Downey, Tassilo Horn,
-     Thanos Apollo, Thibaut Verron, Thomas Heartman, Togan Muftuoglu,
-     Tony Zorman, Trey Merkley, Tomasz Hołubowicz, Toon Claes, Uri
-     Sharf, Utkarsh Singh, Vincent Foley, Zoltan Kiraly.  As well as
-     users: Ben, CsBigDataHub1, Emacs Contrib, Eugene, Fourchaux,
-     Fredrik, Moesasji, Nick, Summer Emacs, TheBlob42, TitusMu, Trey,
-     bepolymathe, bit9tream, bangedorrunt, case-lambda, chainedghost,
-     derek-upham, doolio, fleimgruber, gitrj95, iSeeU, jixiuf, ltmsyvag,
-     okamsn, pedro-nonfree, pRot0ta1p, shimeike, shipmints, soaringbird,
-     tumashu, wakamenod.
+     Gomes, Andrew Tropin, Antonio Hernández Blas, Arif Rezai, Ashton
+     Wiersdorf, Augusto Stoffel, Basil L. Contovounesios, Bernd
+     Rellermeyer, Burgess Chang, Charlotte Van Petegem, Christian
+     Tietze, Christopher Dimech, Christopher League, Damien Cassou,
+     Daniel Mendler, Dario Gjorgjevski, David Edmondson, Davor Rotim,
+     Divan Santana, Eliraz Kedmi, Emanuele Michele Alberto Monterosso,
+     Eshel Yaron, Farasha Euker, Feng Shu, Filippo Argiolas, Gautier
+     Ponsinet, Gerry Agbobada, Gianluca Recchia, Gonçalo Marrafa,
+     Guilherme Semente, Gustavo Barros, Hörmetjan Yiltiz, Ilja Kocken,
+     Imran Khan, Iris Garcia, Ivan Popovych, Jabir Ali Ouassou, James
+     Ferguson, Jeremy Friesen, Jerry Zhang, Johannes Grødem, John Haman,
+     John Sullivan, John Wick, Jonas Collberg, Jorge Morais, Joshua
+     O'Connor, Julio C.  Villasante, Kenta Usami, Kevin Fleming, Kévin
+     Le Gouguec, Kevin Kainan Li, Kostadin Ninev, Laith Bahodi, Lasse
+     Lindner, Len Trigg, Lennart C. Karssen, Luis Miguel Castañeda,
+     Magne Hov, Manuel Giraud, Manuel Uberti, Mark Bestley, Mark Burton,
+     Mark Simpson, Marko Kocic, Markus Beppler, Matt Armstrong, Matthias
+     Fuchs, Mattias Engdegård, Mauro Aranda, Maxime Tréca, Michael
+     Goldenberg, Morgan Smith, Morgan Willcock, Murilo Pereira, Nicky
+     van Foreest, Nicolas De Jaeghere, Nicolas Semrau, Olaf Meeuwissen,
+     Oliver Epper, Pablo Stafforini, Paul Poloskov, Pengji Zhang, Pete
+     Kazmier, Peter Wu, Philip Kaludercic, Pierre Téchoueyres,
+     Przemysław Kryger, Robert Hepple, Roman Rudakov, Russell Sim, Ryan
+     Phillips, Rytis Paškauskas, Rudolf Adamkovič, Sam Kleinman, Samuel
+     Culpepper, Saša Janiška, Shreyas Ragavan, Simon Pugnet, Steve
+     Downey, Tassilo Horn, Thanos Apollo, Thibaut Verron, Thomas
+     Heartman, Togan Muftuoglu, Tony Zorman, Trey Merkley, Tomasz
+     Hołubowicz, Toon Claes, Uri Sharf, Utkarsh Singh, Vincent Foley,
+     Zoltan Kiraly.  As well as users: Ben, CsBigDataHub1, Emacs
+     Contrib, Eugene, Fourchaux, Fredrik, Moesasji, Nick, Summer Emacs,
+     TheBlob42, TitusMu, Trey, bepolymathe, bit9tream, bangedorrunt,
+     case-lambda, chainedghost, derek-upham, doolio, fleimgruber,
+     gitrj95, iSeeU, jixiuf, ltmsyvag, okamsn, pedro-nonfree, pRot0ta1p,
+     shimeike, shipmints, soaringbird, tumashu, wakamenod.
 
 Packaging
      Basil L. Contovounesios, Eli Zaretskii, Glenn Morris, Mauro Aranda,
@@ -6776,10 +6779,10 @@ B.2 Variable index
 * modus-themes-common-palette-user:      Palette extension.    (line 16)
 * modus-themes-completions:              Completion UIs.       (line  6)
 * modus-themes-custom-variables:         Build on top of the Modus themes.
-                                                               (line 59)
+                                                               (line 62)
 * modus-themes-disable-other-themes:     Disable other themes. (line  6)
 * modus-themes-faces:                    Build on top of the Modus themes.
-                                                               (line 53)
+                                                               (line 56)
 * modus-themes-headings:                 Heading styles.       (line  6)
 * modus-themes-italic-constructs:        Italic constructs.    (line  6)
 * modus-themes-items:                    Option for which themes to rotate.
@@ -6970,51 +6973,51 @@ Node: DIY Add support for combobulate181126
 Node: DIY Use a hook at the post-load-theme phase184749
 Node: DIY A theme-agnostic hook for theme loading186870
 Node: Build on top of the Modus themes189501
-Node: Determine what counts as a Modus theme194921
-Node: Create convenience commands to load a derivative theme198113
-Node: Face coverage200165
-Node: Supported packages200627
-Node: Indirectly covered packages206443
-Node: Notes on individual packages207799
-Node: Note on calendarel weekday and weekend colors208901
-Node: Note on git-gutter in Doom Emacs210051
-Node: Note on php-mode multiline comments212553
-Node: Note on underlines in compilation buffers213315
-Node: Note on inline Latex in Org buffers214189
-Node: Note on dimmerel214801
-Node: Note on display-fill-column-indicator-mode216288
-Node: Note on highlight-parenthesesel217741
-Node: Note on mmm-modeel background colors223820
-Node: Note for prism226174
-Node: Note on company-mode overlay pop-up229388
-Ref: Note on company-mode overlay pop-up-Footnote-1230118
-Ref: Note on company-mode overlay pop-up-Footnote-2230185
-Node: Note on ERC escaped color sequences230240
-Ref: Note on ERC escaped color sequences-Footnote-1231670
-Node: Note on powerline or spaceline231780
-Node: Note on SHR colors232196
-Node: Note on SHR fonts232618
-Node: Note on Ement colors and fonts233307
-Node: Note on pdf-tools link hints234813
-Node: Note on the Notmuch logo237271
-Node: Note on goto-address-mode faces237805
-Node: Frequently Asked Questions238925
-Node: Is the contrast ratio about adjacent colors?239556
-Node: What does it mean to avoid exaggerations?241065
-Node: Why are colors mostly variants of blue magenta cyan?242915
-Node: What is the best setup for legibility?247249
-Node: Are these color schemes?249891
-Node: Port the Modus themes to other platforms?253545
-Node: Contributing256379
-Node: Sources of the themes256778
-Node: Issues you can help with257674
-Node: Patches require copyright assignment to the FSF259066
-Node: Acknowledgements261288
-Node: GNU Free Documentation License265808
-Node: Indices290971
-Node: Function index291150
-Node: Variable index295345
-Node: Concept index299708
+Node: Determine what counts as a Modus theme195158
+Node: Create convenience commands to load a derivative theme198350
+Node: Face coverage200402
+Node: Supported packages200864
+Node: Indirectly covered packages206680
+Node: Notes on individual packages208036
+Node: Note on calendarel weekday and weekend colors209138
+Node: Note on git-gutter in Doom Emacs210288
+Node: Note on php-mode multiline comments212790
+Node: Note on underlines in compilation buffers213552
+Node: Note on inline Latex in Org buffers214426
+Node: Note on dimmerel215038
+Node: Note on display-fill-column-indicator-mode216525
+Node: Note on highlight-parenthesesel217978
+Node: Note on mmm-modeel background colors224057
+Node: Note for prism226411
+Node: Note on company-mode overlay pop-up229625
+Ref: Note on company-mode overlay pop-up-Footnote-1230355
+Ref: Note on company-mode overlay pop-up-Footnote-2230422
+Node: Note on ERC escaped color sequences230477
+Ref: Note on ERC escaped color sequences-Footnote-1231907
+Node: Note on powerline or spaceline232017
+Node: Note on SHR colors232433
+Node: Note on SHR fonts232855
+Node: Note on Ement colors and fonts233544
+Node: Note on pdf-tools link hints235050
+Node: Note on the Notmuch logo237508
+Node: Note on goto-address-mode faces238042
+Node: Frequently Asked Questions239162
+Node: Is the contrast ratio about adjacent colors?239793
+Node: What does it mean to avoid exaggerations?241302
+Node: Why are colors mostly variants of blue magenta cyan?243152
+Node: What is the best setup for legibility?247486
+Node: Are these color schemes?250128
+Node: Port the Modus themes to other platforms?253782
+Node: Contributing256616
+Node: Sources of the themes257015
+Node: Issues you can help with257911
+Node: Patches require copyright assignment to the FSF259303
+Node: Acknowledgements261525
+Node: GNU Free Documentation License266064
+Node: Indices291227
+Node: Function index291406
+Node: Variable index295601
+Node: Concept index299964
 
 End Tag Table
 
diff --git a/doc/modus-themes.org b/doc/modus-themes.org
index d470a9c104..801c47e75b 100644
--- a/doc/modus-themes.org
+++ b/doc/modus-themes.org
@@ -4169,11 +4169,13 @@ core Emacs.
 
 #+findex: modus-themes-theme
 #+vindex: modus-themes-registered-items
-A new theme can be instantiated with the function ~modus-themes-theme~.
-It takes care to (i) declare the theme, (ii) add to it relevant
-~theme-properties~, (iii) register it in the ~modus-themes-registered-items~,
-(iv) make it work with all the faces and customizations documented
-in this manual, and (v) ~provide-theme~ the theme.
+A new theme exists in a file whose directory is in the 
~custom-theme-load-path~.
+The theme file is named =NAME-theme.el=. For example, the ~modus-operandi~
+theme is in the file =modus-operandi-theme.el=. A theme object can be
+instantiated with the function ~modus-themes-theme~. This function takes care 
to
+(i) declare the theme, (ii) add to it relevant ~theme-properties~, (iii) 
register
+it in the ~modus-themes-registered-items~, (iv) make it work with all the faces
+and customizations documented in this manual, and (v) ~provide-theme~ the 
theme.
 
 Concretely, ~modus-themes-theme~ expects the following mandatory arguments:
 
@@ -5963,39 +5965,40 @@ The Modus themes are a collective effort.  Every bit of 
work matters.
   Adrian Manea, Aleksei Pirogov, Alex Griffin, Alex Koen, Alex
   Peitsinis, Alexandr Semenov, Alexey Shmalko, Alok Singh, Anders
   Johansson, André Alexandre Gomes, Andrew Tropin, Antonio Hernández
-  Blas, Arif Rezai, Augusto Stoffel, Basil L.{{{space()}}}
-  Contovounesios, Bernd Rellermeyer, Burgess Chang, Charlotte Van
-  Petegem, Christian Tietze, Christopher Dimech, Christopher League,
-  Damien Cassou, Daniel Mendler, Dario Gjorgjevski, David Edmondson,
-  Davor Rotim, Divan Santana, Eliraz Kedmi, Emanuele Michele Alberto
-  Monterosso, Eshel Yaron, Farasha Euker, Feng Shu, Filippo Argiolas,
-  Gautier Ponsinet, Gerry Agbobada, Gianluca Recchia, Gonçalo Marrafa,
-  Guilherme Semente, Gustavo Barros, Hörmetjan Yiltiz, Ilja Kocken,
-  Imran Khan, Iris Garcia, Ivan Popovych, Jabir Ali Ouassou, James
-  Ferguson, Jeremy Friesen, Jerry Zhang, Johannes Grødem, John Haman,
-  John Sullivan, John Wick, Jonas Collberg, Jorge Morais, Joshua
-  O'Connor, Julio C. Villasante, Kenta Usami, Kevin Fleming, Kévin Le
-  Gouguec, Kevin Kainan Li, Kostadin Ninev, Laith Bahodi, Lasse
-  Lindner, Len Trigg, Lennart C.{{{space()}}} Karssen, Luis Miguel
-  Castañeda, Magne Hov, Manuel Giraud, Manuel Uberti, Mark Bestley,
-  Mark Burton, Mark Simpson, Marko Kocic, Markus Beppler, Matt
-  Armstrong, Matthias Fuchs, Mattias Engdegård, Mauro Aranda, Maxime
-  Tréca, Michael Goldenberg, Morgan Smith, Morgan Willcock, Murilo
-  Pereira, Nicky van Foreest, Nicolas De Jaeghere, Nicolas Semrau,
-  Olaf Meeuwissen, Oliver Epper, Pablo Stafforini, Paul Poloskov,
-  Pengji Zhang, Pete Kazmier, Peter Wu, Philip Kaludercic, Pierre
-  Téchoueyres, Przemysław Kryger, Robert Hepple, Roman Rudakov,
-  Russell Sim, Ryan Phillips, Rytis Paškauskas, Rudolf Adamkovič, Sam
-  Kleinman, Samuel Culpepper, Saša Janiška, Shreyas Ragavan, Simon
-  Pugnet, Steve Downey, Tassilo Horn, Thanos Apollo, Thibaut Verron,
-  Thomas Heartman, Togan Muftuoglu, Tony Zorman, Trey Merkley, Tomasz
-  Hołubowicz, Toon Claes, Uri Sharf, Utkarsh Singh, Vincent Foley,
-  Zoltan Kiraly. As well as users: Ben, CsBigDataHub1, Emacs Contrib,
-  Eugene, Fourchaux, Fredrik, Moesasji, Nick, Summer Emacs, TheBlob42,
-  TitusMu, Trey, bepolymathe, bit9tream, bangedorrunt, case-lambda,
-  chainedghost, derek-upham, doolio, fleimgruber, gitrj95, iSeeU,
-  jixiuf, ltmsyvag, okamsn, pedro-nonfree, pRot0ta1p, shimeike,
-  shipmints, soaringbird, tumashu, wakamenod.
+  Blas, Arif Rezai, Ashton Wiersdorf, Augusto Stoffel, Basil
+  L.{{{space()}}} Contovounesios, Bernd Rellermeyer, Burgess Chang,
+  Charlotte Van Petegem, Christian Tietze, Christopher Dimech,
+  Christopher League, Damien Cassou, Daniel Mendler, Dario
+  Gjorgjevski, David Edmondson, Davor Rotim, Divan Santana, Eliraz
+  Kedmi, Emanuele Michele Alberto Monterosso, Eshel Yaron, Farasha
+  Euker, Feng Shu, Filippo Argiolas, Gautier Ponsinet, Gerry Agbobada,
+  Gianluca Recchia, Gonçalo Marrafa, Guilherme Semente, Gustavo
+  Barros, Hörmetjan Yiltiz, Ilja Kocken, Imran Khan, Iris Garcia, Ivan
+  Popovych, Jabir Ali Ouassou, James Ferguson, Jeremy Friesen, Jerry
+  Zhang, Johannes Grødem, John Haman, John Sullivan, John Wick, Jonas
+  Collberg, Jorge Morais, Joshua O'Connor, Julio C. Villasante, Kenta
+  Usami, Kevin Fleming, Kévin Le Gouguec, Kevin Kainan Li, Kostadin
+  Ninev, Laith Bahodi, Lasse Lindner, Len Trigg, Lennart
+  C.{{{space()}}} Karssen, Luis Miguel Castañeda, Magne Hov, Manuel
+  Giraud, Manuel Uberti, Mark Bestley, Mark Burton, Mark Simpson,
+  Marko Kocic, Markus Beppler, Matt Armstrong, Matthias Fuchs, Mattias
+  Engdegård, Mauro Aranda, Maxime Tréca, Michael Goldenberg, Morgan
+  Smith, Morgan Willcock, Murilo Pereira, Nicky van Foreest, Nicolas
+  De Jaeghere, Nicolas Semrau, Olaf Meeuwissen, Oliver Epper, Pablo
+  Stafforini, Paul Poloskov, Pengji Zhang, Pete Kazmier, Peter Wu,
+  Philip Kaludercic, Pierre Téchoueyres, Przemysław Kryger, Robert
+  Hepple, Roman Rudakov, Russell Sim, Ryan Phillips, Rytis Paškauskas,
+  Rudolf Adamkovič, Sam Kleinman, Samuel Culpepper, Saša Janiška,
+  Shreyas Ragavan, Simon Pugnet, Steve Downey, Tassilo Horn, Thanos
+  Apollo, Thibaut Verron, Thomas Heartman, Togan Muftuoglu, Tony
+  Zorman, Trey Merkley, Tomasz Hołubowicz, Toon Claes, Uri Sharf,
+  Utkarsh Singh, Vincent Foley, Zoltan Kiraly. As well as users: Ben,
+  CsBigDataHub1, Emacs Contrib, Eugene, Fourchaux, Fredrik, Moesasji,
+  Nick, Summer Emacs, TheBlob42, TitusMu, Trey, bepolymathe,
+  bit9tream, bangedorrunt, case-lambda, chainedghost, derek-upham,
+  doolio, fleimgruber, gitrj95, iSeeU, jixiuf, ltmsyvag, okamsn,
+  pedro-nonfree, pRot0ta1p, shimeike, shipmints, soaringbird, tumashu,
+  wakamenod.
 
 + Packaging :: Basil L.{{{space()}}} Contovounesios, Eli Zaretskii,
   Glenn Morris, Mauro Aranda, Richard Stallman, Stefan Kangas (core

Reply via email to