From 9dc8ce16a1efc6482db6f1d5456d42958e79a06c Mon Sep 17 00:00:00 2001 From: mitchell <70453897+667e-11@users.noreply.github.com> Date: Wed, 12 Sep 2012 11:24:11 -0400 Subject: 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. --- doc/14_Appendix.md | 193 ++--------------------------------------------------- 1 file changed, 7 insertions(+), 186 deletions(-) (limited to 'doc/14_Appendix.md') diff --git a/doc/14_Appendix.md b/doc/14_Appendix.md index 67f318d7..5057445c 100644 --- a/doc/14_Appendix.md +++ b/doc/14_Appendix.md @@ -1,184 +1,5 @@ # Appendix -## Key Bindings - -Linux / Win32 | Mac OSX | Terminal | Command | ---------------|---------|----------|---------| -**File** |||| -Ctrl+N |⌘N |M-^N|New file -Ctrl+O |⌘O |^O |Open file -Ctrl+Alt+O |^⌘O |M-^O|Open recent file... -Ctrl+Shift+O|⌘⇧O |M-O |Reload file -Ctrl+S |⌘S |^S |Save file -Ctrl+Shift+S|⌘⇧S |M-^S|Save file as.. -Ctrl+W |⌘W |^W |Close file -Ctrl+Shift+W|⌘⇧W |M-^W|Close all files -None |None|None|Load session... -None |None|None|Load session... -Ctrl+Q |⌘Q |^Q |Quit -**Edit** |||| -Ctrl+Z
Alt+Backspace|⌘Z |^Z |Undo -Ctrl+Y
Ctrl+Shift+Z |⌘⇧Z |^Y |Redo -Ctrl+X
Shift+Del |⌘X
⇧⌦|^X |Cut -Ctrl+C
Ctrl+Ins |⌘C |^C |Copy -Ctrl+V
Shift+Ins |⌘V |^V |Paste -Ctrl+D |⌘D |None |Duplicate line -Del |⌦
^D |Del
^D |Delete -Alt+Del |^⌦ |M-Del
M-D|Delete word -Ctrl+A |⌘A |M-A |Select all -Ctrl+M |^M |M-M |Match brace -Ctrl+Enter |^⎋ |M-Enter |Complete word -Ctrl+Alt+Shift+H |⌘⇧H |None |Highlight word -Ctrl+/ |^/ |M-/ |Toggle block comment -Ctrl+T |^T |^T |Transpose characters -Ctrl+Shift+J |^J |M-J |Join lines -Ctrl+Shift+M |^⇧M |M-S-M |Select to matching brace -Ctrl+< |⌘< |M-< |Select between XML tags -Ctrl+> |⌘> |None |Select in XML tag -Ctrl+" |⌘" |M-" |Select in double quotes -Ctrl+' |⌘' |M-' |Select in single quotes -Ctrl+( |⌘( |M-( |Select in parentheses -Ctrl+[ |⌘[ |M-[ |Select in brackets -Ctrl+{ |⌘{ |M-{ |Select in braces -Ctrl+Shift+D |⌘⇧D |M-S-W |Select word -Ctrl+Shift+N |⌘⇧N |M-S-N |Select line -Ctrl+Shift+P |⌘⇧P |M-S-P |Select paragraph -Ctrl+Shift+I |⌘⇧I |M-S-I |Select indented block -Ctrl+Alt+U |^U |M-^U |Upper case selection -Ctrl+Alt+Shift+U |^⇧U |M-^L |Lower case selection -Alt+< |^< |M-> |Enclose as XML tags -Alt+> |^> |None |Enclose as single XML tag -Alt+" |^" |None |Enclose in double quotes -Alt+' |^' |None |Enclose in single quotes -Alt+( |^( |M-) |Enclose in parentheses -Alt+[ |^[ |M-] |Enclose in brackets -Alt+{ |^{ |M-} |Enclose in braces -Ctrl++ |⌘+ |M-+ |Grow selection bounds by 1 -Ctrl+\_ |⌘\_ |M-\_ |Shrink selection bounds by 1 -Ctrl+Shift+Up |^⇧⇡ |S-^Up |Move selected lines up -Ctrl+Shift+Down |^⇧⇣ |S-^Down |Move selected lines down -**Search** |||| -Ctrl+F |⌘F |M-F
M-S-F|Find -Ctrl+G
F3 |⌘G |M-G |Find next -Ctrl+Shift+G
Shift+F3|⌘⇧G |M-S-G |Find previous -Ctrl+Alt+R |^R |M-R |Replace -Ctrl+Alt+Shift+R |^⇧R |M-S-R |Replace all -Ctrl+Alt+F |^⌘F |M-^F |Find incremental -Ctrl+Shift+F |⌘⇧F |None |Find in files -Ctrl+Alt+G |^⌘G |None |Goto next file found -Ctrl+Alt+Shift+G |^⌘⇧G|None |Goto previous file found -Ctrl+J |⌘J |^J |Jump to line -**Tools** |||| -Ctrl+E |⌘E |M-C |Command entry -Ctrl+Shift+E |⌘⇧E |M-S-C |Select command -Ctrl+R |⌘R |^R |Run -Ctrl+Shift+R |⌘⇧R |M-^R |Compile -Ctrl+| |⌘||^\ |Filter text through -Ctrl+Space |⌥⎋ |^Space |Complete symbol -Ctrl+H |^H |M-H
M-S-H|Show documentation -Tab |⇥ |Tab |Expand snippet or next placeholder -Ctrl+K |⌥⇥ |M-K |Insert snippet... -Shift+Tab |⇧⇥ |S-Tab |Previous snippet placeholder -Ctrl+Shift+K |⌥⇧⇥ |M-S-K |Cancel snippet -Ctrl+F2 |⌘F2 |None |Toggle bookmark -Ctrl+Shift+F2 |⌘⇧F2 |None |Clear bookmarks -F2 |F2 |None |Next bookmark -Shift+F2 |⇧F2 |None |Previous bookmark -Alt+F2 |⌥F2 |None |Goto bookmark... -Ctrl+U |⌘U |^U |Snapopen `_USERHOME` -None |None |None |Snapopen `_HOME` -Ctrl+Alt+Shift+O|^⌘⇧O |M-S-O |Snapopen current directory -Ctrl+I |⌘I |None |Show style -**Buffer** |||| -Ctrl+Tab |^⇥ |M-N |Next buffer -Ctrl+Shift+Tab |^⇧⇥ |M-P |Previous buffer -Ctrl+B |⌘B |M-B
M-S-B|Switch to buffer... -None |None |None |Tab width: 2 -None |None |None |Tab width: 3 -None |None |None |Tab width: 4 -None |None |None |Tab width: 8 -Ctrl+Alt+Shift+T|^⇧T |M-T
M-S-T|Toggle use tabs -Ctrl+Alt+I |^I |M-I |Convert indentation -None |None |None |`CRLF` EOL mode -None |None |None |`CR` EOL mode -None |None |None |`LF` EOL mode -None |None |None |`UTF-8` encoding -None |None |None |`ASCII` encoding -None |None |None |`ISO-8859-1` encoding -None |None |None |`UTF-16` encoding -Ctrl+Shift+L |⌘⇧L |M-S-L |Select lexer... -F5 |F5 |^L
F5 |Refresh syntax highlighting -**View** |||| -Ctrl+Alt+N |^⌥⇥ |N/A |Next view -Ctrl+Alt+P |^⌥⇧⇥ |N/A |Previous view -Ctrl+Alt+S
Ctrl+Alt+H|^S |N/A |Split view horizontal -Ctrl+Alt+V |^V |N/A |Split view vertical -Ctrl+Alt+W |^W |N/A |Unsplit view -Ctrl+Alt+Shift+W |^⇧W |N/A |Unsplit all views -Ctrl+Alt++
Ctrl+Alt+=|^+
^=|N/A |Grow view -Ctrl+Alt+- |^- |N/A |Shrink view -None |None |None |Toggle current fold -Ctrl+Alt+Enter |^↩ |None |Toggle view EOL -Ctrl+Alt+\\ |^\\ |None |Toggle wrap mode -Ctrl+Alt+Shift+I |^⇧I |None |Toggle show indent guides -Ctrl+Alt+Shift+S |^⇧S |None |Toggle view whitespace -Ctrl+Alt+Shift+V |^⇧V |None |Toggle virtual space -Ctrl+= |⌘= |M-= |Zoom in -Ctrl+- |⌘- |M-- |Zoom out -Ctrl+0 |⌘0 |M-0 |Reset zoom -Ctrl+Shift+T |⌘⇧T |None |Select theme... -**Help** |||| -F1 |F1 |None|Open manual -Shift+F1|⇧F1 |None|Open LuaDoc -None |None|None|About -**Movement** |||| -Down |⇣
^N |^N
Down |Line down -Shift+Down |⇧⇣
^⇧N |S-Down |Line down extend selection -Ctrl+Down |^⇣ |^Down |Scroll line down -Alt+Shift+Down |⌥⇧⇣ |M-S-Down |Line down extend rect. selection -Up |⇡
^P |^P
Up |Line up -Shift+Up |⇧⇡
^⇧P |S-Up |Line up extend selection -Ctrl+Up |^⇡ |^Up |Scroll line up -Alt+Shift+Up |⌥⇧⇡ |M-S-Up |Line up extend rect. selection -Left |⇠
^B |^B
Left |Char left -Shift+Left |⇧⇠
^⇧B |S-Left |Char left extend selection -Ctrl+Left |^⇠
^⌘B |^Left |Word left -Ctrl+Shift+Left |^⇧⇠
^⌘⇧B|S-^Left |Word left extend selection -Alt+Shift+Left |⌥⇧⇠ |M-S-Left |Char left extend rect. selection -Right |⇢
^F |^F
Right|Char right -Shift+Right |⇧⇢
^⇧F |S-Right |Char right extend selection -Ctrl+Right |^⇢
^⌘F |^Right |Word right -Ctrl+Shift+Right |^⇧⇢
^⌘⇧F|S-^Right |Word right extend selection -Alt+Shift+Right |⌥⇧⇢ |M-S-Right |Char right extend rect. selection -Home |⌘⇠
^A |^A
Home |Line start -Shift+Home |⌘⇧⇠
^⇧A |M-S-A |Line start extend selection -Ctrl+Home |⌘⇡
⌘↖ |M-^A |Document start -Ctrl+Shift+Home |⌘⇧⇡
⌘⇧↖ |None |Document start extend selection -Alt+Shift+Home |⌥⇧↖ |None |Line start extend rect. selection -End |⌘⇢
^E |^E
End |Line end -Shift+End |⌘⇧⇢
^⇧E |M-S-E |Line end extend selection -Ctrl+End |⌘⇣
⌘↘ |M-^E |Document end -Ctrl+Shift+End |⌘⇧⇣
⌘⇧↘ |None |Document end extend selection -Alt+Shift+End |⌥⇧↘ |None |Line end extend rect. selection -PageUp |⇞ |PageUp |Page up -Shift+PageUp |⇧⇞ |M-S-U |Page up extend selection -Alt+Shift+PageUp |⌥⇧⇞ |None |Page up extend rect. selection -PageDown |⇟ |PageDown |Page down -Shift+PageDown |⇧⇟ |M-S-D |Page down extend selection -Alt+Shift+PageDown |⌥⇧⇟ |None |Page down extend rect. selection -Ctrl+Del |⌘⌦ |^Del |Delete word right -Ctrl+Shift+Del |⌘⇧⌦ |S-^Del |Delete line right -Ins |Ins |Ins |Toggle overtype -Backspace |⌫
⇧⌫ |^H
Bksp |Delete back -Ctrl+Backspace |⌘⌫ |None |Delete word left -Ctrl+Shift+Backspace|⌘⇧⌫ |None |Delete line left -Tab |⇥ |Tab |Insert tab or indent -Shift+Tab |⇧⇥ |S-Tab |Dedent -None |^K |^K |Cut to line end -None |^L |None |Center line vertically -**Other** |||| -Ctrl+Shift+U, xxxx, Enter|None|None|Input Unicode character U-xxxx. - ## Lua Patterns The following is taken from the [Lua 5.2 Reference Manual][]. @@ -282,7 +103,7 @@ As a special case, the empty capture `()` captures the current string position Textadept 5.5 beta introduced an ncurses version that can run in a terminal emulator. However, since ncurses is quite low-level in terms of graphics -capability compared to GTK, the ncurses version of Textadept lacks some +capability compared to GTK+, the ncurses version of Textadept lacks some features in its editing component Scintilla: * Any settings with alpha values are not supported. @@ -694,9 +515,9 @@ Notice the `l.` prefix before most identifiers. #### Key and Menu Changes -Textadept 4 allow key shortcuts to appear in menus, but only simple ones, not -keychains. Therefore, Textadept's key commands have changed radically, as has -the menu structure and menu mnemonics. In order for key shortcuts to appear in +Textadept 4 allow key bindings to appear in menus, but only simple ones, not +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 @@ -704,7 +525,7 @@ keys. Therefore, the menu module needs to be `require`d *after* individual modules from `_m.textadept`, ensure `_m.textadept.menu` is loaded after `_m.textadept.keys`. -On Mac OSX, key command definition has changed. `m` is now ⌘ (command) and `a` +On Mac OSX, key binding definition has changed. `m` is now ⌘ (command) and `a` is now ⌥ (alt/option). `c` remains ^ (control). Previously `a` was ⌘ and ⌥ was undefined. Please note, however, that not all ⌥ combinations by themselves will work since that key is typically used to compose locale-dependent characters. @@ -738,11 +559,11 @@ 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. -[preferences]: 9_Preferences.html#User.Init +[preferences]: 08_Preferences.html#User.Init ##### Autoloading -Key commands in `~/.textadept/key_commands.lua` and snippets in +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`. -- cgit v1.2.3