doc/help: adjusted to current version
This commit is contained in:
144
doc/denote.txt
144
doc/denote.txt
@@ -1,17 +1,16 @@
|
||||
*denote.txt* For Vim version 9.0. Last change: 2026 Feb 18
|
||||
*denote.txt* For Vim version 9.0. Last change: 2026 Feb 26
|
||||
|
||||
This is the documentation for the denote plugin.
|
||||
|
||||
==============================================================================
|
||||
CONTENTS *vim-denote* *denote*
|
||||
|
||||
1. Introduction |denote-intro|
|
||||
2. Commands |denote-commands|
|
||||
3. Settings |denote-settings|
|
||||
4. Mappings |denote-mappings|
|
||||
1. Introduction |denote-intro|
|
||||
2. Commands |denote-commands|
|
||||
3. Settings |denote-settings|
|
||||
|
||||
==============================================================================
|
||||
*denote-intro*
|
||||
*denote-intro*
|
||||
Introduction ~
|
||||
|
||||
Denote is a file-naming scheme developed by Protesilaos Stavrou and an Emacs
|
||||
@@ -37,71 +36,104 @@ prefix of a denote link. This completion also works with titles: by invoking
|
||||
omni completion after typing "denote:foo", denote links are completed for
|
||||
entries containing "foo" in the title.
|
||||
|
||||
*denote-commands*
|
||||
*denote-commands*
|
||||
Commands ~
|
||||
*:Denote*
|
||||
Populate the location list of the current window with the denote entries
|
||||
present in the current directory. This command may be supplemented with any
|
||||
number of arguments that filter the entries.
|
||||
*:DenoteDirectory*
|
||||
*:DenoteDirectory!*
|
||||
:DenoteDirectory[!] {path}
|
||||
Set the provided {path} as the denote directory that will be used by
|
||||
all following commands. The {path} argument is autocompleted. With the
|
||||
bang, the autocompletion works for all directories available on your
|
||||
system. Without the bang, only directories listed in the
|
||||
|g:denote_directories| variable are autocompleted.
|
||||
|
||||
*:DenoteTag*
|
||||
This command takes as argument a tag, and populates the location list with all
|
||||
denote entries of that are tagged accordingly. The tags are autocompleted
|
||||
(see, |c_<Tab>|).
|
||||
*:Denote*
|
||||
:Denote [{keyword ..}]
|
||||
Populate the location list of the current window with the denote
|
||||
entries present in the current directory. This command may be
|
||||
supplemented with any number of arguments that filter the entries
|
||||
according to the appearance of the keywords in the file name.
|
||||
|
||||
*:DenoteGrep*
|
||||
This command is a wrapper around |:lvimgrep| to search for a pattern in the
|
||||
denote entries. The required argument is a pattern as required by |:vimgrep|,
|
||||
i.e., /{pattern}/[g][j][f].
|
||||
*:DenoteTag*
|
||||
:DenoteTag {tag}
|
||||
This command takes as argument a tag, and populates the location list
|
||||
with all denote entries of that are tagged accordingly. The tags are
|
||||
autocompleted (see, |c_<Tab>|). Also fuzzy matching is possible when
|
||||
"fuzzy" is contained in |'wildoptions'|.
|
||||
|
||||
*:DenoteNew*
|
||||
This command takes as argument a note title, and generates a new denote entry
|
||||
with the specified title. The entry file type is controlled by the setting
|
||||
|g:denote_new_ft|.
|
||||
*:DenoteGrep*
|
||||
:DenoteGrep /{pattern}/[g][j][f]
|
||||
This command is a wrapper around |:lvimgrep| to search for a pattern
|
||||
in the denote entries. The required argument is a pattern as required
|
||||
by |:vimgrep|, i.e., /{pattern}/[g][j][f].
|
||||
|
||||
*:DenoteBackReferences*
|
||||
When called from an opened denote entry, this command populates the location
|
||||
list with all references to the current note.
|
||||
*:DenoteNew*
|
||||
:DenoteNew {title}
|
||||
This command takes as argument a note title, and generates a new
|
||||
denote entry with the specified title. The entry file type is
|
||||
controlled by the setting |g:denote_new_ft|.
|
||||
|
||||
*denote-settings*
|
||||
*:DenoteBackReferences*
|
||||
:DenoteBackReferences
|
||||
This command populates the location list with all references to the
|
||||
current note. This command can only be called from an opened denote
|
||||
note.
|
||||
|
||||
*denote-settings*
|
||||
Settings ~
|
||||
*g:denote_note_file_extension*
|
||||
With this setting you may specify the file extensions of all denote entries
|
||||
within which |:DenoteGrep| will search for the provided pattern. If left
|
||||
unspecified, it is set to the following default value:
|
||||
*g:denote_directories*
|
||||
g:denote_directories list
|
||||
With this option, may may specify a list of your denote directories.
|
||||
This list is used for the autocompletion of the |:DenoteDirectory|
|
||||
command. The default value is
|
||||
>
|
||||
g:denote_note_file_extension = ['md', 'org', 'txt']
|
||||
let g:denote_directories = []
|
||||
<
|
||||
*g:denote_loc_title_columns*
|
||||
This integer specifies the number of columns used to display the titles of
|
||||
denote entries. Per default, it is set to:
|
||||
|
||||
*g:denote_note_file_extension*
|
||||
g:denote_note_file_extension list
|
||||
With this setting, you may specify the file extensions of all denote
|
||||
entries within which |:DenoteGrep| will search, and for which files
|
||||
denote link completion and the |:DenoteBackReferences| command will be
|
||||
available. If left unspecified, it is set to the following default
|
||||
value:
|
||||
>
|
||||
g:denote_loc_title_columns = 60
|
||||
let g:denote_note_file_extension = ['md', 'org', 'txt']
|
||||
<
|
||||
*g:denote_new_ft*
|
||||
Newly created notes are of this file type. Possible values are 'md', 'org', or
|
||||
'txt', with the following default:
|
||||
|
||||
*g:denote_loc_title_columns*
|
||||
g:denote_loc_title_columns number
|
||||
This integer specifies the number of columns used to display the
|
||||
titles of denote entries. Per default, it is set to:
|
||||
>
|
||||
g:denote_new_ft = 'md'
|
||||
let g:denote_loc_title_columns = 60
|
||||
<
|
||||
*g:denote_fm_md_type*
|
||||
The front matter of 'md' notes is given as 'yaml' or as 'toml'. By default,
|
||||
this package uses 'yaml':
|
||||
|
||||
*g:denote_new_ft*
|
||||
g:denote_new_ft string
|
||||
Newly created notes are of this file type. Possible values are 'md',
|
||||
'org', or 'txt', with the following default:
|
||||
>
|
||||
g:denote_fm_md_type = 'yaml'
|
||||
let g:denote_new_ft = 'md'
|
||||
<
|
||||
*g:denote_identifier_fun*
|
||||
Denote allows the use of custom identifiers. This variable, if set, points to
|
||||
a function that generates identifiers for newly created notes. The function is
|
||||
supposed to return a unique string.
|
||||
|
||||
*denote-mappings*
|
||||
Mappings ~
|
||||
*g:denote_fm_md_type*
|
||||
g:denote_fm_md_type string
|
||||
The front matter of 'md' notes is given as 'yaml' or as 'toml'. By
|
||||
default, this package uses 'yaml':
|
||||
>
|
||||
let g:denote_fm_md_type = 'yaml'
|
||||
<
|
||||
|
||||
<Plug>DenoteList "Populate and open the location list with all
|
||||
denote entries".
|
||||
*g:denote_identifier_fun*
|
||||
g:denote_identifier_fun Funcref
|
||||
Denote allows the use of custom identifiers. This variable, if set,
|
||||
points to a function that generates identifiers for newly created
|
||||
notes. The function is supposed to return a unique string. By default,
|
||||
the identifiers are computed with
|
||||
>
|
||||
strftime('%Y%m%dT%H%M%S')
|
||||
<
|
||||
or with |rand()| if the function |strftime()| is unavailable.
|
||||
|
||||
<Plug>DenoteBackReferences "Populate and open the location list with all
|
||||
denote entries that link to the currently opened one".
|
||||
|
||||
vim:tw=78:sw=4:ts=8:noet:ft=help:norl:
|
||||
vim:tw=78:sw=4:ts=8:noet:ft=help:norl:
|
||||
|
||||
Reference in New Issue
Block a user