cleaned
This commit is contained in:
127
doc/denote.txt
127
doc/denote.txt
@@ -1,8 +1,14 @@
|
||||
*denote.txt* Handling denote entries – the vim way
|
||||
|
||||
Last change: 2026 Feb 28
|
||||
Last change: 2026 Mar 3
|
||||
|
||||
This is the documentation for the denote plugin.
|
||||
This is the documentation for the denote package. This package also introduces
|
||||
the |libdenote| plugin in the file autoload/libdenote.vim, which may be of
|
||||
independent interest. If this package is loaded automatically, but you prefer
|
||||
to opt-out, then add this line to your vimrc:
|
||||
>
|
||||
let g:loaded_denote = 1
|
||||
<
|
||||
|
||||
==============================================================================
|
||||
CONTENTS *vim-denote* *denote*
|
||||
@@ -17,8 +23,8 @@ CONTENTS *vim-denote* *denote*
|
||||
|
||||
Appendices
|
||||
A. The libdenote plugin |libdenote|
|
||||
A.1 File-naming functions |libdentoe-filenaming|
|
||||
A.2 Front-matter functions |libdenote-frontmatter|
|
||||
A.1 File-naming functions |libdentoe-filenaming|
|
||||
A.2 Front-matter functions |libdenote-frontmatter|
|
||||
B. Package API |denote-api|
|
||||
|
||||
==============================================================================
|
||||
@@ -47,6 +53,7 @@ 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.
|
||||
|
||||
|
||||
==============================================================================
|
||||
COMMANDS *denote-commands*
|
||||
|
||||
@@ -259,7 +266,7 @@ denote-centered operations. That plugin is given by the file
|
||||
autoload/libdenote.vim. Each function in this plugin is pure, i.e., produces
|
||||
no side effects. There are two classes of functions: functions concerning the
|
||||
file-naming scheme (prefixed with scheme_, see |libdenote-filenaming|) and
|
||||
functions concerning the front matter (prefixed with fmt_, see
|
||||
functions concerning the front matter (prefixed with fm_, see
|
||||
|libdenote-frontmatter|).
|
||||
|
||||
*libdenote-filenaming*
|
||||
@@ -303,12 +310,114 @@ libdenote#fm_gen({ext}, {id}, {title}, {tags}, {md_type})
|
||||
'toml'. The former format is used per default.
|
||||
|
||||
*libdenote#fm_alter()*
|
||||
libdenote#fm_alter({fm}, {ext}, {id}, {title}, {tags}, {md_type})
|
||||
libdenote#fm_alter({fm}, {mod})
|
||||
Similar to |libdenote#fm_gen()|, this function returns a list
|
||||
containing the lines of a front matter. In contrast to the above
|
||||
function, this functions takes a front matter {fm} as base (again,
|
||||
given as list of lines), and alters the title or tags associated with
|
||||
the note. The arguments {title} and {tags} are optional. When set,
|
||||
then {fm} is returned with the corresponding replaced lines.
|
||||
given as list of lines), and updates the fields specified by the
|
||||
|dict| {mod}. If {mod} contains the key "date", then the date string
|
||||
will be updated. If {mod} contains the key "id", then the identifier
|
||||
will be updated with the value a:mod.id. Similarly, the keys "title"
|
||||
and "tags" are used to update the title and tag list of the front
|
||||
matter.
|
||||
|
||||
*libdenote#fm_len()*
|
||||
libdenote#fm_len({ext})
|
||||
This returns the number of lines of the front matter for files with
|
||||
the extension {ext}.
|
||||
|
||||
|
||||
==============================================================================
|
||||
APPENDIX B - PACKAGE API *denote-api*
|
||||
|
||||
Here, we list and briefly describe all functions that come with this package.
|
||||
The aim of providing this information is to keep vim-denote hackable.
|
||||
|
||||
*denote#commands#load()*
|
||||
denote#commands#load()
|
||||
This function initializes the user commands (see, |denote-commands|)
|
||||
that are globally available.
|
||||
|
||||
*denote#completion#tags()*
|
||||
denote#completion#tags({ArgLead}, {CmdLine}, {CursorPos})
|
||||
This is the autocompletion function for tag arguments in the user
|
||||
commands |:DenoteByTag|, |:DenoteTagAdd|, and |:DenoteTagRm|.
|
||||
|
||||
*denote#loclist#clear()*
|
||||
denote#loclist#clear()
|
||||
With this, the location list is cleared.
|
||||
|
||||
*denote#loclist*fill()*
|
||||
denote#loclist*fill({title}, {files}, {Gfun})
|
||||
This function populates the location list with denote entries. The
|
||||
{title} argument specifies the title of the location list. The {files}
|
||||
argument is a list of filenames of denote entries. Finally, the {Gfun}
|
||||
argument is a Funcref to the function that reloads the location list —
|
||||
this is the function (with all arguments set) that invoked this call
|
||||
to |denote#loclist#fill()|.
|
||||
|
||||
*denote#loclist#setgrep()*
|
||||
denote#loclist#setgrep({title}, {Gfun})
|
||||
This function makes the location list fit for showing the result of
|
||||
|:DenoteGrep|. The {title} and {Gfun} arguments are as in
|
||||
|denote#loclist#fill()|.
|
||||
|
||||
*denote#loclist#reload()*
|
||||
denote#loclist#reload()
|
||||
This function reruns the location-list generating function (see {Gfun}
|
||||
in |denote#loclist#fill()|.
|
||||
|
||||
*denote#loclist#jumptowindow()*
|
||||
denote#loclist#jumptowindow()
|
||||
With this, the cursor is moved from the location list to the window
|
||||
the location list belongs to.
|
||||
|
||||
*denote#notes#list()*
|
||||
denote#notes#list({search})
|
||||
This function searches for denote entries that contain {search} in the
|
||||
path, and displays the results in the location list. The command
|
||||
|:Denote| is bound to this function.
|
||||
|
||||
*denote#notes#bytag()*
|
||||
denote#notes#bytag({tag})
|
||||
This is similar to |denote#notes#list()|, but only entries with the
|
||||
tag {tag} are put to the location list. This is used by the command
|
||||
|:DenoteByTag|.
|
||||
|
||||
*denote#notes#grep()*
|
||||
denote#notes#grep({re})
|
||||
This is the function used by |:DenoteGrep| to search for patterns
|
||||
within the denote files.
|
||||
|
||||
*denote#notes#new()*
|
||||
denote#notes#new({title}, {ext})
|
||||
This function is used by |:DenoteNew|. Here, {title} is the title of
|
||||
the new note, and {ext} the file extension. This second argument is
|
||||
optional and has the default value |g:denote_new_ext|.
|
||||
|
||||
*denote#notes#settitle()*
|
||||
denote#notes#settitle({linenr}, {title})
|
||||
With this, the title of the entry on line {linenr} of the location
|
||||
list is set to {title}. This is used by |:DenoteSetTitle|.
|
||||
|
||||
*denote#notes#tagmod()*
|
||||
denote#notes#tagmod({line1}, {line2}, {tag}, {add})
|
||||
This function modifies the tags of the denote entries from line
|
||||
{line1} to line {line2} of the location list. In each of these
|
||||
entries, the tag {tag} is added if {add} is 1, and removed if {add} is
|
||||
0.
|
||||
|
||||
*denote#notes#copy()*
|
||||
denote#notes#copy({origfile})
|
||||
This copies the file {origfile} to the denote directory, and renames
|
||||
the copy to make it denote compatible. This function is used by
|
||||
|:DenoteCopy|.
|
||||
|
||||
*denote#notes#rm()*
|
||||
denote#notes#rm({line1}, {line2}, {bang})
|
||||
With this, the files that correspond to the entries from line {line1}
|
||||
to line {line2} of the location list are deleted. If the {bang} is set
|
||||
to 1, then no confirmation will be asked. Otherwise, the user is asked
|
||||
to confirm every deletion. This function is used by |:DenoteDelete|.
|
||||
|
||||
vim:tw=78:sw=4:ts=8:noet:ft=help:norl:
|
||||
|
||||
Reference in New Issue
Block a user