From 16093e847f8a20836ff5cc7336e9e07f7e1dc6b0 Mon Sep 17 00:00:00 2001 From: Peter Odding Date: Sat, 9 Jul 2011 16:05:40 +0200 Subject: [PATCH] README updates * g:notes_tagsindex option * other plug-ins that work well with notes.vim --- README.md | 37 +++++++++++++++++++++++++------------ doc/notes.txt | 40 +++++++++++++++++++++++++++++++++------- 2 files changed, 58 insertions(+), 19 deletions(-) diff --git a/README.md b/README.md index 5bef5d9..d76bdbe 100644 --- a/README.md +++ b/README.md @@ -46,11 +46,15 @@ The notes plug-in comes with some default notes containing documentation about t ### The `g:notes_indexfile` option -This option defines the pathname of the optional keyword index used by the plug-in to perform accelerated keyword searching. +This option defines the pathname of the optional keyword index used by the `:SearchNotes` to perform accelerated keyword searching. ### The `g:notes_indexscript` option -This option defines the pathname of the Python script that's used to perform accelerated keyword searching. +This option defines the pathname of the Python script that's used to perform accelerated keyword searching with `:SearchNotes`. + +### The `g:notes_tagsindex` option + +This option defined the pathname of the text file that stores the list of known tags used for tag name completion. The text file is created automatically when you first use tag name completion, after that you can update it manually by executing `:IndexTaggedNotes` (see below). ## Commands @@ -129,6 +133,12 @@ This command makes it easy to find all notes related to the current file: If you If you execute the `:RecentNotes` command it will open a Vim buffer that lists all your notes grouped by the day they were edited, starting with your most recently edited note. If you pass an argument to `:RecentNotes` it will filter the list of notes by matching the title of each note against the argument which is interpreted as a Vim pattern. +## Other plug-ins that work well with the notes plug-in + + * The [utl.vim] [utl] universal text linking plug-in enables links between your notes, other local files and remote resources like web pages + * My [shell.vim] [shell] plug-in also enables easy navigation between your notes and environment like local files and directories, web pages and e-mail addresses + * The [VOoM] [voom] outlining plug-in should work well for notes if you use the Markdown style headers starting with `#`, however it has been reported that this combination may not always work so well in practice (sometimes losing notes!) + ## Contact If you have questions, bug reports, suggestions, etc. the author can be contacted at . The latest version is available at and . If you like the script please vote for it on [Vim Online] [vim_online]. @@ -138,18 +148,21 @@ If you have questions, bug reports, suggestions, etc. the author can be contacte This software is licensed under the [MIT license] [mit]. © 2011 Peter Odding <>. -[vim]: http://www.vim.org/ -[write]: http://vimdoc.sourceforge.net/htmldoc/editing.html#:write -[update]: http://vimdoc.sourceforge.net/htmldoc/editing.html#:update -[python]: http://python.org/ -[sqlite]: http://sqlite.org/ -[gf]: http://vimdoc.sourceforge.net/htmldoc/editing.html#gf -[slate]: http://code.google.com/p/vim/source/browse/runtime/colors/slate.vim [download]: http://peterodding.com/code/vim/downloads/notes.zip -[vimrc]: http://vimdoc.sourceforge.net/htmldoc/starting.html#vimrc [edit]: http://vimdoc.sourceforge.net/htmldoc/editing.html#:edit +[gf]: http://vimdoc.sourceforge.net/htmldoc/editing.html#gf +[mit]: http://en.wikipedia.org/wiki/MIT_License +[python]: http://python.org/ +[shell]: http://www.vim.org/scripts/script.php?script_id=3123 +[slate]: http://code.google.com/p/vim/source/browse/runtime/colors/slate.vim [split]: http://vimdoc.sourceforge.net/htmldoc/windows.html#:split +[sqlite]: http://sqlite.org/ [tabedit]: http://vimdoc.sourceforge.net/htmldoc/tabpage.html#:tabedit -[vimgrep]: http://vimdoc.sourceforge.net/htmldoc/quickfix.html#:vimgrep +[update]: http://vimdoc.sourceforge.net/htmldoc/editing.html#:update +[utl]: http://www.vim.org/scripts/script.php?script_id=293 +[vim]: http://www.vim.org/ [vim_online]: http://www.vim.org/scripts/script.php?script_id=3375 -[mit]: http://en.wikipedia.org/wiki/MIT_License +[vimgrep]: http://vimdoc.sourceforge.net/htmldoc/quickfix.html#:vimgrep +[vimrc]: http://vimdoc.sourceforge.net/htmldoc/starting.html#vimrc +[voom]: http://www.vim.org/scripts/script.php?script_id=2657 +[write]: http://vimdoc.sourceforge.net/htmldoc/editing.html#:write diff --git a/doc/notes.txt b/doc/notes.txt index 194210c..547302f 100644 --- a/doc/notes.txt +++ b/doc/notes.txt @@ -104,13 +104,21 @@ notes. The *g:notes_indexfile* option This option defines the pathname of the optional keyword index used by the -plug-in to perform accelerated keyword searching. +|:SearchNotes| to perform accelerated keyword searching. ------------------------------------------------------------------------------- The *g:notes_indexscript* option This option defines the pathname of the Python script that's used to perform -accelerated keyword searching. +accelerated keyword searching with |:SearchNotes|. + +------------------------------------------------------------------------------- +The *g:notes_tagsindex* option + +This option defined the pathname of the text file that stores the list of +known tags used for tag name completion. The text file is created +automatically when you first use tag name completion, after that you can +update it manually by executing |:IndexTaggedNotes| (see below). =============================================================================== *notes-commands* @@ -170,7 +178,7 @@ start omni completion. The completion menu is populated from a text file listing all your tags, one on each line. The first time omni completion triggers, an index of tag names -is generated and saved to the location set by 'g:notes_tagsindex'. To update +is generated and saved to the location set by |g:notes_tagsindex|. To update this tags index you need to execute the |:IndexTaggedNotes| command. If you execute this command with a bang as in ':IndexTaggedNotes!' it wil open @@ -245,6 +253,21 @@ recently edited note. If you pass an argument to |:RecentNotes| it will filter the list of notes by matching the title of each note against the argument which is interpreted as a Vim pattern. +=============================================================================== +Other plug-ins that work well with the notes plug-in ~ + + - The utl.vim [6] universal text linking plug-in enables links between your + notes, other local files and remote resources like web pages + + - My shell.vim [7] plug-in also enables easy navigation between your notes and + environment like local files and directories, web pages and e-mail + addresses + + - The VOoM [8] outlining plug-in should work well for notes if you use the + Markdown style headers starting with '#', however it has been reported that + this combination may not always work so well in practice (sometimes losing + notes!) + =============================================================================== *notes-contact* Contact ~ @@ -252,13 +275,13 @@ Contact ~ If you have questions, bug reports, suggestions, etc. the author can be contacted at peter@peterodding.com. The latest version is available at http://peterodding.com/code/vim/notes/ and http://github.com/xolox/vim-notes. -If you like the script please vote for it on Vim Online [6]. +If you like the script please vote for it on Vim Online [9]. =============================================================================== *notes-license* License ~ -This software is licensed under the MIT license [7]. Copyright 2011 Peter +This software is licensed under the MIT license [10]. Copyright 2011 Peter Odding . =============================================================================== @@ -270,7 +293,10 @@ References ~ [3] http://code.google.com/p/vim/source/browse/runtime/colors/slate.vim [4] http://peterodding.com/code/vim/notes/syntax.png [5] http://peterodding.com/code/vim/downloads/notes.zip -[6] http://www.vim.org/scripts/script.php?script_id=3375 -[7] http://en.wikipedia.org/wiki/MIT_License +[6] http://www.vim.org/scripts/script.php?script_id=293 +[7] http://www.vim.org/scripts/script.php?script_id=3123 +[8] http://www.vim.org/scripts/script.php?script_id=2657 +[9] http://www.vim.org/scripts/script.php?script_id=3375 +[10] http://en.wikipedia.org/wiki/MIT_License vim: ft=help