aboutsummaryrefslogtreecommitdiffhomepage
path: root/doc/11_Scripting.md
diff options
context:
space:
mode:
authorGravatar mitchell <70453897+667e-11@users.noreply.github.com>2012-10-29 20:45:58 -0400
committerGravatar mitchell <70453897+667e-11@users.noreply.github.com>2012-10-29 20:45:58 -0400
commitfa38d2306fadc99bb1403433517ecf45a24062eb (patch)
tree19f286adb6be4cbd7a1b11fc1c880976a01ea9fd /doc/11_Scripting.md
parent6718de08a3f19f8c24c1c4167b05828a7ac0dfd7 (diff)
Updated documentation formatting.
Pathnames and filenames are italic and be more consistent with constant width text.
Diffstat (limited to 'doc/11_Scripting.md')
-rw-r--r--doc/11_Scripting.md30
1 files changed, 15 insertions, 15 deletions
diff --git a/doc/11_Scripting.md b/doc/11_Scripting.md
index aa15df9e..2f6a659b 100644
--- a/doc/11_Scripting.md
+++ b/doc/11_Scripting.md
@@ -23,14 +23,14 @@ since the editor is written primarily in Lua.
### Generating LuaDoc
You can generate Textadept-like API documentation for your own modules using the
-`doc/markdowndoc.lua` [LuaDoc][] module (you must have [Discount][] installed):
+*doc/markdowndoc.lua* [LuaDoc][] module (you must have [Discount][] installed):
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 HTML files is created in the
+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 HTML files is created in the
current directory.
[LuaDoc]: http://keplerproject.github.com/luadoc/
@@ -38,13 +38,13 @@ current directory.
## Lua Configuration
-[Lua 5.2][] is built into Textadept. It has the same configuration (`luaconf.h`)
+[Lua 5.2][] is built into Textadept. It has the same configuration (*luaconf.h*)
as vanilla Lua with the following exceptions:
* `TA_LUA_PATH` and `TA_LUA_CPATH` are the environment variable used in place of
the usual `LUA_PATH` and `LUA_CPATH`.
-* `LUA_ROOT` is `/usr/` in Linux systems instead of `/usr/local/`.
-* `LUA_PATH` and `LUA_CPATH` do not have `./?.lua` and `./?.so` in them.
+* `LUA_ROOT` is "/usr/" in Linux systems instead of "/usr/local/".
+* `LUA_PATH` and `LUA_CPATH` do not have "./?.lua" and "./?.so" in them.
* All compatibility flags for Lua 5.1 are turned off. (`LUA_COMPAT_UNPACK`,
`LUA_COMPAT_LOADERS`, `LUA_COMPAT_LOG10`, `LUA_COMPAT_LOADSTRING`,
`LUA_COMPAT_MAXN`, and `LUA_COMPAT_MODULE`.)
@@ -56,7 +56,7 @@ as vanilla Lua with the following exceptions:
Even though Textadept can be run with [LuaJIT][], LuaJIT is based on Lua 5.1 and
is not fully compatible with Lua 5.2. Therefore, modules and scripts should be
written to be compatible with both versions. There is a compatibility layer in
-`core/compat.lua`. Please see it for more information.
+*core/compat.lua*. Please see it for more information.
[LuaJIT]: http://luajit.org
@@ -77,7 +77,7 @@ an organized folder structure.
### Core
-Textadept's core Lua modules are contained in `core/`. These are absolutely
+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 interactions, and
localization.
@@ -85,26 +85,26 @@ localization.
### Lexers
Lexer modules are responsible for the syntax highlighting of source code. They
-are located in `lexers/`.
+are located in *lexers/*.
### Modules
-Editing modules are contained in `modules/`. These provide advanced text editing
+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
Built-in themes to customize the look and behavior of Textadept are located in
-`themes/`.
+*themes/*.
### User
User preferences, Lua modules, themes, and user-data are contained in the
-`~/.textadept/` folder. This folder may contain `lexers/`, `modules/`, and
-`themes/` sub-directories.
+*~/.textadept/* folder. This folder may contain *lexers/*, *modules/*, and
+*themes/* sub-directories.
### 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.