Skip to content
This repository
Browse code

Document vim-misc as external dependency

  • Loading branch information...
commit 061c03082e286390b516b9c38635938763d277c0 1 parent af22fad
Peter Odding authored May 25, 2013
1  .gitignore
... ...
@@ -1,4 +1,5 @@
1 1
 doc/tags
2 2
 misc/notes/index.pickle
  3
+misc/notes/recent.txt
3 4
 misc/notes/tags.txt
4 5
 misc/notes/user/
18  README.md
Source Rendered
... ...
@@ -1,6 +1,6 @@
1 1
 # Easy note taking in Vim
2 2
 
3  
-The notes.vim plug-in for the [Vim text editor] [vim] makes it easy to manage your notes in Vim:
  3
+The vim-notes plug-in for the [Vim text editor] [vim] makes it easy to manage your notes in Vim:
4 4
 
5 5
  * **Starting a new note:** Execute the `:Note` command to create a new buffer and load the appropriate file type and syntax
6 6
    * You can also start a note with Vim commands like `:edit`, `:tabedit` and `:split` by starting the filename with `note:`, as in `:edit note:todo` (the part after `note:` doesn't have to be the complete note title and if it's empty a new note will be created)
@@ -19,13 +19,17 @@ The notes.vim plug-in for the [Vim text editor] [vim] makes it easy to manage yo
19 19
  * **Writing aids:** The included file type plug-in contains mappings for automatic curly quotes, arrows and list bullets and supports completion of note titles using Control-X Control-U and completion of tags using Control-X Control-O
20 20
  * **Embedded file types:** The included syntax script supports embedded highlighting using blocks marked with `{{{type … }}}` which allows you to embed highlighted code and configuration snippets in your notes
21 21
 
22  
-Here's a screen shot of the syntax mode using the [slate] [slate] color scheme:
  22
+Here's a screen shot of the syntax mode using the [Slate] [slate] color scheme and the font [Monaco] [monaco]:
23 23
 
