diff options
Diffstat (limited to 'doc')
| -rw-r--r-- | doc/01_Introduction.md | 4 | ||||
| -rw-r--r-- | doc/02_Installation.md | 36 | ||||
| -rw-r--r-- | doc/04_WorkingWithFiles.md | 19 | ||||
| -rw-r--r-- | doc/06_AdeptEditing.md | 36 | ||||
| -rw-r--r-- | doc/07_Modules.md | 6 | ||||
| -rw-r--r-- | doc/08_Preferences.md | 19 | ||||
| -rw-r--r-- | doc/09_Themes.md | 10 | ||||
| -rw-r--r-- | doc/11_Scripting.md | 5 | ||||
| -rw-r--r-- | doc/12_Compiling.md | 19 | ||||
| -rw-r--r-- | doc/14_Appendix.md | 7 | ||||
| -rw-r--r-- | doc/images/docstatusbar.png | bin | 3331 -> 3340 bytes |
11 files changed, 81 insertions, 80 deletions
diff --git a/doc/01_Introduction.md b/doc/01_Introduction.md index be57529f..2c98e04f 100644 --- a/doc/01_Introduction.md +++ b/doc/01_Introduction.md @@ -45,8 +45,8 @@ commands on-the-fly to handling core events. The possibilities are limitless. This manual uses notation that is worth clarifying. Directories and file paths are represented like this: */path/to/dir/* and -*/path/to/file*. (On Windows machines, "/" and "\" can be used interchangeably -as directory separators.) Any relative paths, paths that do not begin with "/" +*/path/to/file*. (On Windows machines, '/' and '\' can be used interchangeably +as directory separators.) Any relative paths, paths that do not begin with '/' or "C:\", are relative to the location of Textadept. *~/* is denoted as the user's home directory. On Windows machines this is the value of the "USERHOME" environment variable, typically *C:\Users\username\\* or diff --git a/doc/02_Installation.md b/doc/02_Installation.md index b6429840..c4d1cabc 100644 --- a/doc/02_Installation.md +++ b/doc/02_Installation.md @@ -25,11 +25,11 @@ can compile Textadept with earlier versions of GLib down to 2.22. For reference, Ubuntu 11.04, Debian Wheezy, Fedora 15, and openSUSE 11.4 support GLib 2.28 or later. -Most Linux and BSD systems already have ncurses installed. If not, look for it in -your package manager, or compile and install it from the [ncurses website][]. -For Debian-based distributions like Ubuntu, the package is typically called -"libncursesw5". Note: you need to have the wide-character version of ncurses -installed, which handles multibyte characters. +Most Linux and BSD systems already have ncurses installed. If not, look for it +in your package manager, or compile and install it from the [ncurses website][]. +You need to have or compile the wide-character version of ncurses, which handles +multibyte characters. For Debian-based distributions like Ubuntu, the package is +typically called "libncursesw5". [GTK+ website]: http://www.gtk.org/download-linux.html [ncurses website]: http://invisible-island.net/ncurses/#download_ncurses @@ -69,7 +69,7 @@ Unpack the archive anywhere. If you downloaded the set of language-specific modules, unpack it where you unpacked the Textadept archive. The modules will be contained in the -*/path/to/textadept_VERSION/modules/* directory. +*/path/to/textadept_x.x/modules/* directory. ### Mac OSX @@ -88,16 +88,16 @@ Unpack the archive anywhere. If you downloaded the set of language-specific modules, unpack it where you unpacked the Textadept archive. The modules will be contained in the -*textadept_VERSION\modules\\* directory. +*textadept_x.x\modules\\* directory. ## Running ### Linux and BSD -Run Textadept by running */path/to/textadept_VERSION/textadept* from the -terminal. You can also create a symbolic link to the executable in a directory -in your "$PATH" (e.g. */usr/bin/*) or make a GNOME, KDE, XFCE, etc. button or -menu launcher. +Run Textadept by running */path/to/textadept_x.x/textadept* from the terminal. +You can also create a symbolic link to the executable in a directory in your +"$PATH" (e.g. */usr/local/bin/*) or make a GNOME, KDE, XFCE, etc. button or menu +launcher. There is also a *textadeptjit* executable for running Textadept with [LuaJIT][]. Please note there may be [compatibility issues][]. The *textadept* executable is @@ -142,13 +142,13 @@ non-LuaJIT executable is recommended. #### Environment Variables -By default, GUI apps like Textadept do not utilize environment variables like -"$PATH" from your shell profile. Therefore, any [modules][] that use programs -contained in "$PATH" (e.g. the progams in */usr/local/bin/*) for run and compile -commands will not be found. The solution is to follow [these instructions][] to -export whichever environment variables you need. At the very least, set "PATH" -to be "$PATH". You will have to logout and log back in for the changes to take -effect. +By default, Mac OSX GUI apps like Textadept do not utilize environment variables +like "$PATH" from your shell profile. Therefore, any [modules][] that use +programs contained in "$PATH" (e.g. the progams in */usr/local/bin/*) for run +and compile commands will not be found. The solution is to follow +[these instructions][] to export whichever environment variables you need. At +the very least, set "PATH" to be "$PATH". You will have to logout and log back +in for the changes to take effect. [modules]: 07_Modules.html [these instructions]: http://developer.apple.com/library/mac/#qa/qa1067/_index.html diff --git a/doc/04_WorkingWithFiles.md b/doc/04_WorkingWithFiles.md index 6d3958ca..1ea480ce 100644 --- a/doc/04_WorkingWithFiles.md +++ b/doc/04_WorkingWithFiles.md @@ -51,8 +51,8 @@ the "Buffer -> Indentation" menu. #### Line Endings -Line endings, commonly known as end-of-line (EOL) markers, are set based on the -current platform for new files. On Windows, CRLF ("\r\n") is used. Otherwise, LF +Line endings, commonly known as end-of-line (EOL) markers, are set for new files +based on the current platform. On Windows, CRLF ("\r\n") is used. Otherwise, LF ("\n") is. This can be changed manually using the "Buffer -> EOL Mode" menu. Unlike indentation settings, switching EOL modes converts all existing EOLs automatically. Textadept attempts to auto-detect the EOL mode of opened files @@ -86,12 +86,11 @@ files to reopen. By default, Textadept saves its state on exit so it can be restored the next time the editor starts up. You can disable this by passing the `-n` or -`--no-session` switch to Textadept on startup. Sessions can be manually saved -and opened via the "File -> Save Session..." and "File -> Load Session..." -menus. Session files store information such as open buffers, current split -views, caret and scroll positions in each buffer, Textadept's window size, and -recently opened files. Tampering with session files may have unintended -consequences. +`--nosession` switch to Textadept on startup. Sessions can be manually saved and +opened via the "File -> Save Session..." and "File -> Load Session..." menus. +Session files store information such as open buffers, current split views, caret +and scroll positions in each buffer, Textadept's window size, and recently +opened files. Tampering with session files may have unintended consequences. ### Snapopen @@ -133,7 +132,9 @@ Split views are unavailable in ncurses. Individual views have many configurable settings. Among the more useful settings are viewing line endings, handling long lines, viewing indentation guides, and -viewing whitespace. These options change how buffers in the view are displayed. +viewing whitespace. These options change how buffers in the _current_ view are +displayed. Changing a setting in one view does not change that setting in +any other split view. It will have to be done manually. #### Line Endings diff --git a/doc/06_AdeptEditing.md b/doc/06_AdeptEditing.md index 5ac52982..f5db001d 100644 --- a/doc/06_AdeptEditing.md +++ b/doc/06_AdeptEditing.md @@ -45,17 +45,17 @@ The caret also changes to an underline when in overwrite mode. Textadept has many ways of creating and working with selections. Basic selections are what you get when you do things like hold the "Shift" modifier -key (`⇧` on Mac OSX | "Shift" in ncurses) while pressing the arrow keys, click -and drag the mouse over a range of text, or press `Ctrl+A` (`⌘A` | `M-A`) for -"Select All". More advanced selections like multiple and rectangular selections -are more complicated to create, but have powerful uses. +key while pressing the arrow keys, click and drag the mouse over a range of +text, or press `Ctrl+A` (`⌘A` | `M-A`) for "Select All". More advanced +selections like multiple and rectangular selections are more complicated to +create, but have powerful uses. ### Multiple Selection Clicking the mouse at a point in the buffer while holding the "Control" modifier -key (`^` on Mac OSX | N/A in ncurses) places an additional caret at that point. -Clicking and dragging while holding the same modifier creates multiple -selections. When you start typing, the text is mirrored at each selection. +key places an additional caret at that point. Clicking and dragging while +holding the same modifier creates multiple selections. When you start typing, +the text is mirrored at each selection. Creating multiple selections with the mouse is currently unavailable in ncurses. @@ -63,9 +63,8 @@ Creating multiple selections with the mouse is currently unavailable in ncurses. Holding `Alt+Shift` (`⌥⇧` on Mac OSX | `M-S-` in ncurses) and pressing the arrow keys enables rectangular selections to be made. Start typing to type on each -line. You can also hold the "Alt" modifier key ("Super" on Linux | `⌥` on Mac -OSX | N/A in ncurses) while clicking and dragging the mouse to create -rectangular selections. +line. You can also hold the "Alt" modifier key ("Super" on Linux) while clicking +and dragging the mouse to create rectangular selections.  @@ -78,6 +77,9 @@ change [`buffer.rectangular_selection_modifier`][] in your [theme][]. The "Super" modifier key is usually defined as the left "Windows" key, but may need to be reconfigured too. +Creating rectangular selections with the mouse is currently unavailable in +ncurses. + [`buffer.rectangular_selection_modifier`]: api/buffer.html#rectangular_selection_modifier [theme]: 09_Themes.html#View @@ -91,9 +93,9 @@ selection to the brace character's matching brace. Textadept allows you to select many different entities from the caret. For example, `Ctrl+"` (`^"` on Mac OSX | `M-"` in ncurses) selects all characters in -a double-quoted sequence. Typing `Ctrl++` (`^+` | `M-+`) as a follow-up selects -the double-quotes too. See the "Edit -> Select In..." menu for available -entities and their key bindings. +a double-quoted range. Typing `Ctrl++` (`^+` | `M-+`) as a follow-up selects the +double-quotes too. See the "Edit -> Select In..." menu for available entities +and their key bindings. ### Marks @@ -117,12 +119,14 @@ As a complement to selecting entities, you can enclose text as entities. The "Edit -> Selection -> Enclose In..." menu contains all available entities and their key bindings. -If no text is selected, the word to the left of the caret is enclosed. +If no text is selected, the word to the left of the caret is enclosed. For +example, pressing `Alt+<` (`^<` on Mac OSX | `M->` in ncurses) at the end of a +word encloses it in XML tags. #### Change Case Pressing `Ctrl+Alt+U` or `Ctrl+Alt+Shift+U` (`^U` or `^⇧U` on Mac OSX | `M-^U` -or `M-^L` in ncurses) converts selected text to upper-case letters or lower-case +or `M-^L` in ncurses) converts selected text to uppercase letters or lowercase letters respectively. #### Change Indent Level @@ -223,7 +227,7 @@ highlight syntax incorrectly. Pressing `F5` triggers a full redraw. ### Code Folding -Some lexers support code folding, where blocks of code can be temporarily +Some lexers support "code folding", where blocks of code can be temporarily hidden, making viewing easier. Fold points are denoted by arrows in the margin to the left of the code. Clicking on one toggles the folding for that block of code. You can also press `Ctrl+*` (`⌘*` on Mac OSX | `M-*` in ncurses) to diff --git a/doc/07_Modules.md b/doc/07_Modules.md index f78419ee..fb8faca1 100644 --- a/doc/07_Modules.md +++ b/doc/07_Modules.md @@ -22,13 +22,11 @@ modules when Textadept starts. Language-specific modules have a scope limited to a single programming language. The name of the module is named after the language's lexer in the *lexers/* directory and is automatically loaded when editing source code in that -particular language. In addition to some of the editing features discussed -[earlier][], these kinds of modules typically also have shell commands for +particular language. In addition to the source code editing features discussed +previously, these kinds of modules typically also have shell commands for running and compiling code, indentation settings, custom key bindings, and perhaps a custom context menu. These features are discussed below. -[earlier]: 06_AdeptEditing.html#Source.Code.Editing - ### Compile and Run Most language-specific modules have a command that compiles and/or runs the code diff --git a/doc/08_Preferences.md b/doc/08_Preferences.md index 49e7b4a1..a8b4c15d 100644 --- a/doc/08_Preferences.md +++ b/doc/08_Preferences.md @@ -20,15 +20,16 @@ empty, no modules are loaded (pretty much rendering Textadept useless). It is never recommended to modify the default modules that come with Textadept, even if you just want to change an option in a generic module, modify the buffer -settings for a language-specific module, edit file types, or just add a small -bit of custom code. Those changes may be overwritten when you upgrade Textadept -to a newer version. Instead you have two options: load your own module instead -of the default one, or run your custom module code after the default module -loads. To load your own module, simply place it appropriately in -*~/.textadept/modules/*. To run your module code after a default generic module -loads, put your code in *~/.textadept/init.lua*. To run your module code after a -default language-specific module loads, create a *post_init.lua* Lua script in -the appropriate *~/.textadept/modules/* module folder. +settings for a language-specific module, edit file types, or add a small bit of +custom code. Those changes may be overwritten when you upgrade Textadept to a +newer version. Instead you have two options: load your own module instead of the +default one, or run your custom module code after the default module loads. To +load your own module, simply place it appropriately in *~/.textadept/modules/*. +To run your module code after a default generic module loads, put your code in +*~/.textadept/init.lua*. To run your module code after a default +language-specific module loads, create a *post_init.lua* Lua script in the +appropriate *~/.textadept/modules/* module folder. These methods are discussed +below. ### Generic diff --git a/doc/09_Themes.md b/doc/09_Themes.md index 5d702db3..34d31c4e 100644 --- a/doc/09_Themes.md +++ b/doc/09_Themes.md @@ -31,10 +31,11 @@ elements, resulting in a single, unified theme. In the terminal version of Textadept, colors are determined by your terminal emulator's settings. The only colors recognized by Textadept are the standard black, red, green, yellow, blue, magenta, cyan, white, and bold variants of -those colors. How your terminal chooses to display these colors is up to you. -However, you can still customize which colors are used for particular styles. +those colors. How your terminal chooses to display these colors is up to your +terminal settings. However, you can still customize which colors are used for +particular styles. -[Styles]: api/lexer.html#Styling.Tokens +[Styles]: api/lexer.html#Styles.and.Styling ### Buffer @@ -78,7 +79,8 @@ Behind the scenes, Textadept is setting the theme name in a *~/.textadept/theme* or *~/.textadept/theme_term* file. To use a theme not listed, specify an absolute path to the theme's folder in your *~/.textadept/theme* or *~/.textadept/theme_term* file. When testing themes, any errors that occur are -printed to standard error. +printed to standard error. Running Textadept from a terminal is the easiest way +to see errors as they occur. [language-specific module]: 07_Modules.html#Buffer.Properties diff --git a/doc/11_Scripting.md b/doc/11_Scripting.md index 2f6a659b..facc1a55 100644 --- a/doc/11_Scripting.md +++ b/doc/11_Scripting.md @@ -89,9 +89,8 @@ are located in *lexers/*. ### Modules -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. +Generic and language-specific modules for editing text and source code are +contained in *modules/*. ### Themes diff --git a/doc/12_Compiling.md b/doc/12_Compiling.md index 03cad669..077b726e 100644 --- a/doc/12_Compiling.md +++ b/doc/12_Compiling.md @@ -38,7 +38,7 @@ In addition, BSD users will need to have [libiconv][] installed. Compiling Textadept on Windows is no longer supported. If you wish to do so however, you need a C compiler that supports the C99 standard, the [GTK+ for Windows bundle][] (2.24 is recommended), and [libiconv for Windows][] -(the "Developer files" and "Binaries" zip). +(the "Developer files" and "Binaries" zip files). The preferred way to compile for Windows is cross-compiling from Linux. To do so, in addition to the GTK+ bundle mentioned above, you need [MinGW][] with the @@ -90,12 +90,12 @@ a normal Linux application, run the usual `make` and then `make install` or ### Cross Compiling for Windows When cross-compiling from within Linux, first unzip the GTK+ for Windows bundle -into a new *src/win32gtk* directory. Also, unzip the libiconv zips into the same -directory. Then, depending on your MinGW installation, either run `make win32`, -modify the `CROSS` variable in the "win32" block of *src/Makefile* and run -`make win32`, or run `make CROSS=i486-mingw32- win32` to build +into a new *src/win32gtk/* directory. Also, unzip the libiconv zips into the +same directory. Then, depending on your MinGW installation, either run +`make win32`, modify the `CROSS` variable in the "win32" block of *src/Makefile* +and run `make win32`, or run `make CROSS=i486-mingw32- win32` to build *../textadept.exe* and *../textadeptjit.exe*. Finally, copy the dll files from -*src/win32gtk/bin* to the directory containing the Textadept executables. +*src/win32gtk/bin/* to the directory containing the Textadept executables. Please note that a *lua51.dll* is produced for _only_ the *textadeptjit.exe* because limitations on external Lua library loading do not allow statically @@ -104,7 +104,7 @@ linking LuaJIT to Textadept. ### Cross Compiling for Mac OSX When cross-compiling from within Linux, first unzip the GTK+ for OSX bundle into -a new *src/gtkosx* directory. Then run `make osx` to build *../textadept.osx* +a new *src/gtkosx/* directory. Then run `make osx` to build *../textadept.osx* and *../textadeptjit.osx*. At this point it is recommended to build a new *Textadept.app* from an existing one. Download the most recent app and replace *Contents/MacOS/textadept.osx* and *Contents/MacOS/textadeptjit.osx* with your @@ -126,7 +126,7 @@ to *src/gtkosx* in Textadept. Then open *src/Makefile* and uncomment the *../textadeptjit.osx*. Note: to build a GTK+ for OSX bundle, the following needs to be run from the -*src/* directory before zipping up *gtkosx/include* and *gtkosx/lib*: +*src/* directory before zipping up *gtkosx/include/* and *gtkosx/lib/*: sed -i -e 's|libdir=/Users/username/gtk/inst/lib|libdir=${prefix}/lib|;' \ gtkosx/lib/pkgconfig/*.pc @@ -135,7 +135,8 @@ where `username` is replaced with your username. Compiling the terminal version is not so expensive. After uncommenting the "Darwin" block mentioned above, simply run `make osx-ncurses` to build -*../textadept-ncurses.osx* and *../textadeptjit-ncurses.osx*. +*../textadept-ncurses.osx* and *../textadeptjit-ncurses.osx*. No additional +libraries are needed. [XCode]: http://developer.apple.com/TOOLS/xcode/ [jhbuild]: http://sourceforge.net/apps/trac/gtk-osx/wiki/Build diff --git a/doc/14_Appendix.md b/doc/14_Appendix.md index 4ce299e1..f335f246 100644 --- a/doc/14_Appendix.md +++ b/doc/14_Appendix.md @@ -315,14 +315,9 @@ or and -- File ~/.textadept/init.lua - require 'textadept' + _M.textadept = require 'textadept' _M.foo = require 'foo' -Please remember that, as stated in the documentation, `require 'textadept'` is a -special case and `_M.textadept = require 'textadept'` is not necessary because -of internal dependencies. All other modules need the -`_M.module = require 'module'` construct. - Notice that `_M` is the new module table instead of `_m`. More on this [later](#Global.Module.Table). diff --git a/doc/images/docstatusbar.png b/doc/images/docstatusbar.png Binary files differindex ba77480a..3e096781 100644 --- a/doc/images/docstatusbar.png +++ b/doc/images/docstatusbar.png |
