amin/vim-denote
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

readme and doc: minor imprv

Browse Source
This commit is contained in:
Ämin Baumeler
2026-03-03 23:12:28 +01:00
parent 66e032ee38
commit 5b7825d358
2 changed files with 8 additions and 7 deletions
Download Patch File Download Diff File Expand all files Collapse all files

11
README.md
View File

@@ -23,15 +23,16 @@ Also, the present package aims at remaining flexible. Again, both
above-mentioned plugins require the denote note identifiers to follow the rigid above-mentioned plugins require the denote note identifiers to follow the rigid
format `YYYYMMDDTHHMMSS`. Per denote manual, however, the identify may be [any format `YYYYMMDDTHHMMSS`. Per denote manual, however, the identify may be [any
string](https://protesilaos.com/emacs/denote#h:3048f558-7d84-45d6-9ef2-53055483e801) string](https://protesilaos.com/emacs/denote#h:3048f558-7d84-45d6-9ef2-53055483e801)
(free of field delimiters, of course). (free of field delimiters, of course). This package offers great flexibility in
configuration (see `:help denote-settings`).
### Installation ### Installation
You may use any of your favorite plugin managers, or, manually place a copy of You may use any of your favorite plugin managers, or, manually place a copy of
this package in, e.g., `~/.vim/pack/tools/start`. For such a manual this package in, e.g., `~/.vim/pack/tools/start`. For such a manual
installation, you may want to run `:helptags installation, you may want to run `:helptags
~/.vim/pack/tools/start/vim-denote` to regenerate the help files. This allows ~/.vim/pack/tools/start/vim-denote/doc` to regenerate the help files. This
you to display the package documentation using `:help vim-denote` and similar allows you to display the package documentation using `:help vim-denote` and
commands. similar commands.
### Usage ### Usage
vim needs to know where your denote entries are stored. To do so, run the vim needs to know where your denote entries are stored. To do so, run the
@@ -54,7 +55,7 @@ completion](https://vimhelp.org/insert.txt.html#compl-omni) by pressing
`denote:<str>`, then the link is completed for denote entries that have `<str>` `denote:<str>`, then the link is completed for denote entries that have `<str>`
as part of the title. as part of the title.
_Browsing_ and searching notes:_ Browsing and searching is done using vim's _Browsing and searching notes:_ Browsing and searching is done using vim's
[location list](https://vimhelp.org/quickfix.txt.html#location-list). The [location list](https://vimhelp.org/quickfix.txt.html#location-list). The
benefit of doing so is that commands like `:lnext`, `:lprev` etc. become benefit of doing so is that commands like `:lnext`, `:lprev` etc. become
available. available.

4
doc/denote.txt
View File

@@ -386,8 +386,8 @@ denote#notes#bytag({tag})
*denote#notes#grep()* *denote#notes#grep()*
denote#notes#grep({re}) denote#notes#grep({re})
This is the function used by |:DenoteGrep| to search for patterns This is the function used by |:DenoteGrep| and |:DenoteBackReferences|
within the denote files. to search for patterns within the denote files.
*denote#notes#new()* *denote#notes#new()*
denote#notes#new({title}, {ext}) denote#notes#new({title}, {ext})