aboutsummaryrefslogtreecommitdiff
path: root/doc
diff options
context:
space:
mode:
Diffstat (limited to 'doc')
-rw-r--r--doc/03_UserInterface.md2
-rw-r--r--doc/05_FileNavigation.md2
-rw-r--r--doc/06_AdeptEditing.md2
-rw-r--r--doc/07_Modules.md2
-rw-r--r--doc/08_Preferences.md24
-rw-r--r--doc/14_Appendix.md39
6 files changed, 36 insertions, 35 deletions
diff --git a/doc/03_UserInterface.md b/doc/03_UserInterface.md
index 0556f266..d51101ef 100644
--- a/doc/03_UserInterface.md
+++ b/doc/03_UserInterface.md
@@ -18,7 +18,7 @@ key bindings.
[command selection]: 10_Advanced.html#Command.Selection
[key preferences]: 08_Preferences.html#Key.Bindings
-[complete list]: api/_M.textadept.keys.html#Key.Bindings
+[complete list]: api/textadept.keys.html#Key.Bindings
## Editor View
diff --git a/doc/05_FileNavigation.md b/doc/05_FileNavigation.md
index bd3084f3..47f65618 100644
--- a/doc/05_FileNavigation.md
+++ b/doc/05_FileNavigation.md
@@ -10,7 +10,7 @@ by pages, etc. Mac OSX and curses also handle some Bash-style bindings like
`^B`, `^F`, `^P`, `^N`, `^A`, and `^E`. The "Movement" section of the
[key bindings list][] lists all movement bindings.
-[key bindings list]: api/_M.textadept.keys.html#Key.Bindings
+[key bindings list]: api/textadept.keys.html#Key.Bindings
## Brace Match
diff --git a/doc/06_AdeptEditing.md b/doc/06_AdeptEditing.md
index 7c885cce..6e26f6c9 100644
--- a/doc/06_AdeptEditing.md
+++ b/doc/06_AdeptEditing.md
@@ -261,7 +261,7 @@ defined. [Language modules][] usually [define Adeptsenses][]. All of the
![Adeptsense Doc](images/adeptsense_doc.png)
[Language modules]: 07_Modules.html#Language.Modules
-[Adeptsense]: api/_M.textadept.adeptsense.html
+[Adeptsense]: api/textadept.adeptsense.html
[define Adeptsenses]: api/_M.html#Adeptsense
[official]: http://foicica.com/hg
diff --git a/doc/07_Modules.md b/doc/07_Modules.md
index 10f086ef..9af18ab5 100644
--- a/doc/07_Modules.md
+++ b/doc/07_Modules.md
@@ -10,7 +10,7 @@ Textadept also recognizes a special kind of module: a language module. Language
modules provide functionality specific to their respective programming
languages.
-[textadept module]: api/_M.textadept.html
+[textadept module]: api/textadept.html
[preferences]: 08_Preferences.html#Loading.Modules
## Language Modules
diff --git a/doc/08_Preferences.md b/doc/08_Preferences.md
index ba4ea399..46db35a3 100644
--- a/doc/08_Preferences.md
+++ b/doc/08_Preferences.md
@@ -33,9 +33,9 @@ Many of Textadept's generic modules have configurable settings changeable from
with typeover and stripping trailing whitespace on save, add the following to
your *~/.textadept/init.lua*:
- _M.textadept.editing.AUTOPAIR = false
- _M.textadept.editing.TYPEOVER_CHARS = false
- _M.textadept.editing.STRIP_TRAILING_SPACES = false
+ textadept.editing.AUTOPAIR = false
+ textadept.editing.TYPEOVER_CHARS = false
+ textadept.editing.STRIP_TRAILING_SPACES = false
Now suppose you want to load all of Textadept's default modules except for the
menu. You cannot do this after-the-fact from *~/.textadept/init.lua*. Instead
@@ -81,7 +81,7 @@ commands, load more [Adeptsense tags][], and add additional
[key bindings](#Key.Bindings) and [snippets](#Snippets) (instead of in
*~/.textadept/init.lua*). For example:
- _M.textadept.run.run_command.lua = 'lua5.2'
+ textadept.run.run_command.lua = 'lua5.2'
_M.lua.sense:load_ctags('/path/to/my/projects/tags')
keys.lua['c\n'] = function()
buffer:line_end() buffer:add_text('end') buffer:new_line()
@@ -89,7 +89,7 @@ commands, load more [Adeptsense tags][], and add additional
snippets.lua['ver'] = '%<_VERSION>'
[compile and run]: 07_Modules.html#Compile.and.Run
-[Adeptsense tags]: api/_M.textadept.adeptsense.html#load_ctags
+[Adeptsense tags]: api/textadept.adeptsense.html#load_ctags
### Loading Modules
@@ -97,7 +97,7 @@ After creating or downloading a generic module called `foo` that you want to
load along with the default modules, simply add the following to your
*~/.textadept/init.lua*:
- _M.foo = require('foo')
+ foo = require('foo')
Textadept automatically loads language modules when opening a source file of
that language, so simply installing the language module is sufficient.
@@ -129,25 +129,25 @@ So typing `file` or `path` and then pressing `Tab` (`⇥` on Mac OSX | `Tab` in
curses) inserts the snippet, regardless of the current programming language.
Learn more about snippet syntax in the [snippets LuaDoc][].
-[snippets LuaDoc]: api/_M.textadept.snippets.html
+[snippets LuaDoc]: api/textadept.snippets.html
### File Types
Textadept recognizes a wide range of programming language files either by file
extension, by a keyword in the shebang ("#!/path/to/exe") line, or by a
[Lua pattern][] that matches the text of the first line. The editor does this by
-consulting a set of tables in [`_M.textadept.file_types`][] that are modifiable
+consulting a set of tables in [`textadept.file_types`][] that are modifiable
from *~/.textadept/init.lua*. For example:
-- Recognize .luadoc files as Lua code.
- _M.textadept.file_types.extensions.luadoc = 'lua'
+ textadept.file_types.extensions.luadoc = 'lua'
-- Change .html files to be recognized as XML files.
- _M.textadept.file_types.extensions.html = 'xml'
+ textadept.file_types.extensions.html = 'xml'
-- Recognize a shebang line like "#!/usr/bin/zsh" as shell code.
- _M.textadept.file_types.shebangs.zsh = 'bash'
+ textadept.file_types.shebangs.zsh = 'bash'
[Lua pattern]: 14_Appendix.html#Lua.Patterns
-[`_M.textadept.file_types`]: api/_M.textadept.file_types.html
+[`textadept.file_types`]: api/textadept.file_types.html
## Buffer Properties
diff --git a/doc/14_Appendix.md b/doc/14_Appendix.md
index 23c7312a..c1c18669 100644
--- a/doc/14_Appendix.md
+++ b/doc/14_Appendix.md
@@ -154,7 +154,7 @@ Old API |Change |New API
**_G** | |
RESETTING |Removed |N/A<sup>\*</sup>
buffer\_new() |Renamed |\_G.[buffer.new()][]
-**_M.textadept** | |
+**_M.textadept** |Renamed |[textadept][]
filter\_through |Removed |N/A
filter\_through.filter\_through() |Renamed |editing.[filter\_through()][]
mime\_types |Renamed |[file\_types][]<sup>†</sup>
@@ -191,14 +191,15 @@ try\_encodings |Renamed |[encodings][]
<sup>‡</sup>Changed arguments too.
[buffer.new()]: api/buffer.html#new
-[filter\_through()]: api/_M.textadept.editing.html#filter_through
-[file\_types]: api/_M.textadept.file_types.html
-[goto\_mark()]: api/_M.textadept.bookmarks.html#goto_mark
-[BOOKMARK\_COLOR]: api/_M.textadept.bookmarks.html#BOOKMARK_COLOR
-[HIGHLIGHT\_COLOR]: api/_M.textadept.editing.html#HIGHLIGHT_COLOR
-[autocomplete\_word]: api/_M.textadept.editing.html#autocomplete_word
-[select\_enclosed()]: api/_M.textadept.editing.html#select_enclosed
-[ERROR\_COLOR]: api/_M.textadept.run.html#ERROR_COLOR
+[textadept]: api/textadept.html
+[filter\_through()]: api/textadept.editing.html#filter_through
+[file\_types]: api/textadept.file_types.html
+[goto\_mark()]: api/textadept.bookmarks.html#goto_mark
+[BOOKMARK\_COLOR]: api/textadept.bookmarks.html#BOOKMARK_COLOR
+[HIGHLIGHT\_COLOR]: api/textadept.editing.html#HIGHLIGHT_COLOR
+[autocomplete\_word]: api/textadept.editing.html#autocomplete_word
+[select\_enclosed()]: api/textadept.editing.html#select_enclosed
+[ERROR\_COLOR]: api/textadept.run.html#ERROR_COLOR
[io.snapopen()]: api/io.html#snapopen
[ui]: api/ui.html
[maximized]: api/ui.html#maximized
@@ -345,14 +346,14 @@ prompt\_load() |Replaced|[load()][]
prompt\_save() |Replaced|[save()][]
[menu()]: api/ui.html#menu
-[complete()]: api/_M.textadept.adeptsense.html#complete
-[show\_apidoc()]: api/_M.textadept.adeptsense.html#show_apidoc
-[toggle()]: api/_M.textadept.bookmarks.html#toggle
-[set\_menubar()]: api/_M.textadept.menu.html#set_menubar
-[run()]: api/_M.textadept.run.html#run
-[compile()]: api/_M.textadept.run.html#compile
-[load()]: api/_M.textadept.session.html#load
-[save()]: api/_M.textadept.session.html#save
+[complete()]: api/textadept.adeptsense.html#complete
+[show\_apidoc()]: api/textadept.adeptsense.html#show_apidoc
+[toggle()]: api/textadept.bookmarks.html#toggle
+[set\_menubar()]: api/textadept.menu.html#set_menubar
+[run()]: api/textadept.run.html#run
+[compile()]: api/textadept.run.html#compile
+[load()]: api/textadept.session.html#load
+[save()]: api/textadept.session.html#save
### Textadept 4 to 5
@@ -400,7 +401,7 @@ your own:
end
[\_M]: api/_M.html
-[select\_word()]: api/_M.textadept.editing.html#select_word
+[select\_word()]: api/textadept.editing.html#select_word
[\_L]: api/_L.html
#### Module Changes
@@ -579,7 +580,7 @@ views |Renamed|\_G.[\_VIEWS][]
[\_SCINTILLA]: api/_SCINTILLA.html
[events]: api/events.html
[gui]: api/ui.html
-[_m.textadept.snippets]: api/_M.textadept.snippets.html
+[_m.textadept.snippets]: api/textadept.snippets.html
[gui.\_print()]: api/ui.html#_print
[\_SCINTILLA.functions]: api/_SCINTILLA.html#functions
[\_SCINTILLA.properties]: api/_SCINTILLA.html#properties