documentation: updated to current version
This commit is contained in:
27
README.md
27
README.md
@@ -70,10 +70,27 @@ references to that note.
|
||||
[pattern](https://vimhelp.org/quickfix.txt.html#%3Avimgrep).
|
||||
|
||||
_Adding notes:_ Run `:DenoteNew {title}` to add a new note with the given
|
||||
title.
|
||||
title. You may also copy a file (any file) to your denote directory. To do so,
|
||||
run `:DenoteCopy {file}`.
|
||||
|
||||
_Managing entries:_ You can change the title of denote entries using
|
||||
`:DenoteSetTitle {newtitle}`. Also, you can add and remove tags using
|
||||
`:DenoteTagAdd {tag}` and `:DenoteTagRm {tag}`, respectively. These latter two
|
||||
commands offer auto completion for the tags. Also, they accept line ranges that
|
||||
may be given via, e.g., visual selection. Finally, denote entries are deleted
|
||||
using `:DenoteDelete`. This command again accepts line ranges.
|
||||
|
||||
[^1]: Run `:help g:denote_directories` for more information.
|
||||
|
||||
### Basic keys
|
||||
The denote location-list window comes with a set of keys:
|
||||
- `q`: close the list
|
||||
- `r`: reload the list
|
||||
- `C`: rename the selected entry
|
||||
- `+`: add a tag to the entry (also in visual mode)
|
||||
- `-`: remove a tag from the entry (also in visual mode)
|
||||
- `dd`: delete the selected entry (also in visual mode, using a single `d`)
|
||||
|
||||
### Example setup
|
||||
You get a possibly useful setup with a single default denote directory at
|
||||
`~/Documents/notes/` by placing these lines in your vimrc file:
|
||||
@@ -91,14 +108,12 @@ using the `<Leader>d` key, move forwards and backwards in the list using the
|
||||
`<Leader>D` key (again, you can jump around the references using `[l` and
|
||||
`]l`).
|
||||
|
||||
|
||||
### Customization
|
||||
You can customize the behavior of this package using several
|
||||
global variables. Customization is explained in the [help
|
||||
file](doc/denote.txt), also accessible through `:help denote-settings`.
|
||||
|
||||
### Future features These features are planned:
|
||||
- Tag manipulation
|
||||
- Title manipulation
|
||||
### Future features
|
||||
- Signature handling?
|
||||
- Note deletion?
|
||||
- Subdirectories
|
||||
- Denote query links
|
||||
|
||||
Reference in New Issue
Block a user