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

Update layouts and workspaces documentation

This commit is contained in:
syl20bnr 2016-03-20 22:00:45 -04:00
parent 944960daf8
commit eaddd19e71
1 changed files with 30 additions and 18 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

48
doc/DOCUMENTATION.org
View File

@ -1250,10 +1250,18 @@ Setting the variable =dotspacemacs-auto-resume-layouts= to =t= will
automatically resume the last saved layouts. automatically resume the last saved layouts.
*** Layout key bindings *** 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
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
layout with ~Ctrl-<number>~. Pressing ~TAB~ will activate the previously
selected layout.
Press ~?~ to toggle the full help.
| Key Binding | Description | | Key Binding | Description |
|-------------------+------------------------------------------------------------| |-------------------+------------------------------------------------------------|
| ~SPC l~ | activate the transient- state | | ~SPC l~ | activate the transient- state |
| ~?~ | toggle the documentation | | ~?~ | toggle the documentation |
| ~[1..9, 0]~ | switch to nth layout | | ~[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 |
@ -1281,34 +1289,30 @@ automatically resume the last saved layouts.
| ~X~ | kill other layouts with their buffers | | ~X~ | kill other layouts with their buffers |
** Workspaces ** Workspaces
Workspaces are like sub-layouts, they allow to define multiple layouts into a Workspaces are sub-layouts, they allow to define multiple layouts into a given
given layout, those layouts share the same buffer as the parent layout. layout, those layouts share the same buffer as the parent layout.
The currently active workspace number is displayed before the window number, The currently active workspace number is displayed before the window number,
for instance "➊|➍" or "1|4" means the fourth window of the first workspace. for instance "➊|➍" or "1|4" means the fourth window of the first workspace.
At startup, the workspace number 1 is active. Switching to a workspace will Any new layout comes with a default workspace which is the workspace 1.
create it if it does not exist. For instance at startup you can press
~SPC l w 2~ to create the workspace 2.
Switching to a workspace that does not exist in the current layout will create a
new one. For instance at startup you can press ~SPC l w 2~ to create the
workspace 2 in the =default= layout.
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 The key bindings are registered in a transient-state. The docstring of the
transient-state displays the existing workspaces and the currently active transient-state displays the existing workspaces and the currently active
workspace has square brackets. Pressing a workspace number will activate it (or 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 workspace with ~Ctrl-<number>~. Pressing ~TAB~ will activate the previously
selected workspace. It is also possible to give a label to the current workspace selected workspace.
by pressing ~r~.
*** Workspace key bindings Press ~?~ to toggle the full help.
Global key bindings:
| Key Binding | Description |
|-------------+--------------------------------------|
| ~gt~ | go to next workspace |
| ~gT~ | got to previous workspace |
| ~SPC b W~ | go to workspace and window by buffer |
Transient state key bindings:
| Key Binding | Description | | Key Binding | Description |
|-------------------+-------------------------------------------------------------| |-------------------+-------------------------------------------------------------|
@ -1323,6 +1327,14 @@ Transient state key bindings:
| ~R~ | set a tag to the current workspace | | ~R~ | set a tag to the current workspace |
| ~w~ | switched to tagged workspace | | ~w~ | switched to tagged workspace |
There are also some handy globally available key bindings related to workspaces:
| Key Binding | Description |
|-------------+--------------------------------------|
| ~gt~ | go to next workspace |
| ~gT~ | got to previous workspace |
| ~SPC b W~ | go to workspace and window by buffer |
* Commands * Commands
** Vim key bindings ** Vim key bindings
Spacemacs is based on =Vim= modal user interface to navigate and edit text. If Spacemacs is based on =Vim= modal user interface to navigate and edit text. If