diff options
| author | hut <hut@lavabit.com> | 2010-03-12 21:07:16 +0100 |
|---|---|---|
| committer | hut <hut@lavabit.com> | 2010-03-12 21:50:54 +0100 |
| commit | a8f9cf2c8bcd2432b1b82a68422102a6924864d6 (patch) | |
| tree | b99f733a66f76ba3176bd6f6c99eb01fdb2baeb2 /doc/colorschemes.txt | |
| parent | 5ae6670c39493b72e126148ca21cd5cb8e681c7e (diff) | |
| download | ranger-a8f9cf2c8bcd2432b1b82a68422102a6924864d6.tar.gz | |
standardized formatting of headings in doc/
Diffstat (limited to 'doc/colorschemes.txt')
| -rw-r--r-- | doc/colorschemes.txt | 22 |
1 files changed, 16 insertions, 6 deletions
diff --git a/doc/colorschemes.txt b/doc/colorschemes.txt index 9df33c3e..a189d4fd 100644 --- a/doc/colorschemes.txt +++ b/doc/colorschemes.txt @@ -1,9 +1,15 @@ -= Abstract = +Colorschemes +============ + +Abstract +-------- + This text explains colorschemes and how they work. -= Context Tags = +Context Tags +------------ Context Tags provide information about the context. If the tag "in_titlebar" is set, you probably want to know about the color @@ -16,7 +22,8 @@ A Context object, defined in the same file, contains attributes with the names of all tags, whose values are either True or False. -= Implementation in the GUI Classes = +Implementation in the GUI Classes +--------------------------------- The class CursesShortcuts in the file /ranger/gui/curses_shortcuts.py defines the methods color(*tags), color_at(y, x, wid, *tags) and @@ -30,7 +37,8 @@ ranger.gui.context.Context object, sets its attributes "in_titlebar" and colorscheme's use(context) method. -= The Color Scheme = +The Color Scheme +---------------- A colorscheme should be a subclass of ranger.gui.ColorScheme and define the method use(context). By looking at the context, this use-method @@ -53,7 +61,8 @@ that tag. Run tc_colorscheme to check if your colorschemes are valid. -= Specify a Colorscheme = +Specify a Colorscheme +--------------------- Colorschemes are searched for in these directories: ~/.ranger/colorschemes/ @@ -73,7 +82,8 @@ specify which colorscheme to use in your options.py: colorscheme = colorschemes.default.MyOtherScheme -= Adapt a colorscheme = +Adapt a colorscheme +------------------- You may want to adapt a colorscheme to your needs without having a complete copy of it, but rather the changes only. Say, you |