diff options
author | 2010-11-30 19:55:39 -0500 | |
---|---|---|
committer | 2010-11-30 19:55:39 -0500 | |
commit | c7b543e79b41d9a983cc89e264acd0472d09dc92 (patch) | |
tree | 9b28b836f65b396ea160ba91048fb030018ccdcc /doc/manual/8_Themes.md | |
parent | 6c1afd75fc048e65cef5bfdbe68c79a082bdad43 (diff) | |
download | textadept-c7b543e79b41d9a983cc89e264acd0472d09dc92.tar.gz textadept-c7b543e79b41d9a983cc89e264acd0472d09dc92.zip |
New manual.
Diffstat (limited to 'doc/manual/8_Themes.md')
-rw-r--r-- | doc/manual/8_Themes.md | 62 |
1 files changed, 62 insertions, 0 deletions
diff --git a/doc/manual/8_Themes.md b/doc/manual/8_Themes.md new file mode 100644 index 00000000..c022bf7f --- /dev/null +++ b/doc/manual/8_Themes.md @@ -0,0 +1,62 @@ +# Themes + +Textadept's look and feel can be customized with themes. The themes that come +with Textadept are `'light'`, `'dark'`, and `'scite'`. By default the `'light'` +theme is used. The `'scite'` theme is recommended for users accustomed to SciTE. +To change the theme, create a `~/.textadept/theme` file whose first line of text +is the name of the theme you would like to use. + + + + + + + +Themes apply to all buffers. You cannot assign a theme to a particular file or +filetype. You can change things like tab and indent settings per filetype +however by creating a [language-specific +module](7_Modules.html#buffer_properties). + +## Creating or Modifying a Theme + +Each theme is a single folder on the filesystem composed of three files: +`lexer.lua`, `buffer.lua`, and `view.lua`. It is recommended to put themes in +your `~/.textadept/themes/` directory so they will not be overwritten when you +update Textadept. Themes in that directory override any themes in Textadept's +`themes/` directory. This means that if you have your own `light` theme, it will +be loaded instead of the one that comes with Textadept. + +To use a theme not located in `~/.textadept/themes/` or Textadept's `themes/` +directory, you need to specify an absolute path to the theme's folder in your +`~/.textadept/theme` file. + +#### Lexer + +Textadept uses lexers to assign names to buffer elements like comments, strings, +and keywords. These elements are assigned styles composed of font and color +information in the theme's `lexer.lua`. See the `Styling Tokens` section of the +[lexer](../modules/lexer.html) page for more information on how to create styles +and colors. + +#### Buffer + +`buffer.lua` contains buffer-specific properties like indentation size and +whether or not to use tabs. See the [LuaDoc](../modules/buffer.html) for +documentation on the properties. + +#### View + +`view.lua` contains view-specific properties like caret and selection colors. +See the [LuaDoc](../modules/buffer.html) for documentation on the properties. + +## Theming Text Fields + +There is no way to theme text fields like the Find and Replace ones from within +Textadept. Instead, use [GTK Resource files][gtkrc]. The names of the text field +widgets are: + +* Find field: `textadept-find-entry`. +* Replace field: `textadept-replace-entry`. +* Command entry: `textadept-command-entry`. + +[gtkrc]: http://library.gnome.org/devel/gtk/stable/gtk-Resource-Files.html |