diff --git a/doc/pages/commands.asciidoc b/doc/pages/commands.asciidoc index 387ab191..588a7543 100644 --- a/doc/pages/commands.asciidoc +++ b/doc/pages/commands.asciidoc @@ -82,7 +82,7 @@ command *q!* has to be used). Aliases are mentionned below each commands. show *text* in status line, with the following *options*: *-markup*::: - expand the markup strings in *text* (c.f. the 'expansions' documentation page) + expand the markup strings in *text* (See <>) *-debug*::: print the given text to the *\*debug** buffer @@ -96,23 +96,24 @@ command *q!* has to be used). Aliases are mentionned below each commands. *declare-option* [-hidden] []:: *alias* decl + declare a new option, the -hidden hides the option in completion - suggestions (c.f. the 'options' documentation page) + suggestions (See <>) *set-option* :: *alias* set + - change the value of an option (c.f. the 'options' documentation page), + change the value of an option note that the name of a particular buffer can be specified when the target *scope* is 'buffer', e.g. set buffer=/path/to/buffer foo "bar"; the scope can also take the `current` special value, which will automatically point to the narrowest scope available in the current context + (See <>) *unset-option* :: *alias* unset + - unset the value of an option (c.f. the 'options' documentation page) + unset the value of an option (See <>) *update-option* :: update the value of an option if its type supports that operation - (c.f. the 'options' documentation page) + (See <>) *alias* :: define a new alias, within the context of a scope @@ -123,45 +124,45 @@ command *q!* has to be used). Aliases are mentionned below each commands. *set-face* :: *alias* face + - define a face (c.f. the 'faces' documentation page) + define a face (See <>) -*exec* [] ...:: - execute a series of keys, as if they were hit (c.f. the 'execeval' - documentation page) +*execute-keys* [] ...:: + *alias* exec + + execute a series of keys, as if they were hit (See <>) -*eval* [] ...:: - execute commands, as if they were entered in the command prompt - (c.f. the 'execeval' documentation page) +*evaluate-commands* [] ...:: + *alias* eval + + evaluate commands, as if they were entered in the command prompt + (See <>) *define-command* [] :: *alias* def + define a new command (c.f. the 'Declaring new commands' section below) *map* :: - bind a list of keys to a combination (c.f. the 'mapping' documentation - page) + bind a list of keys to a combination (See <>) *unmap* []:: - unbind a key combination (c.f. the 'mapping' documentation page) + unbind a key combination (See <>) *hook* [-group ] :: - execute a command whenever an event is triggered (c.f. the 'hooks' - documentation page) + execute a command whenever an event is triggered + (See <>) *remove-hooks* :: *alias* rmhooks + remove every hooks in *scope* that are part of the given *group* - (c.f. the 'hooks' documentation page) + (See <>) *add-highlighter* [] ...:: *alias* addhl + - add a highlighter to the current window (c.f. the 'highlighters' - documentation page) + add a highlighter to the current window + (See <>) *remove-highlighter* :: *alias* rmhl + - remove the highlighter whose id is *highlighter_id* (c.f. the - 'highlighters' documentation page) + remove the highlighter whose id is *highlighter_id* + (See <>) == Helpers diff --git a/doc/pages/faq.asciidoc b/doc/pages/faq.asciidoc index 02d6ca60..66f9ce63 100644 --- a/doc/pages/faq.asciidoc +++ b/doc/pages/faq.asciidoc @@ -88,8 +88,8 @@ not fit the paradigm that Kakoune implements, which is based on selections first. However, you can easily declare key mappings in your configuration file -to be able to use those control-based shortcuts in insert mode (c.f. the -"map" command in the "commands" documentation page). +to be able to use those control-based shortcuts in insert mode. +(See <>) == How can I explore the filesystem the way Vim's NerdTree does ? diff --git a/doc/pages/highlighters.asciidoc b/doc/pages/highlighters.asciidoc index d243ea3c..7940b646 100644 --- a/doc/pages/highlighters.asciidoc +++ b/doc/pages/highlighters.asciidoc @@ -21,8 +21,8 @@ separated path starting with a scope. Scopes are *global*, *buffer*, *highlighter_id* is a name generated by the highlighter specified with *highlighter_name*, possibly dependent on the parameters. Use command -completion in a prompt on the *remove-highlighter* command to see the existing highlighters -ids. +completion in a prompt on the *remove-highlighter* command to see the +existing highlighters ids. == General highlighters @@ -68,7 +68,6 @@ add-highlighter window regex //\h*(TODO:)[^\n]* 0:cyan 1:yellow,red *-tabpad* ::: a one character long separator that will be appended to tabulations to honor the *tabstop* option - *number_lines* [options]:: show line numbers, with the following *options*: diff --git a/doc/pages/keys.asciidoc b/doc/pages/keys.asciidoc index d6a17939..a6885403 100644 --- a/doc/pages/keys.asciidoc +++ b/doc/pages/keys.asciidoc @@ -7,10 +7,9 @@ keys. Non printable keys use an alternate name, written between *<* and *>*, such as ** or **. Modified keys are written between *<* and *>* as well, with the modifier specified as either *c* for Control, or *a* for Alt, followed by a *-* and the key (either its -name or ascii character), for example **, **. +name or ascii character), for example **, **, **. -In order to bind some keys to arbitrary ones, refer to the 'mapping' -documentation page. +In order to bind some keys to arbitrary ones, refer to <> == Insert mode @@ -124,8 +123,8 @@ is a sequence of non whitespace characters same as [ft] but in the other direction *m*:: - select to matching character, see the `matching_pairs` options - in <> + select to matching character, see the `matching_pairs` option + in <> *M*:: extend selection to matching character @@ -134,7 +133,8 @@ is a sequence of non whitespace characters select line on which selection end lies (or next line when end lies on an end-of-line) -*X*:: similar to *x*, except the current selection is extended +*X*:: + similar to *x*, except the current selection is extended **:: expand selections to contain full lines (including end-of-lines) @@ -495,7 +495,6 @@ Searches use the */* register by default == Jump list - **:: Jump forward diff --git a/doc/pages/mapping.asciidoc b/doc/pages/mapping.asciidoc index f4e8f9bc..c3c890fe 100644 --- a/doc/pages/mapping.asciidoc +++ b/doc/pages/mapping.asciidoc @@ -44,7 +44,7 @@ The *unmap* command removes a mapping of *key* in the given *scope* and set to the same sequence of keys passed using the *expected* argument. For more information about the values of the *scope* parameter, refer to -the 'scopes' documentation page. +<>. == Mappable keys @@ -65,6 +65,9 @@ be used: **:: Holding down Alt while pressing the *x* key. +**:: + Holding down Control and Alt while pressing the *x* key. + **, **:: The *<* and *>* characters. @@ -92,8 +95,8 @@ be used: **:: The Escape key. -**, **, **, **, **, **, **:: -**:: +**, **, **, **:: +**, **, **, **:: The usual cursor-movement keys. **, **, ...**:: diff --git a/doc/pages/options.asciidoc b/doc/pages/options.asciidoc index 678c7caa..0d470b01 100644 --- a/doc/pages/options.asciidoc +++ b/doc/pages/options.asciidoc @@ -219,8 +219,8 @@ are exclusively available to built-in options. *modelinefmt* `string`:: A format string used to generate the mode line, that string is first expanded as a command line would be (expanding '%...{...}' - strings), then markup tags are applied (c.f. the 'Expansions' - documentation page.) Two special atoms are available as markup: + strings), then markup tags are applied (See <>) + Two special atoms are available as markup: *`{{mode_info}}`*::: Information about the current mode, such as `insert 3 sel` or diff --git a/doc/pages/scopes.asciidoc b/doc/pages/scopes.asciidoc index e4654f6c..d4ade8d7 100644 --- a/doc/pages/scopes.asciidoc +++ b/doc/pages/scopes.asciidoc @@ -38,15 +38,15 @@ Examples: *filetype*:: A single buffer opened in two separate windows can have different - filetypes declared in the *window* scope with 'set' (c.f. the 'options' - documentation page) + filetypes declared in the *window* scope with 'set'. + (See <>) *status line*:: All the buffers of the current session can have the same information displayed in the status line, except for a specific buffer (the 'modelinefmt' option can be declared in the *global* scope, and - customized in the *buffer* scope with 'set', c.f. the 'options' - documentation page) + customized in the *buffer* scope with 'set'. + (See <>) == Execution context