diff options
| -rw-r--r-- | FAQ.md | 14 | ||||
| -rw-r--r-- | README.md | 6 | ||||
| -rw-r--r-- | TECHNOLOGY.md | 4 | ||||
| -rw-r--r-- | core/events.lua | 6 | ||||
| -rw-r--r-- | doc/manual.md | 44 | ||||
| -rw-r--r-- | modules/lua/api | 8 | ||||
| -rw-r--r-- | modules/textadept/menu.lua | 4 |
7 files changed, 43 insertions, 43 deletions
@@ -6,11 +6,11 @@ unzipped folders 10s of MBs in size? **A:** Each download contains 2 executables: a GUI version and a terminal version. -Furthermore, the Windows and OSX packages bundle in GTK+ runtimes, accounting -for some 3/4 of the total application size. (GTK+ is the cross-platform GUI -toolkit Textadept uses.) Then, starting in version 10, in order to be able to -run on older Linux systems whose libstdc++ does not support newer C++11 symbols, -the Linux executables statically link in a newer version of libstdc++. Finally, +Furthermore, the Windows and OSX packages bundle in GTK runtimes, accounting for +some 3/4 of the total application size. (GTK is the cross-platform GUI toolkit +Textadept uses.) Then, starting in version 10, in order to be able to run on +older Linux systems whose libstdc++ does not support newer C++11 symbols, the +Linux executables statically link in a newer version of libstdc++. Finally, nightly builds are compiled with debug symbols enabled in order to aid debugging of various issues. @@ -29,8 +29,8 @@ while Ubuntu 12.04 (circa 2012) used "libpng12". More recently, some distributions have started using "libncurses6" while many distributions are still on "libncurses5". Unfortunately in these cases, the best idea is to [compile][] Textadept. This process is actually very simple though. Only the -GTK+ development libraries are needed for the GUI version. (A development -library for a curses implementation is required for the terminal version.) +GTK development libraries are needed for the GUI version. (A development library +for a curses implementation is required for the terminal version.) [compile]: manual.html#Compiling @@ -24,14 +24,14 @@ speed or succumbing to code bloat and featuritis. ## Requirements In its bid for minimalism, Textadept has no dependencies on Windows and Mac OSX -operating systems and depends only on [GTK+ 2.0][] version 2.18 or greater on +operating systems and depends only on [GTK 2.0][] version 2.18 or greater on Linux. Textadept includes its own copy of Lua on all platforms and bundles in a -GTK+ runtime on Windows and Mac OSX. +GTK runtime on Windows and Mac OSX. The terminal version of Textadept requires only an implementation of curses like [ncurses][]. -[GTK+ 2.0]: http://gtk.org +[GTK 2.0]: http://gtk.org [ncurses]: http://invisible-island.net/ncurses/ncurses.html ## Download diff --git a/TECHNOLOGY.md b/TECHNOLOGY.md index 8b39ced5..293dc654 100644 --- a/TECHNOLOGY.md +++ b/TECHNOLOGY.md @@ -8,7 +8,7 @@ in the following sections. Textadept's user interface consists of a graphical user interface (GUI) and a terminal user interface (TUI). -=[GTK+][] - GIMP Toolkit= +=[GTK][] - GIMP Toolkit= Textadept uses GTK as its cross-platform GUI toolkit. =[ncurses][], [pdcurses][] - Libraries for displaying terminal applications= @@ -48,7 +48,7 @@ Lua and includes a few external libraries. \* A Foicica.com project. -[GTK+]: http://www.gtk.org +[GTK]: http://www.gtk.org [Scintilla]: http://scintilla.org [Lua]: http://www.lua.org [LPeg]: http://www.inf.puc-rio.br/~roberto/lpeg/lpeg.html diff --git a/core/events.lua b/core/events.lua index 480850a6..edd7258b 100644 --- a/core/events.lua +++ b/core/events.lua @@ -93,7 +93,7 @@ local M = {} -- `buffer.MOD_SHIFT`, `buffer.MOD_ALT`, and `buffer.MOD_META`. -- Note: If you set `buffer.rectangular_selection_modifier` to -- `buffer.MOD_CTRL`, the "Control" modifier is reported as *both* "Control" --- and "Alt" due to a Scintilla limitation with GTK+. +-- and "Alt" due to a Scintilla limitation with GTK. -- @field CSI (string) -- Emitted when the terminal version receives an unrecognized CSI sequence. -- Arguments: @@ -142,7 +142,7 @@ local M = {} -- `buffer.MOD_SHIFT`, `buffer.MOD_ALT`, and `buffer.MOD_META`. -- Note: If you set `buffer.rectangular_selection_modifier` to -- `buffer.MOD_CTRL`, the "Control" modifier is reported as *both* "Control" --- and "Alt" due to a Scintilla limitation with GTK+. +-- and "Alt" due to a Scintilla limitation with GTK. -- @field INDICATOR_RELEASE (string) -- Emitted when releasing the mouse after clicking on text that has an -- indicator present. @@ -172,7 +172,7 @@ local M = {} -- `buffer.MOD_SHIFT`, `buffer.MOD_ALT`, and `buffer.MOD_META`. -- Note: If you set `buffer.rectangular_selection_modifier` to -- `buffer.MOD_CTRL`, the "Control" modifier is reported as *both* "Control" --- and "Alt" due to a Scintilla limitation with GTK+. +-- and "Alt" due to a Scintilla limitation with GTK. -- @field MENU_CLICKED (string) -- Emitted after selecting a menu item. -- Arguments: diff --git a/doc/manual.md b/doc/manual.md index 08fdf48e..73fdcf9f 100644 --- a/doc/manual.md +++ b/doc/manual.md @@ -99,23 +99,23 @@ modifier key. ## Requirements In its bid for minimalism, Textadept also depends on very little to run. The GUI -version needs only [GTK+][], a cross-platform GUI toolkit, version 2.24 or later +version needs only [GTK][], a cross-platform GUI toolkit, version 2.24 or later (circa early-2011) on Linux and BSD systems. The application already bundles a -GTK+ runtime into the Windows and Mac OSX packages. The terminal, or curses, +GTK runtime into the Windows and Mac OSX packages. The terminal, or curses, version of Textadept only depends on a curses implementation like [ncurses][] on Linux, Mac OSX, and BSD systems. The Windows binary includes a precompiled version of [pdcurses][]. Textadept also incorporates its own [copy of Lua](#Lua.Configuration) on all platforms. -[GTK+]: http://gtk.org +[GTK]: http://gtk.org [ncurses]: http://invisible-island.net/ncurses/ncurses.html [pdcurses]: http://pdcurses.sourceforge.net ### Requirements for Linux and BSD -Most Linux and BSD systems already have GTK+ installed. If not, your package -manager probably makes it available. Otherwise, compile and install GTK+from the -[GTK+ website][]. +Most Linux and BSD systems already have GTK installed. If not, your package +manager probably makes it available. Otherwise, compile and install GTK from the +[GTK website][]. The GUI versions of Textadept require GLib version 2.28 or later (circa mid-2011) in order to support [single-instance](#Single.Instance) functionality. @@ -126,7 +126,7 @@ ncurses from the [ncurses website][]. Ensure it is the wide-character version of ncurses, which handles multibyte characters. Debian-based distributions like Ubuntu typically call the package "libncursesw5". -[GTK+ website]: http://www.gtk.org/download/linux.php +[GTK website]: http://www.gtk.org/download/linux.php [ncurses website]: http://invisible-island.net/ncurses/#download_ncurses ### Requirements for Mac OSX @@ -141,7 +141,7 @@ Windows XP or greater. Download Textadept from the project's [download page][] by selecting the appropriate package for your platform. For the Windows and Mac OSX packages, the -bundled GTK+ runtime accounts for more than 3/4 of the download and unpackaged +bundled GTK runtime accounts for more than 3/4 of the download and unpackaged application sizes. Textadept itself is much smaller. You also have the option of downloading an official set of @@ -203,7 +203,7 @@ as you would run the *textadept* executable, but from a terminal instead. Providing a single binary that runs on all Linux platforms proves challenging, since the versions of software installed vary widely from distribution to -distribution. Because the Linux version of Textadept uses the versions of GTK+ +distribution. Because the Linux version of Textadept uses the versions of GTK and ncurses installed on your system, an error like: error while loading shared libraries: <lib>: cannot open shared object @@ -1293,13 +1293,13 @@ upgrade Textadept. This applies to downloaded themes too. ## GUI Theme There is no way to theme GUI controls like text fields and buttons from within -Textadept. Instead, use [GTK+ Resource files][]. The "GtkWindow" name is +Textadept. Instead, use [GTK Resource files][]. The "GtkWindow" name is "textadept". For example, style all text fields with a "textadept-entry-style" like this: widget "textadept*GtkEntry*" style "textadept-entry-style" -[GTK+ Resource files]: https://developer.gnome.org/gtk2/stable/gtk2-Resource-Files.html +[GTK Resource files]: https://developer.gnome.org/gtk2/stable/gtk2-Resource-Files.html ## Getting Themes @@ -1575,9 +1575,9 @@ The *~/.textadept/* folder houses your preferences, Lua modules, themes, and user-data. This folder may contain *lexers/*, *modules/*, and *themes/* sub-directories. -### GTK+ Directories +### GTK Directories -GTK+ uses the *etc/*, *lib/*, and *share/* directories, which only appear in the +GTK uses the *etc/*, *lib/*, and *share/* directories, which only appear in the Win32 and Mac OSX packages. - - - @@ -1600,10 +1600,10 @@ additionally need to have [pkg-config][] and [libiconv][] installed. All of these should be available for your distribution through a package manager. For example, Ubuntu includes these tools in the "build-essential" package. -Next, the GUI version of Textadept requires the GTK+ development libraries. +Next, the GUI version of Textadept requires the GTK development libraries. Again, your package manager should allow you to install them. Debian-based Linux distributions like Ubuntu typically call the package "libgtk2.0-dev". Otherwise, -compile and install GTK+ from the [GTK+ website][]. +compile and install GTK from the [GTK website][]. The optional terminal version of Textadept depends on the development library for a curses implementation like ncurses. Similarly, your package manager should @@ -1619,7 +1619,7 @@ users _also_ need "libncursesw5-dev".) [GNU Make]: http://www.gnu.org/software/make/ [pkg-config]: http://www.freedesktop.org/wiki/Software/pkg-config/ [libiconv]: http://www.gnu.org/software/libiconv/ -[GTK+ website]: http://www.gtk.org/download/linux.php +[GTK website]: http://www.gtk.org/download/linux.php [ncurses website]: http://invisible-island.net/ncurses/#download_ncurses ### Requirements for Windows @@ -1632,7 +1632,7 @@ Your package manager should offer them. Note: compiling on Windows requires a C compiler that supports the C99 standard, a C++ compiler that supports the C++11 standard, and a C++ standard library that supports C++11, and my [win32gtk bundle][]. The terminal (pdcurses) version -requires [libiconv for Windows][] and my [win32curses bundle][] instead of GTK+. +requires [libiconv for Windows][] and my [win32curses bundle][] instead of GTK. [MinGW]: http://mingw.org [mingw-w64]: http://mingw-w64.org/ @@ -1734,15 +1734,15 @@ Build a new *Textadept.app* with `make osx-app`. #### Compiling on OSX (Legacy) -Textadept requires [XCode][] as well as [jhbuild][] (for GTK+). After building +Textadept requires [XCode][] as well as [jhbuild][] (for GTK). After building "meta-gtk-osx-bootstrap" and "meta-gtk-osx-core", build "meta-gtk-osx-themes". Note that the entire compiling process can easily take 30 minutes or more and ultimately consume nearly 1GB of disk space. -After using *jhbuild*, GTK+ is in *~/gtk/* so make a symlink from *~/gtk/inst* -to *src/gtkosx* in Textadept. Then run `make osx` to build *../textadept.osx*. +After using *jhbuild*, GTK is in *~/gtk/* so make a symlink from *~/gtk/inst* to +*src/gtkosx* in Textadept. Then run `make osx` to build *../textadept.osx*. -Developer note: in order to build a GTK+ for OSX bundle, run the following from +Developer note: in order to build a GTK for OSX bundle, run the following from the *src/* directory before zipping up *gtkosx/include/* and *gtkosx/lib/*: sed -i -e 's|libdir=/Users/username/gtk/inst/lib|libdir=${prefix}/lib|;' \ @@ -1754,7 +1754,7 @@ Compiling the terminal version is not so expensive and requires no additional libraries. Simply run `make osx-curses` to build *../textadept-curses.osx*. [XCode]: http://developer.apple.com/TOOLS/xcode/ -[jhbuild]: https://wiki.gnome.org/Projects/GTK+/OSX/Building +[jhbuild]: https://wiki.gnome.org/Projects/GTK/OSX/Building ### Notes on CDK diff --git a/modules/lua/api b/modules/lua/api index c111d0c5..9a6c1fbc 100644 --- a/modules/lua/api +++ b/modules/lua/api @@ -63,7 +63,7 @@ Cs lpeg.Cs(patt)\nCreates a substitution capture, which captures the substring o Ct lpeg.Ct(patt)\nCreates a table capture. This capture returns a table with all values from\nall anonymous captures made by `patt` inside this table in successive integer\nkeys, starting at 1. Moreover, for each named capture group created by\n`patt`, the first value of the group is put into the table with the group\nname as its key. The captured value is only the table. DEFAULT lexer.DEFAULT (string)\nThe token name for default tokens. DOCUTILS_PATH _M.rest.DOCUTILS_PATH (string)\nThe absolute path to the directory that contains the Python Docutils\nlibrary if it is not in the environment's `PYTHONPATH`.\nThe default value is `nil`, which indicates Docutils is installed. -DOUBLE_CLICK events.DOUBLE_CLICK (string)\nEmitted after double-clicking the mouse button.\nArguments:\n\n* _`position`_: The position double-clicked.\n* _`line`_: The line number of the position double-clicked.\n* _`modifiers`_: A bit-mask of any modifier keys used: `buffer.MOD_CTRL`,\n `buffer.MOD_SHIFT`, `buffer.MOD_ALT`, and `buffer.MOD_META`.\n Note: If you set `buffer.rectangular_selection_modifier` to\n `buffer.MOD_CTRL`, the "Control" modifier is reported as *both* "Control"\n and "Alt" due to a Scintilla limitation with GTK+. +DOUBLE_CLICK events.DOUBLE_CLICK (string)\nEmitted after double-clicking the mouse button.\nArguments:\n\n* _`position`_: The position double-clicked.\n* _`line`_: The line number of the position double-clicked.\n* _`modifiers`_: A bit-mask of any modifier keys used: `buffer.MOD_CTRL`,\n `buffer.MOD_SHIFT`, `buffer.MOD_ALT`, and `buffer.MOD_META`.\n Note: If you set `buffer.rectangular_selection_modifier` to\n `buffer.MOD_CTRL`, the "Control" modifier is reported as *both* "Control"\n and "Alt" due to a Scintilla limitation with GTK. DWELL_END events.DWELL_END (string)\nEmitted after `DWELL_START` when the user moves the mouse, presses a key,\nor scrolls the view.\nArguments:\n\n* _`position`_: The position closest to *x* and *y*.\n* _`x`_: The x-coordinate of the mouse in the view.\n* _`y`_: The y-coordinate of the mouse in the view. DWELL_START events.DWELL_START (string)\nEmitted when the mouse is stationary for `buffer.mouse_dwell_time`\nmilliseconds.\nArguments:\n\n* _`position`_: The position closest to *x* and *y*.\n* _`x`_: The x-coordinate of the mouse in the view.\n* _`y`_: The y-coordinate of the mouse in the view. EDGE_BACKGROUND buffer.EDGE_BACKGROUND (number, Read-only)\n @@ -104,7 +104,7 @@ FOLD_BLANK lexer.FOLD_BLANK (number)\nFlag indicating that the line is blank. FOLD_HEADER lexer.FOLD_HEADER (number)\nFlag indicating the line is fold point. FUNCTION lexer.FUNCTION (string)\nThe token name for function tokens. IDENTIFIER lexer.IDENTIFIER (string)\nThe token name for identifier tokens. -INDICATOR_CLICK events.INDICATOR_CLICK (string)\nEmitted when clicking the mouse on text that has an indicator present.\nArguments:\n\n* _`position`_: The clicked text's position.\n* _`modifiers`_: A bit-mask of any modifier keys used: `buffer.MOD_CTRL`,\n `buffer.MOD_SHIFT`, `buffer.MOD_ALT`, and `buffer.MOD_META`.\n Note: If you set `buffer.rectangular_selection_modifier` to\n `buffer.MOD_CTRL`, the "Control" modifier is reported as *both* "Control"\n and "Alt" due to a Scintilla limitation with GTK+. +INDICATOR_CLICK events.INDICATOR_CLICK (string)\nEmitted when clicking the mouse on text that has an indicator present.\nArguments:\n\n* _`position`_: The clicked text's position.\n* _`modifiers`_: A bit-mask of any modifier keys used: `buffer.MOD_CTRL`,\n `buffer.MOD_SHIFT`, `buffer.MOD_ALT`, and `buffer.MOD_META`.\n Note: If you set `buffer.rectangular_selection_modifier` to\n `buffer.MOD_CTRL`, the "Control" modifier is reported as *both* "Control"\n and "Alt" due to a Scintilla limitation with GTK. INDICATOR_RELEASE events.INDICATOR_RELEASE (string)\nEmitted when releasing the mouse after clicking on text that has an\nindicator present.\nArguments:\n\n* _`position`_: The clicked text's position. INDIC_BOX buffer.INDIC_BOX (number, Read-only)\n INDIC_BRACEMATCH textadept.editing.INDIC_BRACEMATCH (number)\nThe matching brace highlight indicator number. @@ -143,7 +143,7 @@ LINUX _G.LINUX (bool)\nWhether or not Textadept is running on Linux. MARGINOPTION_NONE buffer.MARGINOPTION_NONE (number, Read-only)\n MARGINOPTION_SUBLINESELECT buffer.MARGINOPTION_SUBLINESELECT (number, Read-only)\n MARGIN_BACK buffer.MARGIN_BACK (number, Read-only)\n -MARGIN_CLICK events.MARGIN_CLICK (string)\nEmitted when clicking the mouse inside a sensitive margin.\nArguments:\n\n* _`margin`_: The margin number clicked.\n* _`position`_: The beginning position of the clicked margin's line.\n* _`modifiers`_: A bit-mask of any modifier keys used: `buffer.MOD_CTRL`,\n `buffer.MOD_SHIFT`, `buffer.MOD_ALT`, and `buffer.MOD_META`.\n Note: If you set `buffer.rectangular_selection_modifier` to\n `buffer.MOD_CTRL`, the "Control" modifier is reported as *both* "Control"\n and "Alt" due to a Scintilla limitation with GTK+. +MARGIN_CLICK events.MARGIN_CLICK (string)\nEmitted when clicking the mouse inside a sensitive margin.\nArguments:\n\n* _`margin`_: The margin number clicked.\n* _`position`_: The beginning position of the clicked margin's line.\n* _`modifiers`_: A bit-mask of any modifier keys used: `buffer.MOD_CTRL`,\n `buffer.MOD_SHIFT`, `buffer.MOD_ALT`, and `buffer.MOD_META`.\n Note: If you set `buffer.rectangular_selection_modifier` to\n `buffer.MOD_CTRL`, the "Control" modifier is reported as *both* "Control"\n and "Alt" due to a Scintilla limitation with GTK. MARGIN_COLOUR buffer.MARGIN_COLOUR (number, Read-only)\n MARGIN_FORE buffer.MARGIN_FORE (number, Read-only)\n MARGIN_NUMBER buffer.MARGIN_NUMBER (number, Read-only)\n @@ -1059,7 +1059,7 @@ setmode lfs.setmode(file, mode)\nSets the writing mode for a file. The mode stri setupvalue debug.setupvalue(f, up, value)\nThis function assigns the value `value` to the upvalue with index `up`\nof the function `f`. The function returns nil if there is no upvalue with the\ngiven index. Otherwise, it returns the name of the upvalue. setuservalue debug.setuservalue(udata, value)\nSets the given `value` as the Lua value associated to the given `udata`.\n`udata` must be a full userdata.\n\nReturns `udata`.\n\nNew in Lua 5.2. setvbuf file:setvbuf(mode [, size])\nSets the buffering mode for an output file. There are three available\nmodes:\n "no": no buffering; the result of any output operation appears immediately.\n "full": full buffering; output operation is performed only when the\n buffer is full or when you explicitly `flush` the file (see\n `io.flush`).\n "line": line buffering; output is buffered until a newline is output or\n there is any input from some special files (such as a terminal\n device).\n\nFor the last two cases, `size` specifies the size of the buffer, in\nbytes. The default is an appropriate size. -show_documentation textadept.editing.show_documentation(pos)\nDisplays a call tip with documentation for the symbol under or directly\nbehind position *pos* or the caret position.\nDocumentation is read from API files in the `api_files` table.\nIf a call tip is already shown, cycles to the next one if it exists.\nSymbols are determined by using `buffer.word_chars`.\n@param pos Optional position of the symbol to show documentation for. If\n omitted, the caret position is used.\n@see api_files\n@see buffer.word_chars +show_documentation textadept.editing.show_documentation(pos, case_insensitive)\nDisplays a call tip with documentation for the symbol under or directly\nbehind position *pos* or the caret position.\nDocumentation is read from API files in the `api_files` table.\nIf a call tip is already shown, cycles to the next one if it exists.\nSymbols are determined by using `buffer.word_chars`.\n@param pos Optional position of the symbol to show documentation for. If\n omitted, the caret position is used.\n@param case_insensitive Optional flag that indicates whether or not to search\n API files case-insensitively for symbols. The default value is `false`.\n@see api_files\n@see buffer.word_chars show_lines buffer.show_lines(buffer, start_line, end_line)\nShows the range of lines between line numbers *start_line* to *end_line*.\nThis has no effect on fold levels or fold flags and the first line cannot be\nhidden.\n@param buffer A buffer.\n@param start_line The start line of the range of lines in *buffer* to show.\n@param end_line The end line of the range of lines in *buffer* to show. silent_print ui.silent_print (bool)\nWhether or not to print messages to buffers silently.\nThis is not guaranteed to be a constant value, as Textadept may change it\nfor the editor's own purposes. This flag should be used only in conjunction\nwith a group of `ui.print()` and `ui._print()` function calls.\nThe default value is `false`, and focuses buffers when messages are printed\nto them. sin math.sin(x)\nReturns the sine of `x` (assumed to be in radians). diff --git a/modules/textadept/menu.lua b/modules/textadept/menu.lua index 7a8da077..bbfe6d33 100644 --- a/modules/textadept/menu.lua +++ b/modules/textadept/menu.lua @@ -414,10 +414,10 @@ end -- Creates a menu suitable for `ui.menu()` from the menu table format. -- Also assigns key commands. --- @param menu The menu to create a GTK+ menu from. +-- @param menu The menu to create a GTK menu from. -- @param contextmenu Flag indicating whether or not the menu is a context menu. -- If so, menu_id offset is 1000. The default value is `false`. --- @return GTK+ menu that can be passed to `ui.menu()`. +-- @return GTK menu that can be passed to `ui.menu()`. -- @see ui.menu local function read_menu_table(menu, contextmenu) local gtkmenu = {} |