Option to highlight note names on word boundaries (pull request #67)

Author: xolox

README.md

@@ -65,6 +65,12 @@ When you rename a file in your notes directory but don't change the title, the p
 
 If you set this option to the string `'no'` this feature will be completely disabled. If you set it to `'change_title'` it will automatically change the title to match the filename. If you set it to `'rename_file'` it will automatically rename the file on disk to match the title.
 
+### The `g:notes_word_boundaries` option
+
+Old versions of the notes plug-in would highlight note titles without considering word boundaries. This is still the default behavior but the plug-in can now be told to respect word boundaries by changing this option from its default:
+
+    :let g:notes_word_boundaries = 1
+
 ### The `g:notes_smart_quotes` option
 
 By default the notes plug-in automatically performs several substitutions on the text you type in insert mode, for example regular quote marks are replaced with curly quotes. The full list of substitutions can be found below in the documentation on mappings. If you don't want the plug-in to perform these substitutions, you can set this option to zero like this:
@@ -323,8 +329,8 @@ If you have questions, bug reports, suggestions, etc. the author can be contacte
 
 ## License
 
-This software is licensed under the [MIT license] [mit].  
-© 2013 Peter Odding &lt;<peter@peterodding.com>&gt;.
+This software is licensed under the [MIT license] [mit].
+© 2014 Peter Odding &lt;<peter@peterodding.com>&gt;.
 
 
 [ctrlwf]: http://vimdoc.sourceforge.net/htmldoc/windows.html#CTRL-W_f

autoload/xolox/notes.vim

@@ -1,12 +1,12 @@
 " Vim auto-load script
 " Author: Peter Odding <peter@peterodding.com>
-" Last Change: September 2, 2013
+" Last Change: June 16, 2014
 " URL: http://peterodding.com/code/vim/notes/
 
 " 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.23.4'
+let g:xolox#notes#version = '0.23.5'
 let g:xolox#notes#url_pattern = '\<\(mailto:\|javascript:\|\w\{3,}://\)\(\S*\w\)\+/\?'
 let s:scriptdir = expand('<sfile>:p:h')
 
@@ -96,6 +96,10 @@ function! xolox#notes#init() " {{{1
       let g:notes_list_bullets = g:notes_ascii_bullets
     endif
   endif
+  " Should note titles only match (be highlighted) on word boundaries?
+  if !exists('g:notes_word_boundaries')
+    let g:notes_word_boundaries = 0
+  endif
 endfunction
 
 function! s:create_notes_directories()
@@ -1067,7 +1071,11 @@ function! xolox#notes#highlight_names(force) " {{{3
     if hlexists('notesName')
       syntax clear notesName
     endif
-    execute 'syntax match notesName /\c\%>1l\%(' . escape(join(titles, '\|'), '/') . '\)/'
+    let pattern = '\%(' . escape(join(titles, '\|'), '/') . '\)'
+    if g:notes_word_boundaries
+      let pattern = '\<' . pattern . '\>'
+    endif
+    execute 'syntax match notesName /\c\%>1l' . pattern . '/'
     let b:notes_names_last_highlighted = localtime()
     call xolox#misc#timer#stop("notes.vim %s: Highlighted note names in %s.", g:xolox#notes#version, starttime)
   endif

doc/notes.txt

@@ -10,16 +10,17 @@ Contents ~
    1. Backwards compatibility                   |notes-backwards-compatibility|
   2. The |g:notes_suffix| option
   3. The |g:notes_title_sync| option
-  4. The |g:notes_smart_quotes| option
-  5. The |g:notes_ruler_text| option
-  6. The |g:notes_list_bullets| option
-  7. The |g:notes_tab_indents| option
-  8. The |g:notes_alt_indents| option
-  9. The |g:notes_shadowdir| option
-  10. The |g:notes_indexfile| option
-  11. The |g:notes_indexscript| option
-  12. The |g:notes_tagsindex| option
-  13. The |g:notes_markdown_program| option
+  4. The |g:notes_word_boundaries| option
+  5. The |g:notes_smart_quotes| option
+  6. The |g:notes_ruler_text| option
+  7. The |g:notes_list_bullets| option
+  8. The |g:notes_tab_indents| option
+  9. The |g:notes_alt_indents| option
+  10. The |g:notes_shadowdir| option
+  11. The |g:notes_indexfile| option
+  12. The |g:notes_indexscript| option
+  13. The |g:notes_tagsindex| option
+  14. The |g:notes_markdown_program| option
  4. Commands                                                   |notes-commands|
   1. The |:Note| command
   2. The |:NoteFromSelectedText| command
@@ -213,6 +214,16 @@ disabled. If you set it to "'change_title'" it will automatically change the
 title to match the filename. If you set it to "'rename_file'" it will
 automatically rename the file on disk to match the title.
 
+-------------------------------------------------------------------------------
+The *g:notes_word_boundaries* option
+
+Old versions of the notes plug-in would highlight note titles without
+considering word boundaries. This is still the default behavior but the plug-in
+can now be told to respect word boundaries by changing this option from its
+default:
+>
+  :let g:notes_word_boundaries = 1
+<
 -------------------------------------------------------------------------------
 The *g:notes_smart_quotes* option
 
@@ -648,7 +659,7 @@ If you like the script please vote for it on Vim Online [17].
                                                                 *notes-license*
 License ~
 
-This software is licensed under the MIT license [18]. © 2013 Peter Odding
+This software is licensed under the MIT license [18]. © 2014 Peter Odding
 <peter@peterodding.com>.
 
 ===============================================================================