24 24
 ![Syntax mode screen shot](http://peterodding.com/code/vim/notes/syntax.png)
25 25
 
26 26
 ## Install & usage
27 27
 
28  
-Unzip the most recent [ZIP archive] [download] file inside your Vim profile directory (usually this is `~/.vim` on UNIX and `%USERPROFILE%\vimfiles` on Windows), restart Vim and execute the command `:helptags ~/.vim/doc` (use `:helptags ~\vimfiles\doc` instead on Windows). To get started execute `:Note` or `:edit note:`, this will start a new note that contains instructions on how to continue from there (and how to use the plug-in in general).
  28
+*Please note that the vim-notes plug-in requires my vim-misc plug-in which is separately distributed.*
  29
+
  30
+Unzip the most recent ZIP archives of the [vim-notes] [download-notes] and [vim-misc] [download-misc] plug-ins inside your Vim profile directory (usually this is `~/.vim` on UNIX and `%USERPROFILE%\vimfiles` on Windows), restart Vim and execute the command `:helptags ~/.vim/doc` (use `:helptags ~\vimfiles\doc` instead on Windows). To get started execute `:Note` or `:edit note:`, this will start a new note that contains instructions on how to continue from there (and how to use the plug-in in general).
  31
+
  32
+If you prefer you can also use [Pathogen] [pathogen], [Vundle] [vundle] or a similar tool to install & update the [vim-notes] [github-notes] and [vim-misc] [github-misc] plug-ins using a local clone of the git repository.
29 33
 
30 34
 ## Options
31 35
 
@@ -302,14 +306,19 @@ This software is licensed under the [MIT license] [mit].
302 306
 
303 307
 [ctrlwf]: http://vimdoc.sourceforge.net/htmldoc/windows.html#CTRL-W_f
304 308
 [ctrlwgf]: http://vimdoc.sourceforge.net/htmldoc/windows.html#CTRL-W_gf
305  
-[download]: http://peterodding.com/code/vim/downloads/notes.zip
  309
+[download-misc]: http://peterodding.com/code/vim/downloads/misc.zip
  310
+[download-notes]: http://peterodding.com/code/vim/downloads/notes.zip
306 311
 [edit]: http://vimdoc.sourceforge.net/htmldoc/editing.html#:edit
307 312
 [gf]: http://vimdoc.sourceforge.net/htmldoc/editing.html#gf
  313
+[github-misc]: http://github.com/xolox/vim-misc
  314
+[github-notes]: http://github.com/xolox/vim-notes
308 315
 [highlight]: http://vimdoc.sourceforge.net/htmldoc/syntax.html#:highlight
309 316
 [levenshtein]: http://en.wikipedia.org/wiki/Levenshtein_distance
310 317
 [mapleader]: http://vimdoc.sourceforge.net/htmldoc/map.html#mapleader
311 318
 [mit]: http://en.wikipedia.org/wiki/MIT_License
312 319
 [modeline]: http://vimdoc.sourceforge.net/htmldoc/options.html#modeline
  320
+[monaco]: http://en.wikipedia.org/wiki/Monaco_(typeface)
  321
+[pathogen]: http://www.vim.org/scripts/script.php?script_id=2332
313 322
 [pathogen]: http://www.vim.org/scripts/script.php?script_id=2332
314 323
 [python]: http://python.org/
315 324
 [shell]: http://www.vim.org/scripts/script.php?script_id=3123
@@ -324,4 +333,5 @@ This software is licensed under the [MIT license] [mit].
324 333
 [vimgrep]: http://vimdoc.sourceforge.net/htmldoc/quickfix.html#:vimgrep
325 334
 [vimrc]: http://vimdoc.sourceforge.net/htmldoc/starting.html#vimrc
326 335
 [voom]: http://www.vim.org/scripts/script.php?script_id=2657
  336
+[vundle]: https://github.com/gmarik/vundle
327 337
 [write]: http://vimdoc.sourceforge.net/htmldoc/editing.html#:write
64  doc/notes.txt
@@ -49,7 +49,7 @@ Contents ~
49 49
                                                             *notes-introduction*
50 50
 Introduction ~
51 51
 
52  
-The notes.vim plug-in for the Vim text editor makes it easy to manage your
  52
+The vim-notes plug-in for the Vim text editor makes it easy to manage your
53 53
 notes in Vim:
54 54
 
55 55
  - Starting a new note: Execute the |:Note| command to create a new buffer and
@@ -112,20 +112,29 @@ notes in Vim:
112 112
    highlighting using blocks marked with '{{{type … }}}' which allows you to
113 113
    embed highlighted code and configuration snippets in your notes
114 114
 
115  
-Here's a screen shot of the syntax mode using the slate [3] color scheme:
  115
+Here's a screen shot of the syntax mode using the Slate [3] color scheme and
  116
+the font Monaco [4]:
116 117
 
117  
-    Syntax mode screen shot, see reference [4]
  118
+    Syntax mode screen shot, see reference [5]
118 119
 
119 120
 ===============================================================================
120 121
                                                            *notes-install-usage*
121 122
 Install & usage ~
122 123
 
123  
-Unzip the most recent ZIP archive [5] file inside your Vim profile directory
124  
-(usually this is '~/.vim' on UNIX and '%USERPROFILE%\vimfiles' on Windows),
125  
-restart Vim and execute the command ':helptags ~/.vim/doc' (use ':helptags
126  
-~\vimfiles\doc' instead on Windows). To get started execute |:Note| or ':edit
127  
-note:', this will start a new note that contains instructions on how to
128  
-continue from there (and how to use the plug-in in general).
  124
+Please note that the vim-notes plug-in requires my vim-misc plug-in which is
  125
+separately distributed.
  126
+
  127
+Unzip the most recent ZIP archives of the vim-notes [6] and vim-misc [7]
  128
+plug-ins inside your Vim profile directory (usually this is '~/.vim' on UNIX
  129
+and '%USERPROFILE%\vimfiles' on Windows), restart Vim and execute the command
  130
+':helptags ~/.vim/doc' (use ':helptags ~\vimfiles\doc' instead on Windows). To
  131
+get started execute |:Note| or ':edit note:', this will start a new note that
  132
+contains instructions on how to continue from there (and how to use the
  133
+plug-in in general).
  134
+
  135
+If you prefer you can also use Pathogen [8], Vundle [9] or a similar tool to
  136
+install & update the vim-notes [10] and vim-misc [11] plug-ins using a local
  137
+clone of the git repository.
129 138
 
130 139
 ===============================================================================
131 140
                                                                  *notes-options*
@@ -151,7 +160,7 @@ on circumstances but should work for most people:
151 160
 
152 161
  - If the profile directory where the plug-in is installed is writable, the
153 162
    directory 'misc/notes/user' under the profile directory is used. This is
154  
-   for compatibility with Pathogen [6]; the notes will be stored inside the
  163
+   for compatibility with Pathogen [8]; the notes will be stored inside the
155 164
    plug-in's bundle.
156 165
 
157 166
  - If the above doesn't work out, the default depends on the platform:
@@ -582,14 +591,14 @@ Other plug-ins that work well with the notes plug-in ~
582 591
                                                                  *notes-utl.vim*
583 592
 utl.vim ~
584 593
 
585  
-The utl.vim [7] universal text linking plug-in enables links between your
  594
+The utl.vim [12] universal text linking plug-in enables links between your
586 595
 notes, other local files and remote resources like web pages.
587 596
 
588 597
 -------------------------------------------------------------------------------
589 598
                                                                *notes-shell.vim*
590 599
 shell.vim ~
591 600
 
592  
-My shell.vim [8] plug-in also enables easy navigation between your notes and
  601
+My shell.vim [13] plug-in also enables easy navigation between your notes and
593 602
 environment like local files and directories, web pages and e-mail addresses
594 603
 by providing key mappings and commands to e.g. open the file/URL under the
595 604
 text cursor. This plug-in can also change Vim to full screen which can be
@@ -599,7 +608,7 @@ really nice for large notes.
599 608
                                                                     *notes-voom*
600 609
 VOoM ~
601 610
 
602  
-The VOoM [9] outlining plug-in should work well for notes if you use the
  611
+The VOoM [14] outlining plug-in should work well for notes if you use the
603 612
 Markdown style headers starting with '#', however it has been reported that
604 613
 this combination may not always work so well in practice (sometimes losing
605 614
 notes!)
@@ -609,7 +618,7 @@ notes!)
609 618
 Txtfmt ~
610 619
 
611 620
 If the text formatting supported by the notes plug-in is not enough for you,
612  
-consider trying the Txtfmt [10] (The Vim Highlighter) plug-in. To use the two
  621
+consider trying the Txtfmt [15] (The Vim Highlighter) plug-in. To use the two
613 622
 plug-ins together, create the file 'after/ftplugin/notes.vim' inside your Vim
614 623
 profile with the following contents:
615 624
 >
@@ -623,13 +632,13 @@ Contact ~
623 632
 If you have questions, bug reports, suggestions, etc. the author can be
624 633
 contacted at peter@peterodding.com. The latest version is available at
625 634
 http://peterodding.com/code/vim/notes/ and http://github.com/xolox/vim-notes.
626  
-If you like the script please vote for it on Vim Online [11].
  635
+If you like the script please vote for it on Vim Online [16].
627 636
 
628 637
 ===============================================================================
629 638
                                                                  *notes-license*
630 639
 License ~
631 640
 
632  
-This software is licensed under the MIT license [12]. Copyright 2013 Peter
  641
+This software is licensed under the MIT license [17]. Copyright 2013 Peter
633 642
 Odding <peter@peterodding.com>.
634 643
 
635 644
 ===============================================================================
@@ -639,14 +648,19 @@ References ~
639 648
 [1] http://en.wikipedia.org/wiki/Levenshtein_distance
640 649
 [2] http://python.org/
641 650
 [3] http://code.google.com/p/vim/source/browse/runtime/colors/slate.vim
642  
-[4] http://peterodding.com/code/vim/notes/syntax.png
643  
-[5] http://peterodding.com/code/vim/downloads/notes.zip
644  
-[6] http://www.vim.org/scripts/script.php?script_id=2332
645  
-[7] http://www.vim.org/scripts/script.php?script_id=293
646  
-[8] http://www.vim.org/scripts/script.php?script_id=3123
647  
-[9] http://www.vim.org/scripts/script.php?script_id=2657
648  
-[10] http://www.vim.org/scripts/script.php?script_id=2208
649  
-[11] http://www.vim.org/scripts/script.php?script_id=3375
650  
-[12] http://en.wikipedia.org/wiki/MIT_License
  651
+[4] http://en.wikipedia.org/wiki/Monaco_(typeface)
  652
+[5] http://peterodding.com/code/vim/notes/syntax.png
  653
+[6] http://peterodding.com/code/vim/downloads/notes.zip
  654
+[7] http://peterodding.com/code/vim/downloads/misc.zip
  655
+[8] http://www.vim.org/scripts/script.php?script_id=2332
  656
+[9] https://github.com/gmarik/vundle
  657
+[10] http://github.com/xolox/vim-notes
  658
+[11] http://github.com/xolox/vim-misc
  659
+[12] http://www.vim.org/scripts/script.php?script_id=293
  660
+[13] http://www.vim.org/scripts/script.php?script_id=3123
  661
+[14] http://www.vim.org/scripts/script.php?script_id=2657
  662
+[15] http://www.vim.org/scripts/script.php?script_id=2208
  663
+[16] http://www.vim.org/scripts/script.php?script_id=3375
  664
+[17] http://en.wikipedia.org/wiki/MIT_License
651 665
 
652 666
 vim: ft=help

0 notes on commit 061c030

Please sign in to comment.
Something went wrong with that request. Please try again.