diff options
author | mitchell <70453897+667e-11@users.noreply.github.com> | 2013-11-11 10:00:08 -0500 |
---|---|---|
committer | mitchell <70453897+667e-11@users.noreply.github.com> | 2013-11-11 10:00:08 -0500 |
commit | 432cd5c0fa2c2d8751d8ee7489e39fe625afd748 (patch) | |
tree | 2848835a405786c7293635e6867249930b1cf826 | |
parent | 2670ba1b74225fdf1d9447ca773af8dab8dcb6e8 (diff) |
Updated documentation.
-rw-r--r-- | FAQ.md | 26 | ||||
-rw-r--r-- | MEDIA.md | 3 | ||||
-rw-r--r-- | README.md | 7 | ||||
-rw-r--r-- | core/.buffer.luadoc | 14 | ||||
-rw-r--r-- | core/file_io.lua | 2 | ||||
-rw-r--r-- | modules/textadept/editing.lua | 2 |
6 files changed, 45 insertions, 9 deletions
@@ -1,6 +1,21 @@ # FAQ **Q:** +I upgraded to Textadept 7 and the editor displays a strange error message on +startup and/or exits. Also my themes do not seem to work anymore. + +**A:** +Textadept 7 introduced API changes and a completely new theme implementation. +Please see the [migration guide][] for more information. It may help to either +delete your old `~/.textadept/` folder or move everything within it somewhere +else before gradually copying those files back to see which of them causes an +error. + +[migration guide]: 14_Appendix.html#Textadept.6.to.7 + +- - - + +**Q:** What is the difference between *textadept* and *textadeptjit*? Which one should I use? @@ -36,6 +51,17 @@ implementation is required for the terminal version.) - - - **Q:** +When I open a file in a non-English language, I see a lot of strange characters. + +**A:** +Textadept does not detect the file's encoding correctly. You'll need to +[help it][]. + +[help it]: 04_WorkingWithFiles.html#Encodings + +- - - + +**Q:** When I click the "Compile" or "Run" menu item (or execute the key command), either nothing happens or the wrong command is executed. How can I tell Textadept which command to run? @@ -32,6 +32,9 @@ This book covers how to: * Define lexers for highlighting source code * And much more +It serves as the perfect complement to Textadept's comprehensive Manual and +exhaustive API documentation. + [Pre-order]: http://gum.co/ta_quickref [Table of Contents]: download/ta_quickref_toc.pdf @@ -36,7 +36,8 @@ The terminal version of Textadept requires only an implementation of curses like ## Download -**Please consider making a [donation][]. It really helps.** +**Please consider making a [donation][] or purchasing the [book][] to help fund +Textadept's continuous development. It really helps.** Download Textadept from the project's [download page][] or from these quick links: @@ -62,6 +63,7 @@ cutting-edge versions of Textadept. Do not use them in production, but for testing purposes only. [donation]: http://gum.co/textadept +[book]: MEDIA.html#Book [download page]: http://foicica.com/textadept/download [Win32]: download/textadept_LATEST.win32.zip [Mac OSX]: download/textadept_LATEST.osx.zip @@ -100,6 +102,9 @@ how to script and configure Textadept using the Lua programming language. It groups the editor's rich API into a series of tasks in a convenient and easy-to-use manner. [Read more...][] +This book serves as the perfect complement to Textadept's Manual and exhaustive +API documentation. + [*Textadept Quick Reference*]: MEDIA.html#Book [Read more...]: MEDIA.html#Book diff --git a/core/.buffer.luadoc b/core/.buffer.luadoc index 69d63338..9e55a48e 100644 --- a/core/.buffer.luadoc +++ b/core/.buffer.luadoc @@ -1544,7 +1544,7 @@ function home_extend(buffer) end function home_rect_extend(buffer) end --- --- Moves the caret to beginning of the current wrapped line, or if already +-- Moves the caret to beginning of the current wrapped line or, if already -- there, to the beginning of the actual line. -- @param buffer The buffer. function home_wrap(buffer) end @@ -1675,7 +1675,7 @@ function line_end_extend(buffer) end function line_end_rect_extend(buffer) end --- --- Moves the caret to the end of the current wrapped line, or if already there, +-- Moves the caret to the end of the current wrapped line or, if already there, -- to the end of the actual line. -- @param buffer The buffer. function line_end_wrap(buffer) end @@ -1751,8 +1751,8 @@ function line_up_rect_extend(buffer) end function lines_join(buffer) end --- --- Splits the lines in the target range into lines at most *width* pixels wide, --- or if *width* is `0`, lines as wide as the view. +-- Splits the lines in the target range into lines at most *width* pixels wide +-- or, if *width* is `0`, lines as wide as the view. -- @param buffer The buffer. -- @param width The pixel width to split lines at. When `0`, uses the width of -- the view. @@ -2341,7 +2341,7 @@ function show_lines(buffer, start_line, end_line) end function start_styling(buffer, position, style_mask) end --- --- Moves the caret to the bottom of the page, or if already there, down one +-- Moves the caret to the bottom of the page or, if already there, down one -- page. -- @param buffer The buffer. function stuttered_page_down(buffer) end @@ -2353,7 +2353,7 @@ function stuttered_page_down(buffer) end function stuttered_page_down_extend(buffer) end --- --- Moves the caret to the top of the page, or if already there, up one page. +-- Moves the caret to the top of the page or, if already there, up one page. -- @param buffer The buffer. function stuttered_page_up(buffer) end @@ -2446,7 +2446,7 @@ function upper_case(buffer) end function user_list_show(buffer, list_type, item_list) end --- --- Moves the caret to the first visible character on the current line, or if +-- Moves the caret to the first visible character on the current line or, if -- already there, to the beginning of the current line. -- @param buffer The buffer. function vc_home(buffer) end diff --git a/core/file_io.lua b/core/file_io.lua index e2c2e1ed..8e824de2 100644 --- a/core/file_io.lua +++ b/core/file_io.lua @@ -29,6 +29,8 @@ -- * _`filename`_: The new filename. -- @field _G.events.FILE_CHANGED (string) -- Emitted when Textadept detects that a file was externally modified. +-- When connecting to this event, connect with an index of 1 to override the +-- default prompt to reload the file. -- Arguments: -- -- * _`filename`_: The filename externally modified. diff --git a/modules/textadept/editing.lua b/modules/textadept/editing.lua index 7d585694..8539f3f7 100644 --- a/modules/textadept/editing.lua +++ b/modules/textadept/editing.lua @@ -26,7 +26,7 @@ local M = {} -- The default value is `true`. -- @field STRIP_TRAILING_SPACES (bool) -- Strip trailing whitespace before saving files. --- The default value is `true`. +-- The default value is `false`. -- @field INDIC_BRACEMATCH (number) -- The matching brace highlight indicator number. -- @field INDIC_HIGHLIGHT (number) |