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

Update plugin docs to not duplicate docstring information.

Browse Source
This commit is contained in:
Tim Allen 2020-09-03 17:18:19 +10:00
parent 9934788155
commit 66cc39cb14
3 changed files with 23 additions and 76 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

20
rc/tools/autorestore.asciidoc
View File

@ -5,19 +5,9 @@ files with predictable names. When you edit a file, if such a backup file
exists, this plugin will automatically load the content of the backup file exists, this plugin will automatically load the content of the backup file
instead. instead.
== Commands By default, backup files are deleted when restored. You can set the
`autorestore_purge_restored` option to `false` to prevent this.
*autorestore-restore-buffer*:: If you don't want backups to be restored automatically, use the
Restore the backup for the current file if it exists. `autorestore-disable` command to disable the feature for the current session,
or put it in your `kakrc` to disable the feature forever.
*autorestore-purge-backups*::
Remove all the backups of the current buffer.
*autorestore-disable*::
Disable automatic backup recovering for this session.
== Options
*autorestore_purge_restored* (bool)::
*default* true +
If true, remove backups once they've been restored

28
rc/tools/doc.asciidoc
View File

@ -2,6 +2,12 @@
This is Kakoune's online documentation system. This is Kakoune's online documentation system.
To see what documentation topics are available, type `:doc` and look at the
completion menu. To view the a particular documentation topic, type the topic
name or choose it from the completion menu and hit Enter.
Documentation will be displayed in the client named in the `docsclient` option.
== Using the documentation browser == Using the documentation browser
Documentation buffers are like any other buffer, so you can scroll through them Documentation buffers are like any other buffer, so you can scroll through them
@ -11,24 +17,6 @@ follow it by moving the cursor onto it and pressing Enter. If the link takes you
to a different documentation topic, you can get back by using the `:buffer` to a different documentation topic, you can get back by using the `:buffer`
command. command.
== Commands
*doc* <topic> [<target>]::
*alias* help +
This command displays documentation about the named topic in a new buffer.
If a target is supplied, Kakoune will automatically jump to that target
when the buffer is opened.
+
For a list of available topics, or available targets within a topic, check
the completion menu that appears when typing the command at the prompt.
== Options
*docsclient* (str)::
If set, the `:doc` command will try to display documentation in the Kakoune
client with this name.
See <<commands#clients-and-sessions,`:doc commands clients-and-sessions`>>
== Writing documentation == Writing documentation
Documentation must be in AsciiDoc format, with the extension `.asciidoc`, Documentation must be in AsciiDoc format, with the extension `.asciidoc`,
@ -37,14 +25,14 @@ Kakoune's built-in documentation renderer does not necessarily support every
feature, so don't go overboard with formatting. feature, so don't go overboard with formatting.
To create a link to another documentation topic, the URL should be the topic- To create a link to another documentation topic, the URL should be the topic-
name, just like <<doc#commands,`:doc`>> uses. Because topics are identified name, just like `:doc` uses. Because topics are identified
only by their basename, you should take care that your topic's name does not only by their basename, you should take care that your topic's name does not
collide with any of the names used by other plugins or Kakoune's standard collide with any of the names used by other plugins or Kakoune's standard
library. library.
== Sources == Sources
The <<doc#commands,`:doc` command>> searches within the following locations for The `:doc` command searches within the following locations for
documents in the AsciiDoc format (`*.asciidoc`): documents in the AsciiDoc format (`*.asciidoc`):
* The user plugin directory, `"%val{config}/autoload"` * The user plugin directory, `"%val{config}/autoload"`

51
rc/tools/lint.asciidoc
View File

@ -11,46 +11,15 @@ format:
If the 'kind' field contains 'error', the message is treated as an error, If the 'kind' field contains 'error', the message is treated as an error,
otherwise it is assumed to be a warning. otherwise it is assumed to be a warning.
This plugin can run such tools and collect the resulting messages. The complete The `:lint-buffer` and `:lint-selections` commands will run the shell command
output is collected in the `*lint-output*` buffer, and any lines in the current specified in the `lintcmd` option, collect the result in the `*lint-output*`
file with messages will have a marker displayed next to them in the left margin. buffer, and analyze it. If `toolsclient` is set, the `*lint-output*` buffer will
When the cursor moves onto a line with the problem, the associated messages will be displayed in the named client.
be displayed in a tool tip.
== Commands Each reported error or warning causes a marker to appear in the left-hand
margin of the buffer that was checked. When the main cursor moves onto that
*lint-buffer*:: line, the associated messages are displayed. If they get distracting, you can
*alias* lint + turn off the markers and messages with the `:lint-hide-diagnostics` command.
Pass the entire buffer through the program named in `lintcmd`. The buffer
may contain unsaved changes.
*lint-selections* [-command <cmd>]::
Pass each of the selections through `<cmd>` or, if the `-command` switch is
not provided, through the program named in `lintcmd`. The buffer may contain
unsaved changes.
*lint-hide-diagnostics*::
Hide line markers and disable the automatic display of messages, if any.
*lint-next-message*::
Jump to the next message generated by the last `lint-buffer` or
`lint-selections` command.
*lint-previous-message*::
Jump to the previous message generated by the last `lint-buffer` or
`lint-selections` command.
== Options
*lintcmd* (str)::
The shell command used by lint-buffer and lint-selections.
+
It will be given the path to a file containing the text to be
linted, and must produce output in the format described above.
*toolsclient* (str)::
If set, the `:lint` command will try to display its results in the Kakoune
client with this name.
See <<commands#clients-and-sessions,`:doc commands clients-and-sessions`>>
You can also use `:lint-next-message` and `:lint-previous-message` to jump
between the lines with messages.