Bug fixes for lcs.diff2html; xml.writer
[factor/jcg.git] / basis / editors / vim / vim-docs.factor
blob7f527bf18f2544dc621101b52dd993acf3cac461
1 USING: definitions editors help help.markup help.syntax io io.files
2     io.pathnames words ;
3 IN: editors.vim
5 ARTICLE: { "vim" "vim" } "Vim support"
6 "This module makes the " { $link edit } " word work with Vim by setting the " { $link edit-hook } " global variable to call " { $link vim-location } ". The " { $link vim-path } " variable contains the name of the vim executable.  The default " { $link vim-path } " is " { $snippet "\"gvim\"" } "."
7 $nl
8 "If you intend to use this module regularly, it helps to have it load during stage 2 bootstrap. On Windows, place the following example " { $snippet ".factor-boot-rc" } " in the directory returned by " { $link home } ":"
9 { $code
10 "USING: modules namespaces ;"
11 "REQUIRES: libs/vim ;"
12 "USE: vim"
13 "\"c:\\\\program files\\\\vim\\\\vim70\\\\gvim\" vim-path set-global"
15 "On Unix, you may omit the last line if " { $snippet "\"vim\"" } " is in your " { $snippet "$PATH" } "." 
16 $nl
17 "You may also wish to install Vim support files to enable syntax hilighting and other features. These are in the " { $link resource-path } " in " { $snippet "misc/vim" } "." ;