From c7b543e79b41d9a983cc89e264acd0472d09dc92 Mon Sep 17 00:00:00 2001 From: mitchell <70453897+667e-11@users.noreply.github.com> Date: Tue, 30 Nov 2010 19:55:39 -0500 Subject: New manual. --- doc/manual/11_Scripting.md | 57 ++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 57 insertions(+) create mode 100644 doc/manual/11_Scripting.md (limited to 'doc/manual/11_Scripting.md') 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. -- cgit v1.2.3