Docs: use asciidoc links between pages

This commit is contained in:
Delapouite 2017-11-06 10:08:59 +01:00
parent 52f4af6a83
commit 3b250fe824
7 changed files with 45 additions and 43 deletions

View File

@ -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 <<expansions#,`:doc expansions`>>)
*-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] <type> <name> [<value>]::
*alias* decl +
declare a new option, the -hidden hides the option in completion
suggestions (c.f. the 'options' documentation page)
suggestions (See <<options#,`:doc options`>>)
*set-option* <scope> <name> <value>::
*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 <<options#,`:doc options`>>)
*unset-option* <scope> <name>::
*alias* unset +
unset the value of an option (c.f. the 'options' documentation page)
unset the value of an option (See <<options#,`:doc options`>>)
*update-option* <scope> <name>::
update the value of an option if its type supports that operation
(c.f. the 'options' documentation page)
(See <<options#,`:doc options`>>)
*alias* <scope> <name> <command>::
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* <name> <facespec>::
*alias* face +
define a face (c.f. the 'faces' documentation page)
define a face (See <<faces#,`:doc faces`>>)
*exec* [<flags>] <key> ...::
execute a series of keys, as if they were hit (c.f. the 'execeval'
documentation page)
*execute-keys* [<flags>] <key> ...::
*alias* exec +
execute a series of keys, as if they were hit (See <<execeval#,`:doc execeval`>>)
*eval* [<flags>] <command> ...::
execute commands, as if they were entered in the command prompt
(c.f. the 'execeval' documentation page)
*evaluate-commands* [<flags>] <command> ...::
*alias* eval +
evaluate commands, as if they were entered in the command prompt
(See <<execeval#,`:doc execeval`>>)
*define-command* [<flags>] <name> <command>::
*alias* def +
define a new command (c.f. the 'Declaring new commands' section below)
*map* <scope> <mode> <key> <keys>::
bind a list of keys to a combination (c.f. the 'mapping' documentation
page)
bind a list of keys to a combination (See <<mapping#,`:doc mapping`>>)
*unmap* <scope> <mode> <key> [<expected>]::
unbind a key combination (c.f. the 'mapping' documentation page)
unbind a key combination (See <<mapping#,`:doc mapping`>>)
*hook* [-group <group>] <scope> <hook_name> <filtering_regex> <command>::
execute a command whenever an event is triggered (c.f. the 'hooks'
documentation page)
execute a command whenever an event is triggered
(See <<hooks#,`:doc hooks`>>)
*remove-hooks* <scope> <group>::
*alias* rmhooks +
remove every hooks in *scope* that are part of the given *group*
(c.f. the 'hooks' documentation page)
(See <<hooks#,`:doc hooks`>>)
*add-highlighter* [<flags>] <highlighter_name> <highlighter_parameters> ...::
*alias* addhl +
add a highlighter to the current window (c.f. the 'highlighters'
documentation page)
add a highlighter to the current window
(See <<highlighters#,`:doc highlighters`>>)
*remove-highlighter* <highlighter_id>::
*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 <<highlighters#,`:doc highlighters`>>)
== Helpers

View File

@ -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 <<mapping#,`:doc mapping`>>)
== How can I explore the filesystem the way Vim's NerdTree does ?

View File

@ -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* <separator>:::
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*:

View File

@ -7,10 +7,9 @@ keys. Non printable keys use an alternate name, written between *<*
and *>*, such as *<esc>* or *<del>*. 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 *<c-x>*, *<a-space>*.
name or ascii character), for example *<c-x>*, *<a-space>*, *<c-a-w>*.
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 <<mapping#,`:doc mapping`>>
== 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 <<doc/pages/options#,`:doc options`>>
select to matching character, see the `matching_pairs` option
in <<options#,`:doc options`>>
*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
*<a-x>*::
expand selections to contain full lines (including end-of-lines)
@ -495,7 +495,6 @@ Searches use the */* register by default
== Jump list
*<c-i>*::
Jump forward

View File

@ -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.
<<scopes#,`:doc scopes`>>.
== Mappable keys
@ -65,6 +65,9 @@ be used:
*<a-x>*::
Holding down Alt while pressing the *x* key.
*<c-a-x>*::
Holding down Control and Alt while pressing the *x* key.
*<lt>*, *<gt>*::
The *<* and *>* characters.
@ -92,8 +95,8 @@ be used:
*<esc>*::
The Escape key.
*<up>*, *<down>*, *<left>*, *<right>*, *<pageup>*, *<pagedown>*, *<home>*::
*<end>*::
*<up>*, *<down>*, *<left>*, *<right>*::
*<pageup>*, *<pagedown>*, *<home>*, *<end>*::
The usual cursor-movement keys.
*<f1>*, *<f2>*, ...*<f12>*::

View File

@ -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 <<expansions#,`:doc expansions`>>)
Two special atoms are available as markup:
*`{{mode_info}}`*:::
Information about the current mode, such as `insert 3 sel` or

View File

@ -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 <<options#,`:doc options`>>)
*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 <<options#,`:doc options`>>)
== Execution context