aboutsummaryrefslogtreecommitdiff
path: root/doc/manual/6_AdeptEditing.md
diff options
context:
space:
mode:
authormitchell <70453897+667e-11@users.noreply.github.com>2012-03-07 09:28:43 -0500
committermitchell <70453897+667e-11@users.noreply.github.com>2012-03-07 09:28:43 -0500
commit96c85498c019e381d0aeed2e33e626563563ea8c (patch)
treea44a3ff017cc7c5de3e4845434324c7798689d24 /doc/manual/6_AdeptEditing.md
parent6c5bda943d87c629e3fbeaa9178d5fdcb96134c5 (diff)
downloadtextadept-96c85498c019e381d0aeed2e33e626563563ea8c.tar.gz
textadept-96c85498c019e381d0aeed2e33e626563563ea8c.zip
Documentation overhaul with Discount (Markdown implementation).
The standard LuaDoc template is no longer used. Instead, the new `scripts/markdowndoc.lua` has the template for LuaDoc and `scripts/update_doc` has the template for the Manual. Also added README, CHANGELOG, and THANKS files.
Diffstat (limited to 'doc/manual/6_AdeptEditing.md')
-rw-r--r--doc/manual/6_AdeptEditing.md79
1 files changed, 46 insertions, 33 deletions
diff --git a/doc/manual/6_AdeptEditing.md b/doc/manual/6_AdeptEditing.md
index 61faf93e..9dee1183 100644
--- a/doc/manual/6_AdeptEditing.md
+++ b/doc/manual/6_AdeptEditing.md
@@ -3,17 +3,21 @@
## Key Commands
Textadept is entirely keyboard-driven. See the comprehensive list of key
-commands in the [appendix](14_Appendix.html#key_bindings). Key commands can be
-modified in your [preferences](9_Preferences.html#key_commands).
+commands in the [appendix][]. Key commands can be modified in your
+[key preferences][].
+
+[appendix]: 14_Appendix.html#Key.Bindings
+[key preferences]: 9_Preferences.html#Key.Commands
## Character Autopairing
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
-`Backspace` (`⌫`) over the first. See the
-[preferences](9_Preferences.html#module_settings) page if you would like to
-disable this.
+`Backspace` (`⌫`) over the first. See the [preferences][] page if you would like
+to disable this.
+
+[preferences]: 9_Preferences.html#Module.Settings
## Word Completion
@@ -28,10 +32,9 @@ suggestion. Press `Return` (`↩`) to complete the selected word.
Textadept has the capability to autocomplete symbols for programming languages
and display API documentation. Lua is of course supported extremely well and
-other languages have basic support with the help of
-[ctags](http://ctags.sf.net). Symbol completion is available by pressing
-`Ctrl+Space` (`⌥⎋` on Mac OSX). Documentation for symbols is available with
-`Ctrl+H` (`^H`).
+other languages have basic support with the help of [ctags][]. Symbol completion
+is available by pressing `Ctrl+Space` (`⌥⎋` on Mac OSX). Documentation for
+symbols is available with `Ctrl+H` (`^H`).
![Adeptsense Lua](images/adeptsense_lua.png)
&nbsp;&nbsp;&nbsp;&nbsp;
@@ -40,16 +43,19 @@ other languages have basic support with the help of
![Adeptsense Doc](images/adeptsense_doc.png)
For more information on adding adeptsense support for another language, see
-the [LuaDoc](../modules/_M.textadept.adeptsense.html).
+the [LuaDoc][].
+
+[ctags]: http://ctags.sf.net
+[LuaDoc]: ../api/_M.textadept.adeptsense.html
## Find and Replace
`Ctrl+F` (`⌘F` on Mac OSX) brings up the Find/Replace dialog. In addition to
offering the usual find and replace, Textadept allows you to find with [Lua
-patterns](14_Appendix.html#lua_patterns) and replace with Lua captures and even
-Lua code! For example: replacing all `(%w+)` with `%(string.upper('%1'))`
-capitalizes 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.
+patterns][] and replace with Lua captures and even Lua code! For example:
+replacing all `(%w+)` with `%(string.upper('%1'))` capitalizes 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 commands
for find next, find previous, replace, and replace all (`⌘G`, `⌘⇧G`, `^R`, `^⇧R`
@@ -57,7 +63,9 @@ respectively on Mac OSX) only work when the Find/Replace dialog is hidden. When
it is visible, use the button mnemonics: `Alt+N`, `Alt+P`, `Alt+R`, and `Alt+A`
(`⌘N`, `⌘P`, `⌘R`, `⌘A`) for English locale.
-#### Find in Files
+[Lua patterns]: 14_Appendix.html#Lua.Patterns
+
+### Find in Files
`Ctrl+Shift+F` brings up Find in Files (`⌘⇧F` on Mac OSX) and will prompt for a
directory to search. The results are displayed in a new buffer. Double-clicking
@@ -69,13 +77,13 @@ for each file a result is found in. The `Match Case`, `Whole Word`, and
![Find in Files](images/findinfiles.png)
-#### Find Incremental
+### Find Incremental
You can start an incremental search by pressing `Ctrl+Alt+F` (`^⌘F` on Mac OSX).
Incremental search searches the buffer as you type. Only the `Match Case` option
-is recognized.
+is recognized. Pressing `Esc` (`⎋`) stops it.
-#### Replace in Selection
+### Replace in Selection
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
@@ -83,31 +91,36 @@ then `Replace All`.
## Indentation
-#### Increase or Decrease Indent Level
+### Change Indent Level
The amount of indentation for a selected set of lines is increased by pressing
`Tab` (`⇥`) and decreased by pressing `Shift+Tab` (`⇧⇥`). Using these key
sequences when no selection is present does not have the same effect.
-#### Change Indent Size
+### Change Indent Size
-The indent size is usually set by a [language-specific
-module](7_Modules.html#buffer_properties) or the [theme](8_Themes.html#buffer).
-You can set it manually using the `Buffer -> Indentation` menu. Textadept shows
-what it is using for indentation in the document statusbar.
+The indent size is usually set by a [language-specific module][] or the
+[theme][]. You can set it manually using the `Buffer -> Indentation` menu.
+Textadept shows what it is using for indentation in the document statusbar.
![Document Statusbar](images/docstatusbar.png)
-#### Using Tabs Instead of Spaces
+[language-specific module]: 7_Modules.html#Buffer.Properties
+[theme]: 8_Themes.html#Buffer
+
+### Using Tabs
You can use tabs instead of the default spaces by pressing `Ctrl+Alt+Shift+T`
(`^⇧T` on Mac OSX) or using the `Buffer -> Toggle Use Tabs` menu. Textadept
shows what it is using for indentation in the document statusbar.
-The default option is usually set by a [language-specific
-module](7_Modules.html#buffer_properties) or the [theme](8_Themes.html#buffer).
+The default option is usually set by a [language-specific module][] or the
+[theme][].
+
+[language-specific module]: 7_Modules.html#Buffer.Properties
+[theme]: 8_Themes.html#Buffer
-#### Converting Between Tabs and Spaces
+### Converting Indentation
Use the `Edit -> Convert Indentation` menu to convert indentation. If the buffer
is using tabs, all spaces are converted to tabs. If the buffer is using spaces,
@@ -115,7 +128,7 @@ all tabs are converted to spaces.
## Selecting Text
-#### Rectangular Selection
+### Rectangular Selection
Holding `Alt+Shift` (`⌥⇧` on Mac OSX) and pressing the arrow keys enables
rectangular selections to be made. Start typing to type on each line.
@@ -124,7 +137,7 @@ rectangular selections to be made. Start typing to type on each line.
&nbsp;&nbsp;&nbsp;&nbsp;
![Rectangular Edit](images/rectangularselection2.png)
-#### Multiple Selection
+### Multiple Selection
Clicking the mouse at a point in the buffer while holding `Control` places an
additional caret at that point. Clicking and dragging while holding `Control`
@@ -132,7 +145,7 @@ creates multiple selections. Start typing to enter text at each selection.
This is currently unavailable on Mac OSX.
-#### Selecting Entities
+### Selecting Entities
Textadept allows you to select many different entities from the caret. For
example, `Ctrl+"` (`^"` on Mac OSX) selects all characters in a `""` sequence.
@@ -157,13 +170,13 @@ occurrences of a variable name in source code.
## Editing Modes
-#### Virtual Space
+### Virtual Space
Virtual space (freehand) mode is enabled and disabled with `Ctrl+Alt+Shift+V`
(`^⇧V` in Mac OSX). When enabled, caret movement is not restricted by line
endings.
-#### Overwrite
+### Overwrite
Overwrite mode is enabled and disabled with the `Insert` key. When enabled,
characters in the buffer will be overwritten instead of inserted as you type.