Changeset 5660

Timestamp:

01/28/08 04:53:01 (5 years ago)

Author:

drry

Message:

lang/ruby/vimcolor/README: documentation.

Files:

• lang/ruby/vimcolor/README (modified) (3 diffs)

lang/ruby/vimcolor/README

@@ -4 +4 @@
 A ported version of Perl's Text::VimColor to Ruby.
 
-This library tries to markup text files according to their syntax using vim.
+This library tries to markup text files according to their syntax using Vim.
 It can be used to produce web pages with pretty-printed colourful source code samples.
 
@@ -14 +14 @@
 
    require 'vimcolor'
-   
-   vc = VimColor.new
-   xml = vc.run_file("foo.rb", 
-                     {:filetype => 'ruby',      #default: auto detect
-                      :encoding => 'utf-8'},    #default: utf-8
-                     :html,                     #can be :xml, :html, :ansi, :array
-                     'syntax')  # extra option for HTML formatter(css class prefix)
+
+   vc   = VimColor.new
+   html = vc.run_file("foo.rb",
+                      {:filetype => 'ruby',     #default: auto detect
+                       :encoding => 'utf-8'},   #default: utf-8
+                      :html,                    #can be :xml, :html, :ansi, :array
+                      'syntax')  # extra option for HTML formatter(css class prefix)
+
+   xml  = vc.run_file("bar.vim",
+                      'vim',                    #filetype as String instead of Hash
+                      :xml)
 
 
@@ -40 +44 @@
 * http://search.cpan.org/~geoffr/Text-VimColor-0.11/lib/Text/VimColor.pm
 
-Svn repository (hosted by coderepos.org)
+Subversion repository (hosted by CodeRepos.org)
 
-* http://coderepos.org/share/browser/lang/ruby/vimcolor
+* http://svn.coderepos.org/share/lang/ruby/vimcolor