TakeV
/
spacemacs
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Doc: transient-state => transient state

This commit is contained in:
syl20bnr 2016-03-20 22:08:49 -04:00
parent eaddd19e71
commit f801ceebe7
1 changed files with 84 additions and 84 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

168
doc/DOCUMENTATION.org
View File

@ -91,7 +91,7 @@
- [[Helm][Helm]]
- [[C-z and Tab switch][C-z and Tab switch]]
- [[Helm focus][Helm focus]]
- [[Helm transient-state][Helm transient-state]]
- [[Helm transient state][Helm transient state]]
- [[Discovering][Discovering]]
- [[Key bindings][Key bindings]]
- [[Which-key][Which-key]]
@ -112,17 +112,17 @@
- [[Joining and splitting][Joining and splitting]]
- [[Window manipulation][Window manipulation]]
- [[Window manipulation key bindings][Window manipulation key bindings]]
- [[Window manipulation transient-state][Window manipulation transient-state]]
- [[Window manipulation transient state][Window manipulation transient state]]
- [[Golden ratio][Golden ratio]]
- [[Buffers and Files][Buffers and Files]]
- [[Buffers manipulation key bindings][Buffers manipulation key bindings]]
- [[Buffers manipulation transient-state][Buffers manipulation transient-state]]
- [[Buffers manipulation transient state][Buffers manipulation transient state]]
- [[Special Buffers][Special Buffers]]
- [[Files manipulations key bindings][Files manipulations key bindings]]
- [[Emacs and Spacemacs files][Emacs and Spacemacs files]]
- [[Browsing files with Helm][Browsing files with Helm]]
- [[Ido][Ido]]
- [[Ido transient-state][Ido transient-state]]
- [[Ido transient state][Ido transient state]]
- [[NeoTree file tree][NeoTree file tree]]
- [[NeoTree navigation][NeoTree navigation]]
- [[Opening files with NeoTree][Opening files with NeoTree]]
@ -742,16 +742,16 @@ to ~SPC u~.
pressing ~RETURN~. For instance: ~SPC SPC org-reload C-u RET~
** Transient-states
Spacemacs defines a wide variety of =transient-states= (temporary overlay maps)
Spacemacs defines a wide variety of =transient states= (temporary overlay maps)
where it makes sense. This prevents one from doing repetitive and tedious
presses on the ~SPC~ key.
When a =transient-state= is active, a documentation is displayed in the
When a =transient state= is active, a documentation is displayed in the
minibuffer. Additional information may as well be displayed in the minibuffer.
Auto-highlight-symbol transient-state:
Auto-highlight-symbol transient state:
[[file:img/spacemacs-ahs-transient-state.png]]
[[Text][Text scale transient-state]]:
[[Text][Text scale transient state]]:
[[file:img/spacemacs-scale-transient-state.png]]
@ -991,7 +991,7 @@ and ~T~):
| ~SPC T m~ | toggle menu bar |
| ~SPC T M~ | toggle frame maximize |
| ~SPC T t~ | toggle tool bar |
| ~SPC T T~ | toggle frame transparency and enter transparency transient-state |
| ~SPC T T~ | toggle frame transparency and enter transparency transient state |
*Note*: These toggles are all available via the =helm-spacemacs-help= interface
(press ~SPC h SPC~ to display the =helm-spacemacs-help= buffer).
@ -1250,10 +1250,10 @@ Setting the variable =dotspacemacs-auto-resume-layouts= to =t= will
automatically resume the last saved layouts.
*** Layout key bindings
The key bindings are registered in a transient-state. The docstring of the
transient-state displays the existing layouts and the currently active
The key bindings are registered in a transient state. The docstring of the
transient state displays the existing layouts and the currently active
layout has square brackets. Pressing a layout number will activate it (or
create a new one) and exit the transient-state. It is possible to just preview a
create a new one) and exit the transient state. It is possible to just preview a
layout with ~Ctrl-<number>~. Pressing ~TAB~ will activate the previously
selected layout.
@ -1264,7 +1264,7 @@ Press ~?~ to toggle the full help.
| ~SPC l~ | activate the transient- state |
| ~?~ | toggle the documentation |
| ~[1..9, 0]~ | switch to nth layout |
| ~[C-1..C-9, C-0]~ | switch to nth layout and keep the transient-state active |
| ~[C-1..C-9, C-0]~ | switch to nth layout and keep the transient state active |
| ~<tab>~ | switch to the latest layout |
| ~a~ | add a buffer to the current layout |
| ~A~ | add all the buffers from another layout in the current one |
@ -1284,7 +1284,7 @@ Press ~?~ to toggle the full help.
| ~R~ | rename current layout |
| ~s~ | save layouts |
| ~t~ | display a buffer without adding it to the current layout |
| ~w~ | workspaces transient-state (needs eyebrowse layer enabled) |
| ~w~ | workspaces transient state (needs eyebrowse layer enabled) |
| ~x~ | kill current layout with its buffers |
| ~X~ | kill other layouts with their buffers |
@ -1305,10 +1305,10 @@ When created a workspace is anonymous, you can give them a name with
~SPC l w R~.
*** Workspace key bindings
The key bindings are registered in a transient-state. The docstring of the
transient-state displays the existing workspaces and the currently active
The key bindings are registered in a transient state. The docstring of the
transient state displays the existing workspaces and the currently active
workspace has square brackets. Pressing a workspace number will activate it (or
create a new one) and exit the transient-state. It is possible to just preview a
create a new one) and exit the transient state. It is possible to just preview a
workspace with ~Ctrl-<number>~. Pressing ~TAB~ will activate the previously
selected workspace.
@ -1316,10 +1316,10 @@ Press ~?~ to toggle the full help.
| Key Binding | Description |
|-------------------+-------------------------------------------------------------|
| ~SPC l w~ | activate the transient-state |
| ~SPC l w~ | activate the transient state |
| ~?~ | toggle the documentation |
| ~[1..9, 0]~ | switch to nth workspace |
| ~[C-1..C-9, C-0]~ | switch to nth workspace and keep the transient-state active |
| ~[C-1..C-9, C-0]~ | switch to nth workspace and keep the transient state active |
| ~TAB~ | switch to last active workspace |
| ~d~ | close current workspace |
| ~n~ or ~l~ | switch to next workspace |
@ -1434,17 +1434,17 @@ makes sense to swap them. It's also recommended [[http://tuhdo.github.io/helm-in
If you find yourself unable to return focus to Helm (after a careless
mouse-click for example), use ~SPC w b~ to return focus to the minibuffer.
*** Helm transient-state
Spacemacs defines a [[Transient-states][transient-state]] for =Helm= to make it work like [[https://github.com/Shougo/unite.vim][Vim's Unite]]
*** Helm transient state
Spacemacs defines a [[Transient-states][transient state]] for =Helm= to make it work like [[https://github.com/Shougo/unite.vim][Vim's Unite]]
plugin.
Initiate the transient-state with ~M-SPC~ or ~s-M-SPC~ while in a =Helm= buffer.
Initiate the transient state with ~M-SPC~ or ~s-M-SPC~ while in a =Helm= buffer.
| Key Binding | Description |
|----------------------+------------------------------------------------------|
| ~M-SPC~ or ~s-M-SPC~ | initiate the transient-state |
| ~q~ | quit transient-state |
| ~TAB~ | switch to actions page and leave the transient-state |
| ~M-SPC~ or ~s-M-SPC~ | initiate the transient state |
| ~q~ | quit transient state |
| ~TAB~ | switch to actions page and leave the transient state |
| ~1~ | execute action 0 |
| ~2~ | execute action 1 |
| ~3~ | execute action 2 |
@ -1593,7 +1593,7 @@ Spacemacs.
*** Toggles
=helm-spacemacs-help= is also a central place to discover the available toggles.
To display only the toggles source press ~C-l~ (or in [[Helm transient-state][Helm transient-state]] you can
To display only the toggles source press ~C-l~ (or in [[Helm transient state][Helm transient state]] you can
press just ~l~).
The following helm actions are available on packages:
@ -1770,14 +1770,14 @@ Windows manipulation commands (start with ~w~):
| ~SPC w w~ | cycle and focus between windows |
| ~SPC w SPC~ | select window using [[https://github.com/abo-abo/ace-window][ace-window]] |
**** Window manipulation transient-state
A convenient window manipulation transient-state allows to perform most of the
actions listed above. The transient-state allows additional actions as well like
**** Window manipulation transient state
A convenient window manipulation transient state allows to perform most of the
actions listed above. The transient state allows additional actions as well like
window resizing.
| Key Binding | Description |
|---------------+---------------------------------------------------------------|
| ~SPC w .~ | initiate transient-state |
| ~SPC w .~ | initiate transient state |
| ~?~ | display the full documentation in minibuffer |
| ~0~ | go to window number 0 |
| ~1~ | go to window number 1 |
@ -1815,7 +1815,7 @@ window resizing.
| ~v~ | vertical split |
| ~V~ | horizontal split and focus new window |
| ~w~ | focus other window |
| Any other key | leave the transient-state |
| Any other key | leave the transient state |
**** Golden ratio
If you resize windows like crazy you may want to give a try to [[https://github.com/roman/golden-ratio.el][golden-ratio]].
@ -1855,17 +1855,17 @@ Buffer manipulation commands (start with ~b~):
| ~SPC b Y~ | copy whole buffer to clipboard (useful when copying to a browser) |
| ~z f~ | Make current function or comments visible in buffer as much as possible |
**** Buffers manipulation transient-state
A convenient buffer manipulation transient-state allows to quickly cycles through
**** Buffers manipulation transient state
A convenient buffer manipulation transient state allows to quickly cycles through
the opened buffer and kill them.
| Key Binding | Description |
|---------------+-----------------------------------------------|
| ~SPC b .~ | initiate transient-state |
| ~SPC b .~ | initiate transient state |
| ~K~ | kill current buffer |
| ~n~ | go to next buffer (avoid special buffers) |
| ~N~ | go to previous buffer (avoid special buffers) |
| Any other key | leave the transient-state |
| Any other key | leave the transient state |
**** Special Buffers
Unlike vim, emacs creates many buffers that most people do not need to see. Some
@ -1954,14 +1954,14 @@ Basic =ido= operations can be done with ~Ctrl~ key:
| ~C-S-k~ or ~C-S-p~ | previous history element |
| ~C-S-l~ | go to next directory |
*** Ido transient-state
Spacemacs defines a [[Transient-states][transient-state]] for =ido=.
*** Ido transient state
Spacemacs defines a [[Transient-states][transient state]] for =ido=.
Initiate the transient-state with ~M-SPC~ or ~s-M-SPC~ while in an =ido= buffer.
Initiate the transient state with ~M-SPC~ or ~s-M-SPC~ while in an =ido= buffer.
| Key Binding | Description |
|----------------------+---------------------------------------|
| ~M-SPC~ or ~s-M-SPC~ | initiate or leave the transient-state |
| ~M-SPC~ or ~s-M-SPC~ | initiate or leave the transient state |
| ~?~ | display help |
| ~e~ | open dired |
| ~h~ | delete backward or parent directory |
@ -1973,7 +1973,7 @@ Initiate the transient-state with ~M-SPC~ or ~s-M-SPC~ while in an =ido= buffer.
| ~n~ | next directory in history |
| ~o~ | open in other window |
| ~p~ | previous directory in history |
| ~q~ | quit transient-state |
| ~q~ | quit transient state |
| ~s~ | open in a new horizontal split |
| ~t~ | open in other frame |
| ~v~ | open in a new vertical split |
@ -2286,7 +2286,7 @@ by pressing ~SPC s c~ or executing the ex command =:noh=.
*** Highlight current symbol
Spacemacs supports highlighting of the current symbol on demand (provided by
[[https://github.com/emacsmirror/auto-highlight-symbol][auto-highlight-symbol]] mode) and adds a transient-state to easily navigate and rename
[[https://github.com/emacsmirror/auto-highlight-symbol][auto-highlight-symbol]] mode) and adds a transient state to easily navigate and rename
this symbol.
It is also possible to change the range of the navigation on the fly to:
@ -2300,14 +2300,14 @@ Navigation between the highlighted symbols can be done with the commands:
| Key Binding | Description |
|-------------+------------------------------------------------------------------------------------|
| ~/~ | initiate navigation transient-state on current symbol and jump forwards |
| ~#~ | initiate navigation transient-state on current symbol and jump backwards |
| ~/~ | initiate navigation transient state on current symbol and jump forwards |
| ~#~ | initiate navigation transient state on current symbol and jump backwards |
| ~SPC s e~ | edit all occurrences of the current symbol(/) |
| ~SPC s h~ | highlight the current symbol and all its occurrence within the current range |
| ~SPC s H~ | go to the last searched occurrence of the last highlighted symbol |
| ~SPC t h a~ | toggle automatic highlight of symbol under point after =ahs-idle-interval= seconds |
In 'Spacemacs' highlight symbol transient-state:
In 'Spacemacs' highlight symbol transient state:
| Key Binding | Description |
|---------------+---------------------------------------------------------------|
@ -2318,12 +2318,12 @@ In 'Spacemacs' highlight symbol transient-state:
| ~D~ | go to previous definition occurrence |
| ~r~ | change range (=function=, =display area=, =whole buffer=) |
| ~R~ | go to home occurrence (reset position to starting occurrence) |
| Any other key | leave the navigation transient-state |
| Any other key | leave the navigation transient state |
(*) using [[https://github.com/tsdh/iedit][iedit]] or the default implementation
of =auto-highlight-symbol=
The transient-state text in minibuffer display the following information:
The transient state text in minibuffer display the following information:
#+BEGIN_EXAMPLE
<M> [6/11]* press (n/N) to navigate, (e) to edit, (r) to change range or (R)
@ -2346,7 +2346,7 @@ selection.
It is pretty useful combined with the [[Region selection][expand-region]] bindings.
*Note*: If the current state is not the =visual state= then pressing ~*~ uses
auto-highlight-symbol and its transient-state.
auto-highlight-symbol and its transient state.
*** Listing symbols by semantic
Use =helm-semantic-or-imenu= command from =Helm= to quickly navigate between the
@ -2371,10 +2371,10 @@ modifications to the buffer.
** Editing
*** Paste text
**** Paste Transient-state
The paste transient-state can be enabled by settings the variable
The paste transient state can be enabled by settings the variable
=dotspacemacs-enable-paste-transient-state= to =t=. By default it is disabled.
When the transient-state is enabled, pressing ~p~ again will replace the pasted text
When the transient state is enabled, pressing ~p~ again will replace the pasted text
with the previous yanked (copied) text on the kill ring.
For example if you copy =foo= and =bar= then press ~p~ the text =bar= will
@ -2382,11 +2382,11 @@ be pasted, pressing ~p~ again will replace =bar= with =foo=.
| Key Binding | Description |
|---------------+-------------------------------------------------------------------------------|
| ~p~ or ~P~ | paste the text before or after point and initiate the =paste= transient-state |
| ~p~ | in transient-state: replace paste text with the previously copied one |
| ~P~ | in transient-state: replace paste text with the next copied one |
| ~.~ | paste the same text and leave the transient-state |
| Any other key | leave the transient-state |
| ~p~ or ~P~ | paste the text before or after point and initiate the =paste= transient state |
| ~p~ | in transient state: replace paste text with the previously copied one |
| ~P~ | in transient state: replace paste text with the next copied one |
| ~.~ | paste the same text and leave the transient state |
| Any other key | leave the transient state |
**** Auto-indent pasted text
By default any pasted text will be auto-indented. To paste text un-indented use
@ -2424,8 +2424,8 @@ Text related commands (start with ~x~):
| ~SPC x j l~ | set the justification to left |
| ~SPC x j n~ | set the justification to none |
| ~SPC x j r~ | set the justification to right |
| ~SPC x J~ | move down a line of text (enter transient-state) |
| ~SPC x K~ | move up a line of text (enter transient-state) |
| ~SPC x J~ | move down a line of text (enter transient state) |
| ~SPC x K~ | move up a line of text (enter transient state) |
| ~SPC x l s~ | sort lines |
| ~SPC x l u~ | uniquify lines |
| ~SPC x o~ | use avy to select a link in the frame and open it |
@ -2469,17 +2469,17 @@ It is possible to enable it easily for /all programming modes/ with the variable
**** Text
The font size of the current buffer can be adjusted with the commands:
| Key Binding | Description |
|---------------+----------------------------------------------------------------------------|
| ~SPC z x +~ | scale up the font and initiate the font scaling transient-state |
| ~SPC z x =~ | scale up the font and initiate the font scaling transient-state |
| ~SPC z x -~ | scale down the font and initiate the font scaling transient-state |
| ~SPC z x 0~ | reset the font size (no scaling) and initiate the font scaling transient-state |
| ~+~ | increase the font size |
| ~=~ | increase the font size |
| ~-~ | decrease the font size |
| ~0~ | reset the font size |
| Any other key | leave the font scaling transient-state |
| Key Binding | Description |
|---------------+--------------------------------------------------------------------------------|
| ~SPC z x +~ | scale up the font and initiate the font scaling transient state |
| ~SPC z x =~ | scale up the font and initiate the font scaling transient state |
| ~SPC z x -~ | scale down the font and initiate the font scaling transient state |
| ~SPC z x 0~ | reset the font size (no scaling) and initiate the font scaling transient state |
| ~+~ | increase the font size |
| ~=~ | increase the font size |
| ~-~ | decrease the font size |
| ~0~ | reset the font size |
| Any other key | leave the font scaling transient state |
Note that /only/ the text of the current buffer is scaled, the other buffers,
the mode-line and the minibuffer are not affected. To zoom the whole content of
@ -2488,33 +2488,33 @@ a frame use the =zoom frame= bindings (see next section).
**** Frame
You can zoom in and out the whole content of the frame with the commands:
| Key Binding | Description |
|---------------+-------------------------------------------------------------------------|
| ~SPC z f +~ | zoom in the frame content and initiate the frame scaling transient-state |
| ~SPC z f =~ | zoom in the frame content and initiate the frame scaling transient-state |
| ~SPC z f -~ | zoom out the frame content and initiate the frame scaling transient-state |
| ~SPC z f 0~ | reset the frame content size and initiate the frame scaling transient-state |
| ~+~ | zoom in |
| ~=~ | zoom in |
| ~-~ | zoom out |
| ~0~ | reset zoom |
| Any other key | leave the zoom frame transient-state |
| Key Binding | Description |
|---------------+-----------------------------------------------------------------------------|
| ~SPC z f +~ | zoom in the frame content and initiate the frame scaling transient state |
| ~SPC z f =~ | zoom in the frame content and initiate the frame scaling transient state |
| ~SPC z f -~ | zoom out the frame content and initiate the frame scaling transient state |
| ~SPC z f 0~ | reset the frame content size and initiate the frame scaling transient state |
| ~+~ | zoom in |
| ~=~ | zoom in |
| ~-~ | zoom out |
| ~0~ | reset zoom |
| Any other key | leave the zoom frame transient state |
*** Increase/Decrease numbers
Spacemacs uses [[https://github.com/cofi/evil-numbers][evil-numbers]] to easily increase or increase numbers.
| Key Binding | Description |
|-------------+-----------------------------------------------------------------|
| ~SPC n +~ | increase the number under point by one and initiate transient-state |
| ~SPC n -~ | decrease the number under point by one and initiate transient-state |
| Key Binding | Description |
|-------------+---------------------------------------------------------------------|
| ~SPC n +~ | increase the number under point by one and initiate transient state |
| ~SPC n -~ | decrease the number under point by one and initiate transient state |
In transient-state:
In transient state:
| Key Binding | Description |
|---------------+----------------------------------------|
| ~+~ | increase the number under point by one |
| ~-~ | decrease the number under point by one |
| Any other key | leave the transient-state |
| Any other key | leave the transient state |
*Tips:* you can increase or decrease a value by more that once by using a prefix
argument (ie. ~10 SPC n +~ will add 10 to the number under point).