aboutsummaryrefslogtreecommitdiffhomepage
path: root/doc
diff options
context:
space:
mode:
authorGravatar mitchell <70453897+667e-11@users.noreply.github.com>2013-09-23 23:25:15 -0400
committerGravatar mitchell <70453897+667e-11@users.noreply.github.com>2013-09-23 23:25:15 -0400
commit3f566741f708030014a56ad0c69e874db7ec4240 (patch)
treea1e686d8ce3d75db73c322e29fc4c1659ad72b50 /doc
parent32edfc6757c760100487e6b1dae562464ad73992 (diff)
Code and documentation cleanup.
Diffstat (limited to 'doc')
-rw-r--r--doc/04_WorkingWithFiles.md31
-rw-r--r--doc/06_AdeptEditing.md39
2 files changed, 35 insertions, 35 deletions
diff --git a/doc/04_WorkingWithFiles.md b/doc/04_WorkingWithFiles.md
index c8fc43c5..4a941a40 100644
--- a/doc/04_WorkingWithFiles.md
+++ b/doc/04_WorkingWithFiles.md
@@ -29,16 +29,16 @@ Textadept shows the name of the active buffer in its titlebar. Pressing
Individual files have three configurable settings: indentation, line endings,
and encoding. Indentation consists of an indentation character and an
-indentation size. Line endings are characters that separate lines. File
-encoding determines how text characters are displayed. Textadept shows these
+indentation size. Line endings are the characters that separate lines. File
+encoding specifies how to display text characters. Textadept shows these
settings in the buffer status statusbar.
![Document Statusbar](images/docstatusbar.png)
#### Indentation
-Usually, [language modules][] or [user settings][] dictate the buffer's
-indentation setting. By default, indentation is 2 spaces. Pressing
+Normally, a [language module][] or the [user settings][] dictate a buffer's
+indentation settings. By default, indentation is 2 spaces. Pressing
`Ctrl+Alt+Shift+T` (`^⇧T` on Mac OSX | `M-T` or `M-S-T` in curses) manually
toggles between using tabs and spaces, although this only affects future
indentation. Existing indentation remains unchanged. `Ctrl+Alt+I` (`^I` | `M-I`)
@@ -46,25 +46,24 @@ performs the conversion. (If the buffer uses tabs, all indenting spaces convert
to tabs. If the buffer uses spaces, all indenting tabs convert to spaces.)
Similarly, the "Buffer -> Indentation" menu manually sets indentation size.
-[language modules]: 07_Modules.html#Buffer.Properties
+[language module]: 07_Modules.html#Buffer.Properties
[user settings]: 08_Preferences.html#Buffer.Properties
#### Line Endings
-The current platform determines which line endings, commonly known as
-end-of-line (EOL) markers, to use by default. On Windows it is CRLF ("\r\n"). On
-all other platforms it is LF ('\n'). Textadept first tries to auto-detect the
-EOL mode of opened files before falling back on the platform default. The
-"Buffer -> EOL Mode" menu manually changes line endings and, unlike indentation
-settings, automatically converts all existing EOLs.
+Textadept determines which default line endings, commonly known as end-of-line
+(EOL) markers, to use based on the current platform. On Windows it is CRLF
+("\r\n"). On all other platforms it is LF ('\n'). Textadept first tries to
+auto-detect the EOL mode of opened files before falling back on the platform
+default. The "Buffer -> EOL Mode" menu manually changes line endings and, unlike
+indentation settings, automatically converts all existing EOLs.
#### Encodings
-Textadept represents all characters and strings internally as UTF-8. UTF-8 is
-compatible with ASCII so those files are always detected properly. Textadept
-also recognizes ISO-8859-1 and MacRoman, two common encodings used on Windows
-and Mac OSX respectively. If you work with files whose encodings Textadept does
-not recognize, add the encodings to [`io.encodings`][] in your [preferences][].
+Textadept has the ability to decode files encoded in many different encodings,
+but by default it only attempts to decode UTF-8, ASCII, ISO-8859-1, and
+MacRoman. If you work with files with encodings Textadept does not recognize,
+add those encodings to [`io.encodings`][] in your [preferences][].
UTF-8 is the recommended file encoding because of its wide support by other text
editors and operating systems. The "Buffer -> Encoding" menu changes the file
diff --git a/doc/06_AdeptEditing.md b/doc/06_AdeptEditing.md
index 2176c39a..38f824a9 100644
--- a/doc/06_AdeptEditing.md
+++ b/doc/06_AdeptEditing.md
@@ -10,12 +10,12 @@ manual discusses more elaborate editing features below.
### Autopaired Characters
-Usually, quote ('&apos;', '&quot;') and brace ('(', '[', '{') characters go
-together in pairs. By default, Textadept automatically inserts complement
-characters and allows you to type over them. Similarly, the editor deletes the
-complement when you press `Bksp` (`⌫` on Mac OSX | `Bksp` in curses) over the
-first. The [preferences][] page details how to disable these features if you
-find them unsuitable.
+Usually, brace ('(', '[', '{') and quote ('&apos;', '&quot;') characters go
+together in pairs. Textadept automatically inserts the complement character of
+any user-typed opening brace or quote character and allows the user to
+subsequently type over it. Similarly, the editor deletes the complement when
+you press `Bksp` (`⌫` on Mac OSX | `Bksp` in curses) over the first. The
+[preferences][] page details how to configure or disable these features.
[preferences]: 08_Preferences.html#Generic
@@ -32,8 +32,8 @@ word.
### Virtual Space Mode
Pressing `Ctrl+Alt+Shift+V` (`^⇧V` in Mac OSX | none in curses) enables and
-disables Virtual space (freehand) mode. When enabled, line endings do not
-restrict caret movement.
+disables Virtual space (freehand) mode. When virtual space is enabled, the caret
+may move into the space past the ends of lines.
### Overwrite Mode
@@ -44,7 +44,7 @@ characters. The caret also changes to an underline in overwrite mode.
## Selections
Textadept includes many ways of creating and working with selections. Creating
-basic selections entails holding down the "Shift" modifier key while pressing
+basic selections entails holding down the "Shift" modifier key and then pressing
the arrow keys, clicking and dragging the mouse cursor over a range of text, or
pressing `Ctrl+A` (`⌘A` | `M-A`) to select all text. Creating more advanced
selections like multiple and rectangular selections requires slightly more
@@ -52,20 +52,21 @@ effort, but has powerful uses.
### Multiple Selection
-Clicking the mouse at a point in the buffer while holding the "Control" modifier
-key places an additional caret at that point. Clicking and dragging while
-holding the same modifier creates multiple selections. Textadept will now mirror
-typed text at each selection.
+Holding down the "Control" modifier key and then clicking and dragging the mouse
+cursor over ranges of text creates multiple selections. Holding "Control" and
+then clicking without dragging places an additional caret at the clicked
+position. Textadept mirrors any typed text at each selection.
Textadept curses does not support creating multiple selections with the mouse.
### Rectangular Selection
-Holding `Alt+Shift` (`⌥⇧` on Mac OSX | `M-S-` in curses) and pressing the arrow
-keys creates a rectangular selection. A rectangular selection spanning multiple
-lines allows typing on each line. Holding the `Alt` modifier key (`Super` on
-Linux) while clicking and dragging the mouse also creates a rectangular
-selection.
+Rectangular selections are a more structured form of multiple selections. A
+rectangular selection spanning multiple lines allows typing on each line.
+Holding `Alt+Shift` (`⌥⇧` on Mac OSX | `M-S-` in curses) and then pressing the
+arrow keys creates a rectangular selection. Holding the `Alt` modifier key
+(`Super` on Linux) and then clicking and dragging the mouse cursor also creates
+a rectangular selection.
![Rectangular Selection](images/rectangularselection.png)
&nbsp;&nbsp;&nbsp;&nbsp;
@@ -229,7 +230,7 @@ highlight syntax incorrectly. Pressing `F5` triggers a full redraw.
### Code Folding
Some lexers support "code folding", the act of temporarily hiding blocks of code
-in order to make viewing easier. Arrows in the margin to the left of the code
+in order to make viewing easier. Markers in the margin to the left of the code
denote fold points. Clicking on one toggles the folding for that block of code.
Pressing `Ctrl+*` (`⌘*` on Mac OSX | `M-*` in curses) also toggles the fold
point on the current line.