xenia/kakoune
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

docs: add more explanation about the ambiguous "window" scope.

Browse Source 
The info are currently burried in a hard to find wiki page:
https://github.com/mawww/kakoune/wiki/The-window-scope
This commit is contained in:
Delapouite 2018-06-02 19:51:39 +02:00
parent 57b71f0750
commit c0c7b6590f
1 changed files with 12 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

15
doc/pages/scopes.asciidoc
View File

@ -19,7 +19,16 @@ These scoped objects are:
Scopes are named as follows: Scopes are named as follows:
*window*:: *window*::
context linked to the window displaying a buffer context linked to the window displaying a buffer.
In Kakoune, the concept of a *window* must not be confused with
the concept of a window at the OS level.
In other terms, a window is *not* a client (like a terminal or GUI)
but one of many 'views' into a buffer.
There is a N:1 relationship between windows and buffers; once a
window is linked to a buffer, the window's buffer never changes.
Windows store a set of selections and the scroll position.
*buffer*:: *buffer*::
context linked directly to the buffer context linked directly to the buffer
@ -51,14 +60,14 @@ Examples:
*filetype*:: *filetype*::
A single buffer opened in two separate windows can have different A single buffer opened in two separate windows can have different
filetypes declared in the *window* scope with 'set'. filetypes declared in the *window* scope with 'set-option'.
(See <<options#,`:doc options`>>) (See <<options#,`:doc options`>>)
*status line*:: *status line*::
All the buffers of the current session can have the same information All the buffers of the current session can have the same information
displayed in the status line, except for a specific buffer (the displayed in the status line, except for a specific buffer (the
'modelinefmt' option can be declared in the *global* scope, and 'modelinefmt' option can be declared in the *global* scope, and
customized in the *buffer* scope with 'set'. customized in the *buffer* scope with 'set-option'.
(See <<options#,`:doc options`>>) (See <<options#,`:doc options`>>)
== Execution context == Execution context