Skip to content

Commit

Permalink
Document issue #53 in the README
Browse files Browse the repository at this point in the history 
As suggested by @canpolat:
#53 (comment)
  • Loading branch information
@xolox
xolox committed Nov 1, 2015
1 parent 054dd77 commit 9b7eb4e
Show file tree
Hide file tree
Showing 3 changed files with 38 additions and 14 deletions.
11 changes: 9 additions & 2 deletions README.md
View file
Expand Up @@ -353,9 +353,9 @@ See the documentation of the [:highlight] [highlight] command for more informati

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

### shell.vim
### vim-shell

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.
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.

### VOoM

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

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.

## Troubleshooting

### Searching notes does not work

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] :-).

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


[85]: https://github.com/xolox/vim-session/issues/85
[ctrlwf]: http://vimdoc.sourceforge.net/htmldoc/windows.html#CTRL-W_f
[ctrlwgf]: http://vimdoc.sourceforge.net/htmldoc/windows.html#CTRL-W_gf
[edit]: http://vimdoc.sourceforge.net/htmldoc/editing.html#:edit
Expand Down
2 changes: 1 addition & 1 deletion autoload/xolox/notes.vim
View file
Expand Up @@ -6,7 +6,7 @@
" Note: This file is encoded in UTF-8 including a byte order mark so
" that Vim loads the script using the right encoding transparently.

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

Expand Down
39 changes: 28 additions & 11 deletions doc/notes.txt
View file
Expand Up @@ -48,13 +48,15 @@ Contents ~
6. Customizing the syntax highlighting of notes |customizing-syntax-highlighting-of-notes|
7. Other plug-ins that work well with the notes plug-in |other-plug-ins-that-work-well-with-notes-plug-in|
1. utl.vim |notes-utl.vim|
2. shell.vim |notes-shell.vim|
2. vim-shell |notes-vim-shell|
3. VOoM |notes-voom|
4. Txtfmt |notes-txtfmt|
8. Using the notes file type for git commit messages |using-notes-file-type-for-git-commit-messages|
9. Contact |notes-contact|
10. License |notes-license|
11. References |notes-references|
9. Troubleshooting |notes-troubleshooting|
1. Searching notes does not work |searching-notes-does-not-work|
10. Contact |notes-contact|
11. License |notes-license|
12. References |notes-references|

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

-------------------------------------------------------------------------------
*notes-shell.vim*
shell.vim ~
*notes-vim-shell*
vim-shell ~

My shell.vim [14] plug-in also enables easy navigation between your notes and
My vim-shell [14] 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
Expand Down Expand Up @@ -752,20 +754,34 @@ 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 [17] file in
Vim's Mercurial repository.

===============================================================================
*notes-troubleshooting*
Troubleshooting ~

-------------------------------------------------------------------------------
*searching-notes-does-not-work*
Searching notes does not work ~

There is a known problem where keyword searching of notes is broken when my
vim-shell plug-in [14] 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 [18] :-).

===============================================================================
*notes-contact*
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 [18].
If you like the script please vote for it on Vim Online [19].

===============================================================================
*notes-license*
License ~

This software is licensed under the MIT license [19]. © 2015 Peter Odding
This software is licensed under the MIT license [20]. © 2015 Peter Odding
<peter@peterodding.com>.

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

vim: ft=help

0 comments on commit 9b7eb4e

Please sign in to comment.