aboutsummaryrefslogtreecommitdiff
path: root/doc/manual/4_UserInterface.md
diff options
context:
space:
mode:
authormitchell <70453897+667e-11@users.noreply.github.com>2009-07-25 23:34:13 -0400
committermitchell <70453897+667e-11@users.noreply.github.com>2009-07-25 23:34:13 -0400
commit033416a15fe60fe10387119e0e63bb9ed9e8aedd (patch)
tree31bc4d91e15b484c336eadf25c0008f7bd17facc /doc/manual/4_UserInterface.md
parentb9e5e58446c95344b550c0a6ab91aa57ee9468ef (diff)
downloadtextadept-033416a15fe60fe10387119e0e63bb9ed9e8aedd.tar.gz
textadept-033416a15fe60fe10387119e0e63bb9ed9e8aedd.zip
Documentation overhaul.
Diffstat (limited to 'doc/manual/4_UserInterface.md')
-rw-r--r--doc/manual/4_UserInterface.md38
1 files changed, 38 insertions, 0 deletions
diff --git a/doc/manual/4_UserInterface.md b/doc/manual/4_UserInterface.md
new file mode 100644
index 00000000..60ed9a18
--- /dev/null
+++ b/doc/manual/4_UserInterface.md
@@ -0,0 +1,38 @@
+# User Interface
+
+Textadept's user interface was designed to be simple. It consists of an optional
+menubar, left-hand side pane, editor view, and initially hidden dialogs for
+find/replace and command entry. Below are brief descriptions of these features.
+More in-depth discussion about each of them is provided later in the manual.
+
+## Menubar
+
+The completely customizable (and optional!) menubar typically provides access to
+all of Textadept's features.
+
+## Side Pane
+
+From the beginning, the side pane has been called the Project Manager, or PM.
+This is a deceptive name though, as it can hold any hierarchical, treeview-based
+data structure, not just a list of files in a project. By default, Textadept can
+show opened buffers, a filesystem, and a list of Lua modules. (These can be seen
+in `core/ext/pm/`.) If you choose, you can resize and/or hide the PM.
+
+## Editor View
+
+The editor view is where you will spend most of your time in Textadept. It
+supports unlimited split views and is completely controllable by Lua.
+
+## Find/Replace Dialog
+
+This compact dialog is a great way to slice and dice through your document or
+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.
+
+## Command Entry
+
+The versitile 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.