aboutsummaryrefslogtreecommitdiff
path: root/doc/03_UserInterface.md
diff options
context:
space:
mode:
authormitchell <70453897+667e-11@users.noreply.github.com>2012-09-12 11:24:11 -0400
committermitchell <70453897+667e-11@users.noreply.github.com>2012-09-12 11:24:11 -0400
commit9dc8ce16a1efc6482db6f1d5456d42958e79a06c (patch)
treee26ff636143fc74f92a6a3359a73e93194da6bc3 /doc/03_UserInterface.md
parent4305f32ac153b7a45a1c001da2fcd412af905168 (diff)
downloadtextadept-9dc8ce16a1efc6482db6f1d5456d42958e79a06c.tar.gz
textadept-9dc8ce16a1efc6482db6f1d5456d42958e79a06c.zip
Documentation overhaul.
Rewrote most of the manual and Lua API to complement each other. Key bindings reference moved from Appendix to modules/textadept/keys.lua LuaDoc.
Diffstat (limited to 'doc/03_UserInterface.md')
-rw-r--r--doc/03_UserInterface.md53
1 files changed, 30 insertions, 23 deletions
diff --git a/doc/03_UserInterface.md b/doc/03_UserInterface.md
index 540ba2cc..948038cb 100644
--- a/doc/03_UserInterface.md
+++ b/doc/03_UserInterface.md
@@ -2,40 +2,47 @@
![UI](images/ui.png)
-Textadept's user interface was designed to be simple. It consists of a menubar
-(GUI version), editor view, initially hidden find/replace dialog, initially
-hidden command entry, and statusbar. Below are brief descriptions of these
-features. More in-depth discussion about some of them is provided later in the
-manual.
+Textadept's user interface was designed to be simple. It consists of a menu (GUI
+version only), editor view, and statusbar. There is also a find & replace pane
+and a command entry, both of which are initially hidden. Below are brief
+descriptions of these features. More in-depth discussion about some of them is
+provided later in the manual.
-## Menubar
+## Menu
-The completely customizable (and optional!) menubar provides access to all of
-Textadept's features. It is only available in the GUI version of Textadept.
-In the terminal, you can use the
-[command selection](10_Advanced.html#Command.Selection) dialog instead.
+The completely customizable menu provides access to all of Textadept's features.
+It is only available in the GUI version of Textadept. In the terminal, you can
+use the [command selection][] dialog instead. Textadept is very keyboard-driven
+so most menu items have an assigned key shortcut. Key bindings are changeable
+in your [key preferences][] and will reflect in the menu. Here is a
+[complete list][] of default key bindings.
+
+[command selection]: 10_Advanced.html#Command.Selection
+[key preferences]: 08_Preferences.html#Key.Bindings
+[complete list]: api/_M.textadept.keys.html#Key.Bindings
## Editor View
-The editor view is where you will spend most of your time in Textadept. It
-supports unlimited split views (GUI version) and is completely controllable by
-Lua.
+The editor view is where you will spend most of your time in Textadept. In the
+GUI version, you can split this view into as many other views as you would like.
+Each view is completely controllable by Lua.
-## Find and Replace Dialog
+## Find & Replace Pane
-This compact dialog is a great way to slice and dice through your document or
+This compact pane is a great way to slice and dice through your document or a
directory of files. You can even find and replace text using Lua patterns. It is
-available when you need it and quickly gets out of your way when you do not,
-minimizing distractions.
+available only when you need it and quickly gets out of your way when you do
+not, minimizing distractions.
## Command Entry
-The versatile command entry functions as both a place to execute Lua commands
-with the internal Lua state and find text incrementally. You can extend it to do
-even more if you would like. Like the find/replace dialog, the command entry
-pops in and out as you wish.
+The versatile command entry functions as, among other things, a place to execute
+Lua commands with Textadept's internal Lua state, find text incrementally, and
+execute shell commands. You can extend it to do even more. Like the Find &
+Replace pane, the command entry pops in and out as you wish.
## Statusbar
-The left side of the statusbar displays any status messages. The right side
-shows the current buffer's status.
+The statusbar is actually composed to two statusbars. The one on the left-hand
+side displays temporary status messages. The one on the right-hand side
+persistently shows the current buffer status.