Permalink
Browse files

Hints about how to use txtfmt.vim with notes.vim

  • Loading branch information...
1 parent 668213c commit 51691c1876d879bed547f74b101dab05c71ff950 @xolox committed Nov 26, 2011
Showing with 24 additions and 10 deletions.
  1. +8 −3 README.md
  2. +16 −7 doc/notes.txt
View
@@ -31,7 +31,7 @@ Unzip the most recent [ZIP archive] [download] file inside your Vim profile dire
All options have reasonable defaults so if the plug-in works after installation you don't need to change any options. They're available for people who like to customize their directory layout. These options can be configured in your [vimrc script] [vimrc] by including a line like this:
- let g:notes_directory = '~/Documents/Notes'
+ :let g:notes_directory = '~/Documents/Notes'
Note that after changing an option in your [vimrc script] [vimrc] you have to restart Vim for the changes to take effect.
@@ -237,9 +237,13 @@ See the documentation of the [:highlight] [highlight] command for more informati
## 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 [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 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.
* 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!)
+ * If the text formatting supported by the notes plug-in is not enough for you, consider trying the [Txtfmt] [txtfmt] (The Vim Highlighter) plug-in. To use the two plug-ins together, create the file `after/ftplugin/notes.vim` inside your Vim profile with the following contents:
+
+ " Integration between notes.vim and txtfmt.vim.
+ :setlocal filetype=notes.txtfmt
## Contact
@@ -265,6 +269,7 @@ This software is licensed under the [MIT license] [mit].
[slate]: http://code.google.com/p/vim/source/browse/runtime/colors/slate.vim
[split]: http://vimdoc.sourceforge.net/htmldoc/windows.html#:split
[tabedit]: http://vimdoc.sourceforge.net/htmldoc/tabpage.html#:tabedit
+[txtfmt]: http://www.vim.org/scripts/script.php?script_id=2208
[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/
View
@@ -87,7 +87,7 @@ installation you don't need to change any options. They're available for
people who like to customize their directory layout. These options can be
configured in your |vimrc| script by including a line like this:
>
- let g:notes_directory = '~/Documents/Notes'
+ :let g:notes_directory = '~/Documents/Notes'
Note that after changing an option in your |vimrc| script you have to restart
Vim for the changes to take effect.
@@ -459,31 +459,39 @@ are the names of the syntax items defined by the notes syntax mode:
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
+ 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
+ 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.
- 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!)
+ - If the text formatting supported by the notes plug-in is not enough for you,
+ consider trying the Txtfmt [9] (The Vim Highlighter) plug-in. To use the
+ two plug-ins together, create the file 'after/ftplugin/notes.vim' inside
+ your Vim profile with the following contents: " Integration between
+ notes.vim and txtfmt.vim. :setlocal filetype=notes.txtfmt
+
===============================================================================
*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 [9].
+If you like the script please vote for it on Vim Online [10].
===============================================================================
*notes-license*
License ~
-This software is licensed under the MIT license [10]. Copyright 2011 Peter
+This software is licensed under the MIT license [11]. Copyright 2011 Peter
Odding <peter@peterodding.com>.
===============================================================================
@@ -498,7 +506,8 @@ References ~
[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
+[9] http://www.vim.org/scripts/script.php?script_id=2208
+[10] http://www.vim.org/scripts/script.php?script_id=3375
+[11] http://en.wikipedia.org/wiki/MIT_License
vim: ft=help

0 comments on commit 51691c1

Please sign in to comment.