annotate runtime/colors/README.txt @ 777:f664cc974a7a

updated for version 7.0227
author vimboss
date Fri, 17 Mar 2006 23:19:38 +0000
parents 3fc0f57ecb91
children 149d8b46404c
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1 README.txt for color scheme files
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
2
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
3 These files are used for the ":colorscheme" command. They appear in the
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
4 Edit/Color Scheme menu in the GUI.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
5
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
7 Hints for writing a color scheme file:
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
8
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
9 There are two basic ways to define a color scheme:
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
10
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
11 1. Define a new Normal color and set the 'background' option accordingly.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
12 set background={light or dark}
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
13 highlight clear
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
14 highlight Normal ...
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
15 ...
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
16
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
17 2. Use the default Normal color and automatically adjust to the value of
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
18 'background'.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
19 highlight clear Normal
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
20 set background&
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
21 highlight clear
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
22 if &background == "light"
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
23 highlight Error ...
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
24 ...
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
25 else
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
26 highlight Error ...
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
27 ...
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
28 endif
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
29
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
30 You can use ":highlight clear" to reset everything to the defaults, and then
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
31 change the groups that you want differently. This also will work for groups
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
32 that are added in later versions of Vim.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
33 Note that ":highlight clear" uses the value of 'background', thus set it
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
34 before this command.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
35 Some attributes (e.g., bold) might be set in the defaults that you want
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
36 removed in your color scheme. Use something like "gui=NONE" to remove the
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
37 attributes.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
38
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
39 To see which highlight group is used where, find the help for
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
40 "highlight-groups" and "group-name".
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
41
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
42 You can use ":highlight" to find out the current colors. Exception: the
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
43 ctermfg and ctermbg values are numbers, which are only valid for the current
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
44 terminal. Use the color names instead. See ":help cterm-colors".
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
45
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
46 The default color settings can be found in the source file src/syntax.c.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
47 Search for "highlight_init".
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
48
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
49 If you think you have a color scheme that is good enough to be used by others,
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
50 please check the following items:
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
51
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
52 - Does it work in a color terminal as well as in the GUI?
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
53 - Is 'background' either used or appropriately set to "light" or "dark"?
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
54 - Try setting 'hlsearch' and searching for a pattern, is the match easy to
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
55 spot?
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
56 - Split a window with ":split" and ":vsplit". Are the status lines and
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
57 vertical separators clearly visible?
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
58 - In the GUI, is it easy to find the cursor, also in a file with lots of
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
59 syntax highlighting?
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
60 - Do not use hard coded escape sequences, these will not work in other
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
61 terminals. Always use color names or #RRGGBB for the GUI.