diff options
Diffstat (limited to 'doc/11_Scripting.md')
| -rw-r--r-- | doc/11_Scripting.md | 51 |
1 files changed, 24 insertions, 27 deletions
diff --git a/doc/11_Scripting.md b/doc/11_Scripting.md index a214fe0f..3c546f1a 100644 --- a/doc/11_Scripting.md +++ b/doc/11_Scripting.md @@ -1,41 +1,37 @@ # 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][] for more information. +Textadept is entirely scriptable with Lua. In fact, the editor is mostly written +in Lua. As a result, Textadept has superb support for editing Lua code. Syntax +autocomplete and API documentation is available for many Textadept objects as +well as Lua's standard libraries. The [`lua` module][] also has more tools for +working with Lua code.   -[`lua` module documentation]: api/_M.lua.html +[`lua` module]: api/_M.lua.html ## LuaDoc and Examples -Textadept's API is heavily documented. The [API docs][] are the ultimate +Textadept's API is heavily documented. The [API documentation][] is the ultimate resource on scripting Textadept. There are of course abundant scripting examples -since Textadept is mostly written in Lua. +since the editor is written primarily in Lua. -[API docs]: api/index.html +[API documentation]: api/index.html ### Generating LuaDoc You can generate API documentation for your own modules using the -`doc/markdowndoc.lua` [LuaDoc][] module: +`doc/markdowndoc.lua` [LuaDoc][] module (you must have [Discount][] installed): - luadoc -d . --doclet _HOME/doc/markdowndoc [module(s)] - -or - - luadoc -d . -t template_dir --doclet _HOME/doc/markdowndoc [module(s)] + luadoc -d . [-t template_dir] --doclet _HOME/doc/markdowndoc [module(s)] where `_HOME` is where Textadept is installed and `template_dir` is an optional template directory that contains two Markdown files: `.header.md` and `.footer.md`. (See `doc/.header.md` and `doc/.footer.md` for examples.) An -`api/` directory containing the API documentation is created in the current -directory. - -You must have [Discount][] installed. +`api/` directory containing the API documentation HTML files is created in the +current directory. [LuaDoc]: http://keplerproject.github.com/luadoc/ [Discount]: http://www.pell.portland.or.us/~orc/Code/discount/ @@ -82,19 +78,19 @@ an organized folder structure. 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 +Textadept's Lua to C interface, event structure, file interactions, and localization. ### Lexers -Lexer Lua modules are responsible for the syntax highlighting of source code. -They are located in `lexers/`. +Lexer 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. +Editing 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 @@ -103,10 +99,11 @@ Built-in themes to customize the look and behavior of Textadept are located in ### User -User Lua modules are contained in the `~/.textadept/` folder. This folder may -contain `lexers/`, `modules/`, and `themes/` subdirectories. +User preferences, Lua modules, themes, and user-data are contained in the +`~/.textadept/` folder. This folder may contain `lexers/`, `modules/`, and +`themes/` sub-directories. -### GTK +### GTK+ -The `etc/`, `lib/`, and `share/` directories are used by GTK and only appear in +The `etc/`, `lib/`, and `share/` directories are used by GTK+ and only appear in the Win32 and Mac OSX packages. |