aboutsummaryrefslogtreecommitdiff
path: root/doc/manual/11_Scripting.md
diff options
context:
space:
mode:
authormitchell <70453897+667e-11@users.noreply.github.com>2010-11-30 19:55:39 -0500
committermitchell <70453897+667e-11@users.noreply.github.com>2010-11-30 19:55:39 -0500
commitc7b543e79b41d9a983cc89e264acd0472d09dc92 (patch)
tree9b28b836f65b396ea160ba91048fb030018ccdcc /doc/manual/11_Scripting.md
parent6c1afd75fc048e65cef5bfdbe68c79a082bdad43 (diff)
downloadtextadept-c7b543e79b41d9a983cc89e264acd0472d09dc92.tar.gz
textadept-c7b543e79b41d9a983cc89e264acd0472d09dc92.zip
New manual.
Diffstat (limited to 'doc/manual/11_Scripting.md')
-rw-r--r--doc/manual/11_Scripting.md57
1 files changed, 57 insertions, 0 deletions
diff --git a/doc/manual/11_Scripting.md b/doc/manual/11_Scripting.md
new file mode 100644
index 00000000..aaaaa498
--- /dev/null
+++ b/doc/manual/11_Scripting.md
@@ -0,0 +1,57 @@
+# Scripting
+
+Textadept has superb support for editing Lua code. Syntax autocomplete and
+LuaDoc is available for many Textadept objects as well as Lua's standard
+libraries. See the [lua module documentation](../modules/_m.lua.commands.html)
+for more information.
+
+## LuaDoc and Examples
+
+Textadept's API is heavily documented. The [LuaDoc](../index.html) is the
+ultimate resource on scripting Textadept. There are of course abundant scripting
+examples since Textadept is mostly written in Lua.
+
+## Scintilla
+
+The editing component used by Textadept is [Scintilla](http://scintilla.org).
+The [buffer](../modules/buffer.html) part of Textadept's API is derived from the
+[Scintilla API](http://scintilla.org/ScintillaDoc.html) so any C/C++ code using
+Scintilla calls can be ported to Lua without too much trouble.
+
+## Textadept Folder Structure
+
+Because Textadept is mostly written in Lua, its Lua scripts have to be stored in
+an organized folder structure.
+
+#### Core
+
+Textadept's core Lua modules are contained in `core/`. These are absolutely
+necessary in order for the application to run. They are responsible for
+Textadept's Lua to C interface, event structure, file input/output, and
+localization.
+
+#### Lexers
+
+Lexer Lua modules are responsible for the syntax highlighting of source code.
+They are located in `lexers/`.
+
+#### Modules
+
+Editor Lua modules are contained in `modules/`. These provide advanced text
+editing capabilities and can be available for all programming languages or
+targeted at specific ones.
+
+#### Themes
+
+Built-in themes to customize the look and behavior of Textadept are located in
+`themes/`.
+
+#### User
+
+User Lua modules are contained in the `~/.textadept/` folder. This folder may
+contain `lexers/`, `modules/`, and `themes/` subdirectories.
+
+#### GTK
+
+The `etc/`, `lib/`, and `share/` directories are used by GTK and only appear in
+the Win32 and Mac OSX packages.