[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]
[elpa] master 2b6d30e 05/31: Document context-coloring-define-theme.
From: |
Jackson Ray Hamilton |
Subject: |
[elpa] master 2b6d30e 05/31: Document context-coloring-define-theme. |
Date: |
Mon, 09 Feb 2015 01:09:30 +0000 |
branch: master
commit 2b6d30e4793e75df1be761d7cc1f8f0585180a00
Author: Jackson Ray Hamilton <address@hidden>
Commit: Jackson Ray Hamilton <address@hidden>
Document context-coloring-define-theme.
---
context-coloring.el | 24 +++++++++++++++++++++++-
1 files changed, 23 insertions(+), 1 deletions(-)
diff --git a/context-coloring.el b/context-coloring.el
index 5f2a433..d0c7ba2 100644
--- a/context-coloring.el
+++ b/context-coloring.el
@@ -546,9 +546,31 @@ which must already exist and which *should* already be
enabled."
(defun context-coloring-define-theme (theme &rest properties)
"Define a theme named THEME for coloring scope levels.
+
PROPERTIES is a property list specifiying the following details:
-`:colors': List of colors that this theme uses."
+`:aliases': List of symbols of other custom themes that these
+colors are applicable to.
+
+`:colors': List of colors that this theme uses.
+
+`:override': If non-nil, this theme is intentionally overriding
+colors set by a custom theme. Don't set this non-nil unless there
+is a theme you want to use which sets
+`context-coloring-level-N-face' faces that you want to replace.
+
+`:recede': If non-nil, this theme should not apply its colors if
+a custom theme already sets `context-coloring-level-N-face'
+faces. This option is optimistic; set this non-nil if you would
+rather confer the duty of picking colors to a theme author (if /
+when he ever gets around to it).
+
+By default, themes will always override custom themes, even if
+those custom themes set `context-coloring-level-N-face' faces.
+If a theme does override a custom theme, a warning will be
+raised, at which point you may want to enable the `:override'
+option, or just delete your theme and opt to use your custom
+theme's author's colors instead."
(let ((aliases (plist-get properties :aliases))
(override (plist-get properties :override)))
(dolist (name (append `(,theme) aliases))
- [elpa] master updated (2fb700c -> f664821), Jackson Ray Hamilton, 2015/02/08
- [elpa] master 15b38a8 01/31: Cleanup., Jackson Ray Hamilton, 2015/02/08
- [elpa] master 2b6d30e 05/31: Document context-coloring-define-theme.,
Jackson Ray Hamilton <=
- [elpa] master ce5c6d9 07/31: Write and pass post-recede test., Jackson Ray Hamilton, 2015/02/08
- [elpa] master 4c7082f 06/31: Spaces., Jackson Ray Hamilton, 2015/02/08
- [elpa] master 2875503 04/31: Write and pass tests for context-coloring-define-theme and recede and override properties., Jackson Ray Hamilton, 2015/02/08
- [elpa] master 874982e 08/31: Update test names., Jackson Ray Hamilton, 2015/02/08
- [elpa] master 06efd73 09/31: Fix assertion so tests fail., Jackson Ray Hamilton, 2015/02/08
- [elpa] master 23a12b8 12/31: Rename test., Jackson Ray Hamilton, 2015/02/08
- [elpa] master 06a7606 10/31: Pass / update tests for warnings., Jackson Ray Hamilton, 2015/02/08
- [elpa] master 6e6bc61 15/31: Rename themep to theme-p., Jackson Ray Hamilton, 2015/02/08
- [elpa] master 0f036c9 13/31: Improve documentation for themes., Jackson Ray Hamilton, 2015/02/08
- [elpa] master ca7122c 16/31: Remove `when'., Jackson Ray Hamilton, 2015/02/08