From 2303aa3c54066dd4aa50794e7d648b11e4a1edd4 Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?=C3=84min=20Baumeler?= <amin@indyfac.ch>
Date: Tue, 17 Feb 2026 18:15:52 +0100
Subject: [PATCH] help added

---
 doc/denote.txt | 82 ++++++++++++++++++++++++++++++++++++++++++++++++++
 1 file changed, 82 insertions(+)
 create mode 100644 doc/denote.txt

diff --git a/doc/denote.txt b/doc/denote.txt
new file mode 100644
index 0000000..f72b92d
--- /dev/null
+++ b/doc/denote.txt
@@ -0,0 +1,82 @@
+*denote.txt*	For Vim version 9.0.  Last change: 2026 Feb 17
+
+This is the documentation for the denote plugin.
+
+==============================================================================
+CONTENTS						*denote.vim* *denote*
+
+1. Introduction		|denote-intro|
+2. Commands				|denote-commands|
+3. Settings				|denote-settings|
+4. Mappings				|denote-mappings|
+
+==============================================================================
+							*denote-intro*
+Introduction ~
+
+Denote is a file-naming scheme developed by Protesilaos Stavrou and an Emacs
+tool for handling such files. Notes and other files that follow this scheme
+can be linked, and the links are preserved even when the files are renamed due
+do adjusting the tags or changing the title of a note. The official manual is
+available online:
+	https://protesilaos.com/emacs/denote
+
+The denote plugin adds denote-functionality to vim --- the vim way. We are
+aware of two other plugins, but we fear that these plugins are not flexible
+enough, and more importantly, do not follow the vim philosophy for handling
+denote notes. These mentioned plugins are available here:
+	https://github.com/shuckster/denote-md
+	https://git.sr.ht/~ashton314/vim-denote
+
+In contrast to these plugins, the present package relies on the
+|location-list| features for displaying denote entries, and on and
+|'includeexpr'| option for following the links (see, |gf|). This plugin also
+provides custom location-list formatting using the option
+|'quickfixtextfunc'|.
+
+							*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.
+
+					*: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>|).
+
+					*: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].
+
+					*:DenoteBackReferences*
+When called from an opened denote entry, this command populates the location
+list with all references to the current 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_note_file_extension = ['md', 'org']
+<
+					*'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_loc_title_columns = 60
+<
+							*denote-mappings*
+Mappings ~
+
+<Plug>DenoteList			"Populate and open the location list with all denote
+entries".
+
+<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: