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

update line-flags and flag_lines doc to reflect current status

Browse Source
This commit is contained in:
Olivier Perret 2017-05-11 20:40:17 +02:00
parent 75e6b54ae2
commit ec636ce04b
4 changed files with 14 additions and 9 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

8
README.asciidoc
View File

@ -867,6 +867,9 @@ Options are typed, their type can be
(`<begin line>.<begin column>,<end line>.<end column>` or (`<begin line>.<begin column>,<end line>.<end column>` or
`<begin line>.<end line>+<length>`) and a face (separated by `|`), `<begin line>.<end line>+<length>`) and a face (separated by `|`),
except for the first element which is just the timestamp of the buffer. except for the first element which is just the timestamp of the buffer.
* `line-flags`: a `:` separated list of a line number and a corresponding
flag (`<line>|<flag text>`), except for the first element which is just
the timestamp of the buffer.
* `completions`: a `:` separated list of `<text>|<docstring>|<menu text>` * `completions`: a `:` separated list of `<text>|<docstring>|<menu text>`
candidates, except for the first element which follows the candidates, except for the first element which follows the
`<line>.<column>[+<length>]@<timestamp>` format to define where the `<line>.<column>[+<length>]@<timestamp>` format to define where the
@ -1230,9 +1233,8 @@ General highlighters are:
yellow on red background. yellow on red background.
* `dynregex`: Similar to regex, but expand (like a command parameter would) the * `dynregex`: Similar to regex, but expand (like a command parameter would) the
given expression before building a regex from the result. given expression before building a regex from the result.
* `flag_lines <flag> <option_name>`: add a column in front of text, and display the * `flag_lines <face> <option_name>`: add a column in front of the buffer,
given flag in it for everly line contained in the int-list option named and display the flags specified in <option_name>, using <face>
<option_name>.
* `show_matching`: highlight matching char of the character under the selections' * `show_matching`: highlight matching char of the character under the selections'
cursor using `MatchingChar` face. cursor using `MatchingChar` face.
* `show_whitespaces \<-tab <separator> \<-tabpad <separator> \<-lf <separator> \<-spc <separator> \<-nbsp <separator>`: display symbols on top of whitespaces to make them more explicit using the Whitespace face. * `show_whitespaces \<-tab <separator> \<-tabpad <separator> \<-lf <separator> \<-spc <separator> \<-nbsp <separator>`: display symbols on top of whitespaces to make them more explicit using the Whitespace face.

6
doc/manpages/highlighters.asciidoc
View File

@ -43,9 +43,9 @@ General highlighters
Similar to regex, but expand (like a command parameter would) the Similar to regex, but expand (like a command parameter would) the
given expression before building a regex from the result given expression before building a regex from the result
*flag_lines* <flag> <option_name>:: *flag_lines* <face> <option_name>::
add a column in front of text, and display the given flag in it for add a column in front of the buffer, and display the flags specified
every line contained in the int-list option named <option_name> in <option_name>, using <face>
*show_matching*:: *show_matching*::
highlight matching char of the character under the selections' cursor highlight matching char of the character under the selections' cursor

4
doc/manpages/options.asciidoc
View File

@ -27,6 +27,10 @@ Types
(`<begin line>.<begin column>,<end line>.<end column>` or (`<begin line>.<begin column>,<end line>.<end column>` or
`<begin line>.<begin column>+<length>`) and a face (separated by `|`), `<begin line>.<begin column>+<length>`) and a face (separated by `|`),
except for the first element which is just the timestamp of the buffer. except for the first element which is just the timestamp of the buffer.
*line-flags*::
a `:` separated list of a line number and a corresponding flag
(`<line>|<flag text>`), except for the first element which is just the
timestamp of the buffer.
*completions*:: *completions*::
a `:` separated list of `<text>|<docstring>|<menu text>` a `:` separated list of `<text>|<docstring>|<menu text>`
candidates, except for the first element which follows the candidates, except for the first element which follows the

5
src/highlighters.cc
View File

@ -1879,9 +1879,8 @@ void register_highlighters()
registry.insert({ registry.insert({
"flag_lines", "flag_lines",
{ FlagLinesHighlighter::create, { FlagLinesHighlighter::create,
"Parameters: <option name> <bg color>\n" "Parameters: <face> <option name>\n"
"Display flags specified in the line-flag-list option <option name>\n" "Display flags specified in the line-flags option <option name> with <face>"} });
"A line-flag is written: <line>|<fg color>|<text>, the list is : separated" } });
registry.insert({ registry.insert({
"ranges", "ranges",
{ RangesHighlighter::create, { RangesHighlighter::create,