Skip to content

Commit 9b7eb4e

Browse files
committed
Document issue #53 in the README
As suggested by @canpolat: #53 (comment)
1 parent 054dd77 commit 9b7eb4e

File tree

3 files changed

+38
-14
lines changed

3 files changed

+38
-14
lines changed

README.md

Lines changed: 9 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -353,9 +353,9 @@ See the documentation of the [:highlight] [highlight] command for more informati
353353

354354
The [utl.vim] [utl] universal text linking plug-in enables links between your notes, other local files and remote resources like web pages.
355355

356-
### shell.vim
356+
### vim-shell
357357

358-
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 by providing key mappings and commands to e.g. open the file/URL under the text cursor. This plug-in can also change Vim to full screen which can be really nice for large notes.
358+
My [vim-shell] [shell] plug-in also enables easy navigation between your notes and environment like local files and directories, web pages and e-mail addresses by providing key mappings and commands to e.g. open the file/URL under the text cursor. This plug-in can also change Vim to full screen which can be really nice for large notes.
359359

360360
### VOoM
361361

@@ -376,6 +376,12 @@ If you write your git commit messages in Vim and want to use the notes file type
376376

377377
This is not a complete solution (there are more types of commit messages that the pattern above won't match) but that is outside the scope of this document. For inspiration you can take a look at the [runtime/filetype.vim] [filetype.vim] file in Vim's Mercurial repository.
378378

379+
## Troubleshooting
380+
381+
### Searching notes does not work
382+
383+
There is a known problem where keyword searching of notes is broken when my [vim-shell plug-in] [shell] is not installed (even though vim-shell is supposed to be an optional dependency). The easiest way to work around this is to simply install the vim-shell plug-in, if that is an option for you. Alternatively you can help me debug the problem discussed in [issue 85] [85] :-).
384+
379385
## Contact
380386

381387
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] [vim_online].
@@ -386,6 +392,7 @@ This software is licensed under the [MIT license] [mit].
386392
© 2015 Peter Odding &lt;<peter@peterodding.com>&gt;.
387393

388394

395+
[85]: https://github.com/xolox/vim-session/issues/85
389396
[ctrlwf]: http://vimdoc.sourceforge.net/htmldoc/windows.html#CTRL-W_f
390397
[ctrlwgf]: http://vimdoc.sourceforge.net/htmldoc/windows.html#CTRL-W_gf
391398
[edit]: http://vimdoc.sourceforge.net/htmldoc/editing.html#:edit

autoload/xolox/notes.vim

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@
66
" Note: This file is encoded in UTF-8 including a byte order mark so
77
" that Vim loads the script using the right encoding transparently.
88

9-
let g:xolox#notes#version = '0.33.1'
9+
let g:xolox#notes#version = '0.33.2'
1010
let g:xolox#notes#url_pattern = '\<\(mailto:\|javascript:\|\w\{3,}://\)\(\S*\w\)\+/\?'
1111
let s:scriptdir = expand('<sfile>:p:h')
1212

doc/notes.txt

Lines changed: 28 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -48,13 +48,15 @@ Contents ~
4848
6. Customizing the syntax highlighting of notes |customizing-syntax-highlighting-of-notes|
4949
7. Other plug-ins that work well with the notes plug-in |other-plug-ins-that-work-well-with-notes-plug-in|
5050
1. utl.vim |notes-utl.vim|
51-
2. shell.vim |notes-shell.vim|
51+
2. vim-shell |notes-vim-shell|
5252
3. VOoM |notes-voom|
5353
4. Txtfmt |notes-txtfmt|
5454
8. Using the notes file type for git commit messages |using-notes-file-type-for-git-commit-messages|
55-
9. Contact |notes-contact|
56-
10. License |notes-license|
57-
11. References |notes-references|
55+
9. Troubleshooting |notes-troubleshooting|
56+
1. Searching notes does not work |searching-notes-does-not-work|
57+
10. Contact |notes-contact|
58+
11. License |notes-license|
59+
12. References |notes-references|
5860

5961
===============================================================================
6062
*notes-introduction*
@@ -707,10 +709,10 @@ The utl.vim [13] universal text linking plug-in enables links between your
707709
notes, other local files and remote resources like web pages.
708710

709711
-------------------------------------------------------------------------------
710-
*notes-shell.vim*
711-
shell.vim ~
712+
*notes-vim-shell*
713+
vim-shell ~
712714

713-
My shell.vim [14] plug-in also enables easy navigation between your notes and
715+
My vim-shell [14] plug-in also enables easy navigation between your notes and
714716
environment like local files and directories, web pages and e-mail addresses by
715717
providing key mappings and commands to e.g. open the file/URL under the text
716718
cursor. This plug-in can also change Vim to full screen which can be really
@@ -752,20 +754,34 @@ the pattern above won't match) but that is outside the scope of this document.
752754
For inspiration you can take a look at the runtime/filetype.vim [17] file in
753755
Vim's Mercurial repository.
754756

757+
===============================================================================
758+
*notes-troubleshooting*
759+
Troubleshooting ~
760+
761+
-------------------------------------------------------------------------------
762+
*searching-notes-does-not-work*
763+
Searching notes does not work ~
764+
765+
There is a known problem where keyword searching of notes is broken when my
766+
vim-shell plug-in [14] is not installed (even though vim-shell is supposed to
767+
be an optional dependency). The easiest way to work around this is to simply
768+
install the vim-shell plug-in, if that is an option for you. Alternatively you
769+
can help me debug the problem discussed in issue 85 [18] :-).
770+
755771
===============================================================================
756772
*notes-contact*
757773
Contact ~
758774

759775
If you have questions, bug reports, suggestions, etc. the author can be
760776
contacted at peter@peterodding.com. The latest version is available at
761777
http://peterodding.com/code/vim/notes/ and http://github.com/xolox/vim-notes.
762-
If you like the script please vote for it on Vim Online [18].
778+
If you like the script please vote for it on Vim Online [19].
763779

764780
===============================================================================
765781
*notes-license*
766782
License ~
767783

768-
This software is licensed under the MIT license [19]. © 2015 Peter Odding
784+
This software is licensed under the MIT license [20]. © 2015 Peter Odding
769785
<peter@peterodding.com>.
770786

771787
===============================================================================
@@ -789,7 +805,8 @@ References ~
789805
[15] http://www.vim.org/scripts/script.php?script_id=2657
790806
[16] http://www.vim.org/scripts/script.php?script_id=2208
791807
[17] https://code.google.com/p/vim/source/browse/runtime/filetype.vim?r=fbc1131f0ba5be4ec74fb2ccdfb3559b446a2b1e#778
792-
[18] http://www.vim.org/scripts/script.php?script_id=3375
793-
[19] http://en.wikipedia.org/wiki/MIT_License
808+
[18] https://github.com/xolox/vim-session/issues/85
809+
[19] http://www.vim.org/scripts/script.php?script_id=3375
810+
[20] http://en.wikipedia.org/wiki/MIT_License
794811

795812
vim: ft=help

0 commit comments

Comments
 (0)