Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with
or
.
Download ZIP
Browse files

update documentation for next release

  • Loading branch information...
commit 63dda360d6e9a134c1bbef45cd053646617b0efd 1 parent 688fb20
@dkearns dkearns authored
View
3  ChangeLog
@@ -1,5 +1,8 @@
2006-07-11 Doug Kearns <djkea2@gus.gscit.monash.edu.au>
+ * FAQ, INSTALL, NEWS, README, doc/ft-ruby-syntax.txt: update
+ documentation for next release
+
* ftplugin/ruby.vim: only set 'omnifunc' if Vim has been compiled with
the Ruby interface
View
7 FAQ
@@ -52,8 +52,8 @@ Again, see installation instructions below.
If you obtained the vim-ruby files via RubyGems, run: >
- vim-ruby-install.rb
-
+ vim-ruby-install.rb
+
If you downloaded a tarball, unpack it, change to the created directory, and
run: >
@@ -71,6 +71,7 @@ Here is an example installation transcript:
2) E:/Vim/vimfiles ~
~
Please select one (or anything else to specify another directory): 2 ~
+ autoload/rubycomplete.vim -> E:/Vim/vimfiles/autoload/rubycomplete.vim ~
compiler/eruby.vim -> E:/Vim/vimfiles/compiler/eruby.vim ~
compiler/ruby.vim -> E:/Vim/vimfiles/compiler/ruby.vim ~
compiler/rubyunit.vim -> E:/Vim/vimfiles/compiler/rubyunit.vim ~
@@ -209,7 +210,7 @@ Yes: vim-ruby-devel@rubyforge.org. Only subscribers can post. To join, visit:
http://rubyforge.org/mailman/listinfo/vim-ruby-devel
The list is mirrored at: >
-
+
http://news.gmane.org/gmane.comp.editors.vim.vim%2druby.devel
View
43 INSTALL
@@ -1,16 +1,17 @@
-= Installing Vim-Ruby
+= Installing vim-ruby
-The Vim-Ruby runtime files may be installed via the vim-ruby gem or by
+The vim-ruby runtime files may be installed via the vim-ruby gem or by
downloading an archive file from http://rubyforge.org/frs/?group_id=16
NOTE: the installer vim-ruby-install.rb currently only supports Unix and
Windows systems; other platforms may require a manual install. This installer
is new and users with significant local modifications to their vim-ruby files
-are encouraged to make a manual backup of each prior to installation.
+are encouraged to make a manual backup prior to installation.
== Prerequisites
-1. Vim 6.x (6.3 recommended)
+1. Vim 6.x (7.0 recommended; 7.0 compiled with the Ruby interface is required
+ for omni completion)
http://www.vim.org/
2. Ruby 1.8.x
@@ -41,26 +42,40 @@ Windows
C:\tmp> [unzip] vim-ruby.YYYY.MM.DD.tgz
C:\tmp> ruby vim-ruby.YYY.MM.DD\bin\vim-ruby-install.rb
-=== Manual Installation
+== Manual Installation
Alternatively, you can simply copy the desired files to an appropriate
directory in your runtime path. For single user use this would typically be
$HOME/.vim on Unix systems and $HOME/vimfiles on Windows and for system-wide
use these would be installed in $VIM/vimfiles.
-== Vim versions < 6.3
+== Vim Version Dependencies
-For versions of Vim less than 6.3 the supplied ftdetect/ruby.vim file, used for
-filetype detection, will be ignored. In order for the filetype detection to
-operate correctly the autocommands specified in ftdetect/ruby.vim need to be
-executed. See :help new-filetype, in Vim, for a mechanism to achieve this
-which is appropriate for your version of Vim.
+Some features of the vim-ruby package depend on specific versions and features
+of Vim, as follows.
-Again, we recommend you use the latest version of Vim at all times, where
-possible.
+=== Versions >= 7.0 compiled without the Ruby interface
+
+The omni completion script (autoload/rubycomplete.vim) will be installed but
+the 'omnifunc' option will not be set to use this if Vim was not compiled with
+the Ruby interface (+ruby).
+
+=== Versions < 7.0
+
+While omni completion is a Vim 7.x series feature the supplied completion
+script will still be installed to facilitate an easier upgrade. It will simply
+be ignored by versions of Vim less than 7.0.
+
+=== Versions < 6.3
+
+The supplied filetype detection script (ftdetect/ruby.vim file) will be
+installed but ignored. In order for the filetype detection to operate
+correctly the autocommands specified in ftdetect/ruby.vim need to be executed.
+See :help new-filetype, in Vim, for a mechanism to achieve this which is
+appropriate for your version of Vim.
== Problems
-If you have any problems installing the Vim-Ruby configuration files please
+If you have any problems installing the vim-ruby configuration files please
send a message to the mailing list (http://rubyforge.org/mail/?group_id=16) or
post an item to the tracker (http://rubyforge.org/tracker/?group_id=16).
View
38 NEWS
@@ -1,3 +1,41 @@
+= 2006.07.11
+
+== Omni Completion
+
+A new omni completion function is now included which offers IntelliSense-like
+functionality. See :help ft-ruby-omni for further information.
+
+Note: This will only work with Vim 7.x, compiled with the Ruby interface
+(+ruby), and Ruby 1.8.x
+
+== Ruby Filetype Support
+
+Matchit support has been improved to include (), {}, and [] in the list of
+patterns meaning these will be appropriately skipped when included in comments.
+
+== Ruby Syntax Highlighting
+
+Operators can now be highlighted by defining the Vim global variable
+"ruby_operators".
+
+Multiline comments will now be folded. This can be disabled by defining the
+"ruby_no_comment_fold" Vim variable.
+
+== Filetype Detection
+
+RJS and RXML templates are now detected as being 'filetype=ruby'.
+
+== FAQ
+
+There is a new FAQ document included. This is a work in progress and any
+feedback would be appreciated.
+
+== Bug Fixes
+
+Ruby syntax file - if/unless modifiers after a method name ending with [?!=]
+should now be highlighted correctly.
+
+
= 2005.10.07
== Vim 6.4
View
8 README
@@ -27,9 +27,9 @@ For would-be contributors:
- Thank you very much for taking an interest.
Contents of the project:
- - The compiler, ftdetect, ftplugin, indent and syntax directories contain
- the ruby.vim files that are to be copied to a location somewhere in the Vim
- 'runtimepath'.
+ - The autoload, compiler, ftdetect, ftplugin, indent and syntax directories
+ contain the ruby*.vim files that are to be copied to a location somewhere
+ in the Vim 'runtimepath'.
- vim-ruby-install.rb performs this copying.
How you get these files into Vim:
@@ -68,7 +68,7 @@ CVS topics:
Any questions or suggestions?
- If there's something about the project or its concepts that you don't
understand, send an email to the project maintainer, Gavin Sinclair
- (gsinclair at soyabean.com.au).
+ (gsinclair at gmail.com).
- To ask about the contents of the configuration files, ask on the mailing
list, as different people maintain the different files. Gavin knows
nothing about the syntax file, for instance. (Come to think of it, nor does
View
23 doc/ft-ruby-syntax.txt
@@ -8,7 +8,7 @@ experience slow redrawing (or you are on a terminal with poor color support)
you may want to turn it off by defining the "ruby_no_expensive" variable: >
:let ruby_no_expensive = 1
-
+<
In this case the same color will be used for all control keywords.
If you do want this feature enabled, but notice highlighting errors while
@@ -16,7 +16,7 @@ scrolling backwards, which are fixed when redrawing with CTRL-L, try setting
the "ruby_minlines" variable to a value larger than 50: >
:let ruby_minlines = 100
-
+>
Ideally, this value should be a number of lines large enough to embrace your
largest class or module.
@@ -24,7 +24,7 @@ Highlighting of special identifiers can be disabled by defining
"ruby_no_identifiers": >
:let ruby_no_identifiers = 1
-
+<
This will prevent highlighting of special identifiers like "ConstantName",
"$global_var", "@@class_var", "@instance_var", "| block_param |", and
":symbol".
@@ -33,14 +33,19 @@ Significant methods of Kernel, Module and Object are highlighted by default.
This can be disabled by defining "ruby_no_special_methods": >
:let ruby_no_special_methods = 1
-
+<
This will prevent highlighting of important methods such as "require", "attr",
"private", "raise" and "proc".
+Ruby operators can be highlighted. This is enabled by defining
+"ruby_operators": >
+
+ :let ruby_operators = 1
+<
Whitespace errors can be highlighted by defining "ruby_space_errors": >
:let ruby_space_errors = 1
-
+<
This will highlight trailing whitespace and tabs preceded by a space character
as errors. This can be refined by defining "ruby_no_trail_space_error" and
"ruby_no_tab_space_error" which will ignore trailing whitespace and tabs after
@@ -49,8 +54,14 @@ spaces respectively.
Folding can be enabled by defining "ruby_fold": >
:let ruby_fold = 1
-
+<
This will set the 'foldmethod' option to "syntax" and allow folding of
classes, modules, methods, code blocks, heredocs and comments.
+Folding of multiline comments can be disabled by defining
+"ruby_no_comment_fold": >
+
+ :let ruby_no_comment_fold = 1
+<
+
vim:tw=78:sw=4:ts=8:ft=help:norl:
Please sign in to comment.
Something went wrong with that request. Please try again.