diff options
Diffstat (limited to 'doc')
| -rw-r--r-- | doc/01_Introduction.md | 26 | ||||
| -rw-r--r-- | doc/02_Installation.md | 63 | ||||
| -rw-r--r-- | doc/04_WorkingWithFiles.md | 16 | ||||
| -rw-r--r-- | doc/05_FileNavigation.md | 2 | ||||
| -rw-r--r-- | doc/06_AdeptEditing.md | 54 | ||||
| -rw-r--r-- | doc/07_Modules.md | 10 | ||||
| -rw-r--r-- | doc/08_Preferences.md | 72 | ||||
| -rw-r--r-- | doc/09_Themes.md | 38 | ||||
| -rw-r--r-- | doc/10_Advanced.md | 2 | ||||
| -rw-r--r-- | doc/11_Scripting.md | 30 | ||||
| -rw-r--r-- | doc/12_Compiling.md | 88 | ||||
| -rw-r--r-- | doc/13_Help.md | 2 | ||||
| -rw-r--r-- | doc/14_Appendix.md | 34 | ||||
| -rw-r--r-- | doc/markdowndoc.lua | 1 |
14 files changed, 220 insertions, 218 deletions
diff --git a/doc/01_Introduction.md b/doc/01_Introduction.md index 6171ff2e..be57529f 100644 --- a/doc/01_Introduction.md +++ b/doc/01_Introduction.md @@ -44,23 +44,23 @@ 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/file_or_dir`. -(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 -`C:\Documents and Settings\<username>\`. On Linux, BSD, and Mac OSX machines it -is the value of `HOME`, typically `/home/<username>/` and `/Users/<username>/` +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 "/" +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 +*C:\Documents and Settings\username\\*. On Linux, BSD, and Mac OSX machines +it is the value of "$HOME", typically */home/username/* and */Users/username/* respectively. Key bindings are represented like this: `Ctrl+N`. They are not case sensitive. -`Ctrl+N` means the `N` key is pressed with only the `Control` modifier key being -held down, not the `Shift` modifier key. `Ctrl+Shift+N` means the `N` key is -pressed with both `Control` and `Shift` modifiers held down. The same notation +`Ctrl+N` means the "N" key is pressed with only the "Control" modifier key being +held down, not the "Shift" modifier key. `Ctrl+Shift+N` means the "N" key is +pressed with both "Control" and "Shift" modifiers held down. The same notation is applicable to key chains: `Ctrl+N, N` vs. `Ctrl+N, Shift+N`. In the first key -chain, `Control` and `N` are pressed followed by `N` with no modifiers. The -second has `Control` and `N` pressed followed by `Shift` and `N`. +chain, "Control" and "N" are pressed followed by "N" with no modifiers. The +second has "Control" and "N" pressed followed by "Shift" and "N". When key bindings are mentioned, the Mac OSX and ncurses equivalents are often shown in parenthesis. It may be tempting to assume that some Windows/Linux keys diff --git a/doc/02_Installation.md b/doc/02_Installation.md index 7bf3b11f..b6429840 100644 --- a/doc/02_Installation.md +++ b/doc/02_Installation.md @@ -28,8 +28,8 @@ 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 a version of ncurses compiled with "wide" -(multibyte) character support installed. +"libncursesw5". Note: you need to have the wide-character version of ncurses +installed, which handles multibyte characters. [GTK+ website]: http://www.gtk.org/download-linux.html [ncurses website]: http://invisible-island.net/ncurses/#download_ncurses @@ -69,18 +69,18 @@ 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_VERSION/modules/* directory. ### Mac OSX -Unpack the archive and move `Textadept.app` to your user or system -`Applications` directory like any other Mac OSX application. There is also a -`ta` script for launching Textadept from the command line that you can put in -your `PATH` (e.g. `/usr/local/bin`), but this is optional. +Unpack the archive and move *Textadept.app* to your user or system +*Applications/* directory like any other Mac OSX application. There is also a +*ta* script for launching Textadept from the command line that you can put in +a directory in your "$PATH" (e.g. */usr/local/bin/*), but this is optional. If you downloaded the set of language-specific modules, unpack it, right-click -`Textadept.app`, select `Show Package Contents`, navigate to -`Contents/Resources/modules/`, and copy the unpacked modules there. +*Textadept.app*, select "Show Package Contents", navigate to +*Contents/Resources/modules/*, and copy the unpacked modules there. ### Windows @@ -88,23 +88,24 @@ 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_VERSION\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 your `PATH` -(e.g. `/usr/bin`) or make a GNOME, KDE, XFCE, etc. button or menu launcher. +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. -There is also a `textadeptjit` executable for running Textadept with [LuaJIT][]. -Please note there may be [compatibility issues][]. The `textadept` executable is +There is also a *textadeptjit* executable for running Textadept with [LuaJIT][]. +Please note there may be [compatibility issues][]. The *textadept* executable is recommended. -The `textadept-ncurses` and `textadeptjit-ncurses` executables are versions of -Textadept for the terminal. Run them as you would run the `textadept` and -`textadeptjit` executables, but from a terminal instead. +The *textadept-ncurses* and *textadeptjit-ncurses* executables are versions of +Textadept for the terminal. Run them as you would run the *textadept* and +*textadeptjit* executables, but from a terminal instead. [LuaJIT]: http://luajit.org [compatibility issues]: 11_Scripting.html#LuaJIT @@ -127,11 +128,11 @@ page for more information. ### Mac OSX -Run Textadept by double-clicking `Textadept.app`. You can also pin it to your +Run Textadept by double-clicking *Textadept.app*. You can also pin it to your dock. -`Textadept.app` also contains an executable for running Textadept with -[LuaJIT][]. You can enable it by setting a `TEXTADEPTJIT` +*Textadept.app* also contains an executable for running Textadept with +[LuaJIT][]. You can enable it by setting a "TEXTADEPTJIT" [environment variable](#Environment.Variables) or using `export TEXTADEPTJIT=1` in the terminal. Please note there may be [compatibility issues][]. The non-LuaJIT executable is recommended. @@ -142,11 +143,11 @@ 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 +"$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 +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 @@ -154,19 +155,19 @@ effect. ### Windows -Run Textadept by double-clicking `textadept.exe`. You can also create shortcuts +Run Textadept by double-clicking *textadept.exe*. You can also create shortcuts to the executable in your Start Menu, Quick Launch toolbar, Desktop, etc. -There is also a `textadeptjit.exe` executable for running Textadept with +There is also a *textadeptjit.exe* executable for running Textadept with [LuaJIT][]. Please note there may be [compatibility issues][]. The -`textadept.exe` executable is recommended. +*textadept.exe* executable is recommended. [LuaJIT]: http://luajit.org [compatibility issues]: 11_Scripting.html#LuaJIT -### `~/.textadept` +### *~/.textadept* -Textadept stores all of your preferences and user-data in your `~/.textadept/` +Textadept stores all of your preferences and user-data in your *~/.textadept/* folder. If this folder does not exist, Textadept creates it on startup. You will learn more about this folder later. @@ -175,7 +176,7 @@ learn more about this folder later. Textadept is a single-instance application on Linux, BSD, and Mac OSX. This means that after Textadept is opened, running `textadept file.ext` (`ta file.ext` on Mac OSX) from the command line or opening a file with -Textadept from a file manager will open `file.ext` in the existing instance of +Textadept from a file manager will open *file.ext* in the existing instance of Textadept. You can override this and open the file in a new instance by passing a `-f` or `--force` switch to Textadept: `textadept -f file.ext` (`ta -f file.ext`). When the force switch is not present, files will be opened diff --git a/doc/04_WorkingWithFiles.md b/doc/04_WorkingWithFiles.md index c9119292..6d3958ca 100644 --- a/doc/04_WorkingWithFiles.md +++ b/doc/04_WorkingWithFiles.md @@ -44,7 +44,7 @@ future indentation; it does not convert existing indentation. `Ctrl+Alt+I` (`^I` | `M-I`) performs the conversion. (If the buffer is using tabs, all indenting spaces are converted to tabs. If the buffer is using spaces, all indenting tabs are converted to spaces.) Similarly, you can set indentation size manually using -the `Buffer -> Indentation` menu. +the "Buffer -> Indentation" menu. [language-specific module]: 07_Modules.html#Buffer.Properties [theme]: 09_Themes.html#Buffer @@ -52,8 +52,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 -(`\n`) is. This can be changed manually using the `Buffer -> EOL Mode` menu. +current platform for new files. 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 regardless of the current platform, but falls back to the defaults mentioned @@ -70,7 +70,7 @@ list of encodings Textadept tries to detect via [`io.try_encodings`][]. It is recommended to use UTF-8 encoded files because UTF-8 is very well supported by other text editors and operating systems. You can change file -encoding via the `Buffer -> Encoding` menu. Conversion is immediate, requiring +encoding via the "Buffer -> Encoding" menu. Conversion is immediate, requiring no separate steps. Textadept saves new files as UTF-8 by default, but does not alter the encoding of existing files. @@ -87,7 +87,7 @@ 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...` +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 @@ -99,9 +99,9 @@ A quicker, though slightly more limited alternative to the standard file selection dialog is snapopen. It behaves like the buffer browser, but displays a list of files to open, including files in sub-directories. You can snapopen the current file's directory with `Ctrl+Alt+Shift+O` (`^⌘⇧O` on Mac OSX | `M-S-O` in -ncurses) or from the `Tools -> Snapopen -> Current Directory` menu. Snapopen is +ncurses) or from the "Tools -> Snapopen -> Current Directory" menu. Snapopen is pretty limited from the menu, but more versatile in [scripts][]. `Ctrl+U` (`⌘U` -| `^U`) snaps open `~/.textadept/`. +| `^U`) snaps open *~/.textadept/*. [scripts]: api/_M.textadept.snapopen.html @@ -137,7 +137,7 @@ viewing whitespace. These options change how buffers in the view are displayed. #### Line Endings -Normally, EOL characters (`\r` and `\n`) are invisible. Pressing +Normally, EOL characters ("\r" and "\n") are invisible. Pressing `Ctrl+Alt+Enter` (`^↩` on Mac OSX | none in ncurses) toggles their visibility. #### Long Lines diff --git a/doc/05_FileNavigation.md b/doc/05_FileNavigation.md index a1db0ed0..4e21f8fb 100644 --- a/doc/05_FileNavigation.md +++ b/doc/05_FileNavigation.md @@ -16,7 +16,7 @@ movement bindings is found in the "Movement" section of the ## Brace Match By default, Textadept will highlight the matching brace characters under the -caret : `(`, `)`, `[`, `]`, `{`, and `}`. Pressing `Ctrl+M` (`^M` on Mac OSX | +caret : '(', ')', '[', ']', '{', and '}'. Pressing `Ctrl+M` (`^M` on Mac OSX | `M-M` in ncurses) moves the caret to that matching brace.  diff --git a/doc/06_AdeptEditing.md b/doc/06_AdeptEditing.md index 994c7ff5..5ac52982 100644 --- a/doc/06_AdeptEditing.md +++ b/doc/06_AdeptEditing.md @@ -5,17 +5,17 @@ Textadept has many basic editing features you are familiar with: basic text entry, undo/redo, clipboard manipulation, deleting characters and words, duplicating lines, joining lines, and transposing characters. These are -accessible from the top-level `Edit` menu and have associated key bindings. +accessible from the top-level "Edit" menu and have associated key bindings. Some of the basic editing features you may not be familiar with are discussed below. ### Autopaired Characters -Usually, quote (`'`, `"`) and brace (`(`, `[`, `{`) characters go together in -pairs. By default, Textadept automatically inserts the complement character when -the first is typed. Similarly, the complement is deleted when you press `Bksp` -(`⌫` on Mac OSX | `Bksp` in ncurses) over the first. See the [preferences][] -page if you would like to disable this. +Usually, quote (''', '"') and brace ('(', '[', '{') characters go +together in pairs. By default, Textadept automatically inserts the complement +character when the first is typed. Similarly, the complement is deleted when you +press `Bksp` (`⌫` on Mac OSX | `Bksp` in ncurses) over the first. See the +[preferences][] page if you would like to disable this. [preferences]: 08_Preferences.html#Generic @@ -44,15 +44,15 @@ The caret also changes to an underline when in overwrite mode. ## Selections 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 | `S-` 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 +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. ### Multiple Selection -Clicking the mouse at a point in the buffer while holding the `Ctrl` modifier +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. @@ -63,7 +63,7 @@ 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 +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. @@ -72,10 +72,10 @@ rectangular selections.  Note: In some Linux environments, the `Alt+Shift+Arrow` combinations are used by -the window manager and may need to be reconfigured. Also, `Super`+Mouse is used -because `Alt`+Mouse generally moves windows. If you prefer to use `Alt`, you can +the window manager and may need to be reconfigured. Also, `Super+Mouse` is used +because `Alt+Mouse` generally moves windows. If you prefer to use "Alt", you can change [`buffer.rectangular_selection_modifier`][] in your [theme][]. The -`Super` modifier key is usually defined as the left "Windows" key, but may need +"Super" modifier key is usually defined as the left "Windows" key, but may need to be reconfigured too. [`buffer.rectangular_selection_modifier`]: api/buffer.html#rectangular_selection_modifier @@ -83,7 +83,7 @@ to be reconfigured too. ### Select to Matching Brace -Putting the caret over a brace character (`(`, `)`, `[`, `]`, `{`, or `}`) and +Putting the caret over a brace character ('(', ')', '[', ']', '{', or '}') and pressing `Ctrl+Shift+M` (`^⇧M` on Mac OSX| `M-S-M` in ncurses) extends the selection to the brace character's matching brace. @@ -91,9 +91,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 `""` 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 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. ### Marks @@ -114,7 +114,7 @@ Marks are only supported in ncurses. #### Enclose Entities As a complement to selecting entities, you can enclose text as entities. The -`Edit -> Selection -> Enclose In...` menu contains all available entities and +"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. @@ -146,9 +146,9 @@ line is eligible for moving. Replace pane. In addition to offering the usual find and replace with "Match Case" and "Whole Word" options and find/replace history, Textadept allows you to find with [Lua patterns][] and replace with Lua captures and even Lua code! For -example: replacing all `(%w+)` with `%(string.upper('%1'))` upper-cases all -words in the buffer. Lua captures (`%`_`n`_) are only available from a Lua -pattern search, but embedded Lua code enclosed in `%()` is always allowed. +example: replacing all `(%w+)` with `%(string.upper('%1'))` uppercases all words +in the buffer. Lua captures (`%`_`n`_) are only available from a Lua pattern +search, but embedded Lua code enclosed in `%()` is always allowed. Note the `Ctrl+G`, `Ctrl+Shift+G`, `Ctrl+Alt+R`, `Ctrl+Alt+Shift+R` key bindings for find next, find previous, replace, and replace all (`⌘G`, `⌘⇧G`, `^R`, `^⇧R` @@ -168,9 +168,9 @@ Pressing `Esc` (`⎋` | `Esc`) hides the pane when you are finished. ### Replace in Selection -By default, `Replace All` replaces all text in the buffer. If you want to +By default, "Replace All" replaces all text in the buffer. If you want to replace all text in just a portion of the buffer, select a block of text and -then `Replace All`. +then "Replace All". ### Find in Files @@ -179,8 +179,8 @@ will prompt for a directory to search. The results are displayed in a new buffer. Double-clicking a search result jumps to it in the file. You can also use the `Ctrl+Alt+G` and `Ctrl+Alt+Shift+G` (`^⌘G` and `^⌘⇧G` on Mac OSX | none in ncurses) key bindings. Replace in Files is not supported. You will have to -`Find in Files` first, and then `Replace All` for each file a result is found -in. The `Match Case`, `Whole Word`, and `Lua pattern` flags still apply. +"Find in Files" first, and then "Replace All" for each file a result is found +in. The "Match Case", "Whole Word", and "Lua pattern" flags still apply. _Warning_: currently, there is no way to specify a file-type filter, so Find in Files will scan **all** files, even binary ones, in **all** sub-directories. @@ -197,7 +197,7 @@ such as [ack][] is recommended. You can start an incremental search by pressing `Ctrl+Alt+F` (`^⌘F` on Mac OSX | `M-^F` in ncurses). Incremental search searches the buffer as you type. Only the -`Match Case` option is recognized. Pressing `Esc` (`⎋` | `Esc`) stops the +"Match Case" option is recognized. Pressing `Esc` (`⎋` | `Esc`) stops the search. ## Source Code Editing diff --git a/doc/07_Modules.md b/doc/07_Modules.md index b46e3f91..f78419ee 100644 --- a/doc/07_Modules.md +++ b/doc/07_Modules.md @@ -20,7 +20,7 @@ modules when Textadept starts. ## Language-Specific 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/` +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 @@ -87,12 +87,12 @@ For now, user-created modules are obtained from the [wiki][]. ## Installing Modules If you do not have write permissions for the directory Textadept is installed -in, place the module in your `~/.textadept/modules/` folder and replace all -instances of `_HOME` with `_USERHOME` in the module's `init.lua`. It is +in, place the module in your *~/.textadept/modules/* folder and replace all +instances of `_HOME` with `_USERHOME` in the module's *init.lua*. It is recommended to put all custom or user-created modules in your -`~/.textadept/modules/` directory so they will not be overwritten when you +*~/.textadept/modules/* directory so they will not be overwritten when you update Textadept. Also, modules in that directory override any modules in -Textadept's `modules/` directory. This means that if you have your own `lua` +Textadept's *modules/* directory. This means that if you have your own *lua* module, it will be loaded instead of the one that comes with Textadept. ## Developing Modules diff --git a/doc/08_Preferences.md b/doc/08_Preferences.md index 7fb21c22..49e7b4a1 100644 --- a/doc/08_Preferences.md +++ b/doc/08_Preferences.md @@ -7,13 +7,13 @@ At this point it is assumed you are at least familiar with the basics of ## User Init -Textadept executes a `~/.textadept/init.lua`, your user-init file, on startup. +Textadept executes a *~/.textadept/init.lua*, your user-init file, on startup. If this file does not exist, Textadept creates it for you. You can use the file to indicate what you want Textadept to do when the application starts. At first, it simply loads a module that contains most of Textadept's functionality. However, you are not restricted to just loading modules. You can run any Lua code you desire. It is important to realize that Textadept will not load -anything you do not tell it to. If your `~/.textadept/init.lua` exists and is +anything you do not tell it to. If your *~/.textadept/init.lua* exists and is empty, no modules are loaded (pretty much rendering Textadept useless). ## Modules @@ -25,17 +25,17 @@ 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. +*~/.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. ### Generic Many of Textadept's generic modules have settings you can change from -`~/.textadept/init.lua` after the module is loaded. These settings are viewed +*~/.textadept/init.lua* after the module is loaded. These settings are viewed from module's [LuaDoc][]. For example, to disable character autopairing and -stripping whitespace on save, your `~/.textadept/init.lua` might look like: +stripping whitespace on save, your *~/.textadept/init.lua* might look like: _M.textadept = require 'textadept' @@ -43,8 +43,8 @@ stripping whitespace on save, your `~/.textadept/init.lua` might look like: _M.textadept.editing.STRIP_WHITESPACE_ON_SAVE = false Now suppose you wanted to load all of Textadept's default modules except for the -menu. Copy the `textadept` module's `init.lua` (located in the -`modules/textadept/` directory) to `~/.textadept/modules/textadept/` and change +menu. Copy the `textadept` module's *init.lua* (located in the +*modules/textadept/* directory) to *~/.textadept/modules/textadept/* and change M.menu = require 'textadept.menu' @@ -52,37 +52,37 @@ to --M.menu = require 'textadept.menu' -Now when Textadept looks for `modules/textadept/init.lua`, it will load yours +Now when Textadept looks for *modules/textadept/init.lua*, it will load yours instead of its own, and load everything but the menu. If instead you wanted to -completely change the menu structure, you would first create a new `menu.lua` -and then put it in `~/.textadept/modules/textadept/`. Textadept will now load -your `menu.lua` instead of its own. +completely change the menu structure, you would first create a new *menu.lua* +and then put it in *~/.textadept/modules/textadept/*. Textadept will now load +your *menu.lua* instead of its own. [LuaDoc]: api/index.html ### Language-Specific Similar to generic modules, putting your own language-specific module in -`~/.textadept/modules/` causes Textadept to load that module for editing the -language's code instead of the default one in `modules/` (if the latter exists). +*~/.textadept/modules/* causes Textadept to load that module for editing the +language's code instead of the default one in *modules/* (if the latter exists). For example, copying the default Lua language-specific module from -`modules/lua/` to `~/.textadept/modules/` causes Textadept to use that module +*modules/lua/* to *~/.textadept/modules/* causes Textadept to use that module for editing Lua code instead of the default one. If you make custom changes to these kinds of copies of language-specific modules, you will likely want to update them with each new Textadept release. Instead of potentially wasting time merging your changes, you can run custom code independent of a module in the -module's `post_init.lua` file. For example, instead of copying the `lua` module +module's *post_init.lua* file. For example, instead of copying the `lua` module and changing its `set_buffer_properties()` function to use tabs, you can do this -from `~/.textadept/modules/lua/post_init.lua`: +from *~/.textadept/modules/lua/post_init.lua*: function _M.lua.set_buffer_properties() buffer.use_tabs = true end -Similarly, you can use `post_init.lua` to change the module's +Similarly, you can use *post_init.lua* to change the module's [compile and run][] commands, load more [Adeptsense tags][], and add additional [key bindings](#Key.Bindings) and [snippets](#Snippets) (instead of in -`~/.textadept/init.lua`). For example: +*~/.textadept/init.lua*). For example: _M.textadept.run.run_command.lua = 'lua5.2' _M.lua.sense:load_ctags('/path/to/my/projects/tags') @@ -97,7 +97,7 @@ Similarly, you can use `post_init.lua` to change the module's ### Loading Modules Suppose you created or downloaded a generic module called `foo` that you wanted -to load along with the default modules Your `~/.textadept/init.lua` would +to load along with the default modules Your *~/.textadept/init.lua* would contain the following: _M.textadept = require 'textadept' @@ -109,7 +109,7 @@ installing the module. ### Key Bindings -For simple changes to key bindings, `~/.textadept/init.lua` is a good place to +For simple changes to key bindings, *~/.textadept/init.lua* is a good place to put them. For example, maybe you want `Ctrl+Shift+C` to create a new buffer instead of `Ctrl+N`: @@ -117,7 +117,7 @@ instead of `Ctrl+N`: keys.cn = nil If you plan on redefining most key bindings, you would probably want to copy or -create a new `keys.lua` and then put it in `~/.textadept/modules/textadept/`. +create a new *keys.lua* and then put it in *~/.textadept/modules/textadept/*. You can learn more about key bindings and how to define them in the [key bindings LuaDoc][]. @@ -125,7 +125,7 @@ You can learn more about key bindings and how to define them in the ### Snippets -You can add global snippets in `~/.textadept/init.lua`, such as: +You can add global snippets in *~/.textadept/init.lua*, such as: snippets['file'] = '%<buffer.filename>' snippets['path'] = "%<(buffer.filename or ''):match('^.+[/\\]')>" @@ -138,12 +138,12 @@ language. You can learn about snippet syntax in the [snippets LuaDoc][]. ## Locale -Textadept attempts to auto-detect your locale settings using the `LANG` +Textadept attempts to auto-detect your locale settings using the "$LANG" environment variable. If it is unsuccessful, the English locale is used by default. To set the locale manually, copy the desired locale file from the -`core/locales/` folder to `~/.textadept/locale.conf`. If your language is not +*core/locales/* folder to *~/.textadept/locale.conf*. If your language is not yet supported by Textadept, please translate the English messages in -`core/locale.conf` to your language and send the modified `locale.conf` file to +*core/locale.conf* to your language and send the modified *locale.conf* file to [me][]. I will include it in a future release. [me]: README.html#Contact @@ -154,16 +154,16 @@ Textadept recognizes a wide range of programming language files by any of the following: * File extension. -* Keywords in the file's shebang (`#!/path/to/exe`) line. +* Keywords in the file's shebang ("#!/path/to/exe") line. * A pattern that matches the text of the file's first line. -Built-in file types are located in `modules/textadept/mime_types.conf`. You -can override or add to them in your `~/.textadept/mime_types.conf`: +Built-in file types are located in *modules/textadept/mime_types.conf*. You +can override or add to them in your *~/.textadept/mime_types.conf*: % Recognize .luadoc files as Lua code. luadoc lua - % Change .html files to be recognized as XML files instead of HTML ones. + % Change .html files to be recognized as XML files. html xml ### Detect by Extension @@ -172,17 +172,17 @@ The syntax for mapping a file extension to a lexer is: file_ext lexer -Note: `file_ext` should not start with a `.` (period). +Note: `file_ext` should not start with a '.' (period). ### Detect by Shebang The syntax for mapping a word contained in a shebang line (the first line of a -file whose first two characters are `#!`) to a lexer is: +file whose first two characters are "#!") to a lexer is: #shebang_word lexer -Examples of `shebang_word`s are `lua`, `ruby`, `python` which match lines like -`#!/usr/bin/lua`, `#!/usr/env/ruby`, and `#!/usr/bin/python3`, respectively. +Examples of `shebang_word`s are "lua", "ruby", "python" which match lines like +"#!/usr/bin/lua", "#!/usr/env/ruby", and "#!/usr/bin/python3", respectively. ### Detect by Pattern diff --git a/doc/09_Themes.md b/doc/09_Themes.md index 89a77389..5d702db3 100644 --- a/doc/09_Themes.md +++ b/doc/09_Themes.md @@ -1,8 +1,8 @@ # Themes Textadept's look and feel is customized with themes. The themes that come with -Textadept are `light`, `dark`, and `term`. By default the `light` theme is used -for the GUI version and `term` for the terminal version. +Textadept are "light", "dark", and "term". By default the "light" theme is used +for the GUI version and "term" for the terminal version. <span style="display: block; clear: right;"></span> @@ -14,16 +14,16 @@ for the GUI version and `term` for the terminal version. ## Structure -Each theme is a single folder composed of three files: `lexer.lua`, -`buffer.lua`, and `view.lua`. It is recommended to put custom or downloaded -themes in your `~/.textadept/themes/` directory so they will not be overwritten +Each theme is a single folder composed of three files: *lexer.lua*, +*buffer.lua*, and *view.lua*. It is recommended to put custom or downloaded +themes in your *~/.textadept/themes/* directory so they will not be overwritten when you update Textadept. Also, themes in that directory override any themes in -Textadept's `themes/` directory. This means that if you have your own `light` +Textadept's *themes/* directory. This means that if you have your own *light* theme, it will be loaded instead of the one that comes with Textadept. ### Lexer -`lexer.lua` contains definitions for how to "style" syntactic elements like +*lexer.lua* contains definitions for how to "style" syntactic elements like comments, strings, and keywords in programming languages. [Styles][] are composed of fonts and colors and apply universally to all programming language elements, resulting in a single, unified theme. @@ -38,7 +38,7 @@ However, you can still customize which colors are used for particular styles. ### Buffer -`buffer.lua` contains [buffer-specific properties][] like the indentation +*buffer.lua* contains [buffer-specific properties][] like the indentation character and indentation size. For example, to use tabs instead of spaces and have a tab size of 4 spaces by default: @@ -54,7 +54,7 @@ You can use [Adeptsense][] to view a property's documentation or read the ### View -`view.lua` contains view-specific properties which apply to all buffers. These +*view.lua* contains view-specific properties which apply to all buffers. These properties are numerous and control many aspects of how buffers are displayed, from caret and selection colors to margin configurations to marker definitions. View properties also control editor behaviors like scrolling and autocompletion. @@ -69,15 +69,15 @@ documentation or read the [LuaDoc][]. You can switch between or reload themes using `Ctrl+Shift+T` (`⌘⇧T` on Mac OSX | none in ncurses). However, be aware that the views do not reset themselves. Any -properties set explicitly in the previous theme's `view.lua` file that are not +properties set explicitly in the previous theme's *view.lua* file that are not set explicitly in the new theme will carry over. Restarting Textadept will fix this. Also, be aware that themes apply to all buffers. You cannot assign a theme to a particular file or file type. (You can change things like tab and indent settings per filetype, however, by creating a [language-specific module][].) -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 +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. [language-specific module]: 07_Modules.html#Buffer.Properties @@ -85,9 +85,9 @@ printed to standard error. ## 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`. For example, styling all text fields with a -`"textadept-entry-style"` would be done like this: +Textadept. Instead, use [GTK+ Resource files][]. The "GtkWindow" name is +"textadept". For example, styling all text fields with a "textadept-entry-style" +would be done like this: widget "textadept*GtkEntry*" style "textadept-entry-style" @@ -95,7 +95,7 @@ Textadept. Instead, use [GTK+ Resource files][]. The `GtkWindow` name is ## Getting Themes -For now, user-created themes are obtained from the [wiki][]. The classic `dark`, -`light`, and `scite` themes prior to version 4.3 have been moved there. +For now, user-created themes are obtained from the [wiki][]. The classic "dark", +"light", and "scite" themes prior to version 4.3 have been moved there. [wiki]: http://foicica.com/wiki/textadept diff --git a/doc/10_Advanced.md b/doc/10_Advanced.md index 04f05afe..a54f7145 100644 --- a/doc/10_Advanced.md +++ b/doc/10_Advanced.md @@ -32,7 +32,7 @@ completions. Use the arrow keys to make a selection and press `Enter` (`↩` | ### Extending You can extend the command entry to do more than enter Lua commands. An -example of this is [incremental search][]. See `modules/textadept/find.lua` for +example of this is [incremental search][]. See *modules/textadept/find.lua* for the implementation. [incremental search]: api/gui.find.html#find_incremental 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. diff --git a/doc/12_Compiling.md b/doc/12_Compiling.md index 078b1345..03cad669 100644 --- a/doc/12_Compiling.md +++ b/doc/12_Compiling.md @@ -7,23 +7,23 @@ as running it. ### Linux and BSD -First, Linux and BSD systems will need the [GNU C compiler][] (`gcc`) and -[GNU Make][] (`make`). Both should be available for your distribution through a +First, Linux and BSD systems will need the [GNU C compiler][] (*gcc*) and +[GNU Make][] (*make*). Both should be available for your distribution through a package manager. For example, Ubuntu includes these tools in the -`build-essential` package. +"build-essential" package. Next, the GTK+ development libraries are necessary for compiling the GUI version of Textadept. Your package manager should allow you to install them. For Debian-based Linux distributions like Ubuntu, the package is typically called -`libgtk2.0-dev`. Otherwise, compile and install GTK+ from the [GTK+ website][]. +"libgtk2.0-dev". Otherwise, compile and install GTK+ from the [GTK+ website][]. If you would like to compile the terminal version of Textadept, you will need the ncurses development library. Similarly, it should be available from your package manager. For Debian-based Linux distributions like Ubuntu, the package -is typically called `libncurses5-dev`. Otherwise, compile and install ncurses -from the [ncurses website][]. Note: you need to have a development version of -ncurses compiled with "wide" (multibyte) character support installed. -(Therefore, Debian users will _also_ need `libncursesw5-dev`.) +is typically called "libncurses5-dev". Otherwise, compile and install ncurses +from the [ncurses website][]. Note: you need to have the wide-character +development version of ncurses installed, which handles multibyte sequences. +(Therefore, Debian users will _also_ need "libncursesw5-dev".) In addition, BSD users will need to have [libiconv][] installed. @@ -59,23 +59,23 @@ and the [Apple Cross-compiler][] binaries. ## Compiling -Make sure you downloaded the `textadept_x.x.src.zip`, regardless of what +Make sure you downloaded the *textadept_x.x.src.zip*, regardless of what platform you are on, and not a platform-specific binary package. ### Linux and BSD -For Linux and BSD systems, simply run `make` in the `src/` directory. The -`textadept` and `textadeptjit` executables are created in the root directory. -Make a symlink from them to `/usr/bin/` or elsewhere in your `PATH`. +For Linux and BSD systems, simply run `make` in the *src/* directory. The +*textadept* and *textadeptjit* executables are created in the root directory. +Make a symlink from them to */usr/bin/* or elsewhere in your `PATH`. -Similarly, `make ncurses` builds `textadept-ncurses` and `textadeptjit-ncurses`. +Similarly, `make ncurses` builds *textadept-ncurses* and *textadeptjit-ncurses*. Note: you may have to run make CFLAGS="-I/usr/local/include" \ CXXFLAGS="-I/usr/local/include -L/usr/local/lib" -if the prefix where any dependencies are installed is `/usr/local` and your +if the prefix where any dependencies are installed is */usr/local/* and your compiler flags do not include them by default. #### Installing @@ -84,49 +84,49 @@ Textadept is self-contained, meaning it does not need to be installed and can be run from wherever it is located. However, if you want to install Textadept like a normal Linux application, run the usual `make` and then `make install` or `sudo make install` depending on your privilages. The default prefix is -`/usr/local` but you can change this by setting `DESTDIR` (e.g. +*/usr/local* but you can change this by setting `DESTDIR` (e.g. `make install DESTDIR=/prefix/to/install/to`). ### 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 +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 +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. +*../textadept.exe* and *../textadeptjit.exe*. Finally, copy the dll files from +*src/win32gtk/bin* to the directory containing the Textadept executables. -Please note that a `lua51.dll` is produced for _only_ the `textadeptjit.exe` +Please note that a *lua51.dll* is produced for _only_ the *textadeptjit.exe* because limitations on external Lua library loading do not allow statically 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` -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 +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 own versions. -Similarly, `make osx-ncurses` builds `../textadept-ncurses.osx` and -`../textadeptjit-ncurses.osx`. +Similarly, `make osx-ncurses` builds *../textadept-ncurses.osx* and +*../textadeptjit-ncurses.osx*. #### Compiling on OSX (Legacy) [XCode][] is needed for Mac OSX as well as [jhbuild][] (for GTK+). After -building `meta-gtk-osx-bootstrap` and `meta-gtk-osx-core`, you need to build -`meta-gtk-osx-themes`. Note that the entire compiling process can easily take 30 +building "meta-gtk-osx-bootstrap" and "meta-gtk-osx-core", you need to 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 open `src/Makefile` and uncomment the `Darwin` -block. Finally, run `make osx` to build `../textadept.osx` and -`../textadeptjit.osx`. +After using *jhbuild*, GTK+ is in *~/gtk/* so make a symlink from *~/gtk/inst* +to *src/gtkosx* in Textadept. Then open *src/Makefile* and uncomment the +"Darwin" block. Finally, run `make osx` to build *../textadept.osx* and +*../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 @@ -134,8 +134,8 @@ Note: to build a GTK+ for OSX bundle, the following needs to be run from the 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`. +"Darwin" block mentioned above, simply run `make osx-ncurses` to build +*../textadept-ncurses.osx* and *../textadeptjit-ncurses.osx*. [XCode]: http://developer.apple.com/TOOLS/xcode/ [jhbuild]: http://sourceforge.net/apps/trac/gtk-osx/wiki/Build @@ -160,16 +160,16 @@ non-Lua, libraries. includes a slightly modified, stripped down version of this library. The changes made to CDK are as follows: -* The following source files were removed: `alphalist.c`, `calendar.c`, - `cdk_compat.{c,h}`, `cdk_test.h`, `dialog.c`, `{d,f}scale.{c,h}`, - `fslider.{c,h}`, `gen-{scale,slider}.{c,h}`, `get_index.c`, `get_string.c`, - `graph.c`, `histogram.c`, `marquee.c`, `matrix.c`, `popup_dialog.c`, - `radio.c`, `scale.{c,h}`, `selection.c`, `slider.{c,h}`, `swindow.c`, - `template.c`, `u{scale,slider}.{c,h}`, `view_{file,info}.c`, and `viewer.c`. -* `cdk.h` does not `#include` "matrix.h", "viewer.h", and any headers labeled +* The following source files were removed: *alphalist.c*, *calendar.c*, + *cdk_compat.{c,h}*, *cdk_test.h*, *dialog.c*, *{d,f}scale.{c,h}*, + *fslider.{c,h}*, *gen-{scale,slider}.{c,h}*, *get_index.c*, *get_string.c*, + *graph.c*, *histogram.c*, *marquee.c*, *matrix.c*, *popup_dialog.c*, + *radio.c*, *scale.{c,h}*, *selection.c*, *slider.{c,h}*, *swindow.c*, + *template.c*, *u{scale,slider}.{c,h}*, *view_{file,info}.c*, and *viewer.c*. +* *cdk.h* does not `#include` "matrix.h", "viewer.h", and any headers labeled "Generated headers" due to their machine-dependence. -* `cdk_config.h` no longer defines `HAVE_SETLOCALE` since Textadept handles +* *cdk_config.h* no longer defines `HAVE_SETLOCALE` since Textadept handles locale settings. -* The `deleteFileCB` routine in `fselect.c` has been deactivated. +* The `deleteFileCB` routine in *fselect.c* has been deactivated. [CDK]: http://invisible-island.net/cdk/ diff --git a/doc/13_Help.md b/doc/13_Help.md index 076f173d..6cbcdb52 100644 --- a/doc/13_Help.md +++ b/doc/13_Help.md @@ -21,7 +21,7 @@ The help switch is unavailable in ncurses. ## Online Help Textadept has a [mailing list][] and a [wiki][]. You can also join us on IRC via -[freenode.net][] in `#textadept`. +[freenode.net][] in "#textadept". [mailing list]: http://foicica.com/lists [wiki]: http://foicica.com/wiki/textadept diff --git a/doc/14_Appendix.md b/doc/14_Appendix.md index 0beda0f6..4ce299e1 100644 --- a/doc/14_Appendix.md +++ b/doc/14_Appendix.md @@ -129,16 +129,16 @@ features in its editing component Scintilla: not supported and `surface->LineTo()` is not supported for drawing marker shapes). * Mouse interactions, cursor types, and hotspots are not supported. -* Only 8 colors are supported: black (`0x000000`), red (`0xFF0000`), green - (`0x00FF00`), yellow (`0xFFFF00`), blue (`0x0000FF`), magenta (`0xFF00FF`), - cyan (`0x00FFFF`), and white (`0xFFFFFF`). Even if your terminal uses a - different color map, you must use these color values with Scintilla; - unrecognized colors are set to white by default. Lexers can use up to 8 more - colors by setting the lexer style's `bold` attribute. +* Only 8 colors are supported: black (0x000000), red (0xFF0000), green + (0x00FF00), yellow (0xFFFF00), blue (0x0000FF), magenta (0xFF00FF), cyan + (0x00FFFF), and white (0xFFFFFF). Even if your terminal uses a different color + map, you must use these color values with Scintilla; unrecognized colors are + set to white by default. Lexers can use up to 8 more colors by setting the + lexer style's "bold" attribute. * Scroll bars are not supported. * Some styles settings like font name, font size, and italic do not display properly (terminals use one only font, size and variant). -* Viewing whitespace does not show the 'Tab' character arrows +* Viewing whitespace does not show the "Tab" character arrows (`surface->LineTo()` is not supported for drawing arrows). * Visual wrap flags are not supported (`surface->LineTo()` is not supported). * X selections (primary and secondary) are not integrated into the clipboard. @@ -451,7 +451,7 @@ to ##### `os.execute` -`os.execute()`s function parameters have changed. If you are only interested in +`os.execute()`'s function parameters have changed. If you are only interested in the return code, change local code = os.execute(cmd) @@ -536,7 +536,7 @@ keychains. Therefore, Textadept's key bindings have changed radically, as has the menu structure and menu mnemonics. In order for key bindings to appear in menus, `_m.textadept.menu` needs to know which commands are assigned to which keys. Therefore, the menu module needs to be `require`d *after* -`_m.textadept.keys`. If your `~/.textadept/init.lua` is calling +`_m.textadept.keys`. If your *~/.textadept/init.lua* is calling `require 'textadept'`, you do not have to make any changes. If you are loading individual modules from `_m.textadept`, ensure `_m.textadept.menu` is loaded after `_m.textadept.keys`. @@ -566,12 +566,12 @@ Replace all instances of `_m.textadept.editing.SAVE_STRIPS_WS` with ##### Core Extensions -There are no more core extention modules (previously in `core/ext/`). They have -been relocated to `modules/textadept/` so putting +There are no more core extention modules (previously in *core/ext/*). They have +been relocated to *modules/textadept/* so putting require 'textadept' -in your `~/.textadept/init.lua` will load all the modules you would expect. +in your *~/.textadept/init.lua* will load all the modules you would expect. Please see the [preferences][] page for instructions on how to load specific modules. @@ -579,10 +579,10 @@ modules. ##### Autoloading -Key bindings in `~/.textadept/key_commands.lua` and snippets in -`~/.textadept/snippets.lua` are no longer auto-loaded. Instead, modify -[`keys`][] and/or [`snippets`][] from within your `~/.textadept/init.lua` or a -file loaded by `~/.textadept/init.lua`. +Key bindings in *~/.textadept/key_commands.lua* and snippets in +*~/.textadept/snippets.lua* are no longer auto-loaded. Instead, modify +[`keys`][] and/or [`snippets`][] from within your *~/.textadept/init.lua* or a +file loaded by *~/.textadept/init.lua*. [`keys`]: api/keys.html [`snippets`]: api/_M.textadept.snippets.html @@ -652,6 +652,6 @@ Here is a summary of API changes: [`gui.switch_buffer()`]: api/gui.html#switch_buffer [`new_buffer()`]: api/_G.html#new_buffer [`quit()`]: api/_G.html#quit -[`reset()`]:api/_G.html#reset +[`reset()`]: api/_G.html#reset [`user_dofile()`]: api/_G.html#user_dofile [`string.iconv()`]: api/string.html#iconv diff --git a/doc/markdowndoc.lua b/doc/markdowndoc.lua index 603b4f07..1ae9f929 100644 --- a/doc/markdowndoc.lua +++ b/doc/markdowndoc.lua @@ -264,6 +264,7 @@ function M.start(doc) template.toc = template.toc:gsub('(<a.-)%b()(</a>)', '%1%2') -- strip params :gsub('<code>([^<]+)</code>', '%1') -- sans serif :gsub('_G.(events.[%w_]+)', '<small>%1</small>') + :gsub('rectangular_[%w_]+', '<small>%0</small>') :gsub('SC_[%u]+', '<small>%0</small>') f = io_open(M.options.output_dir..'/api/'..name..'.html', 'wb') local html = HTML:gsub('%%%(([^)]+)%)', template) |