Documentation update: first draft
hgs at dmu.ac.uk
Fri Oct 14 13:19:43 EDT 2005
On Sat, 15 Oct 2005, Gavin Sinclair wrote:
> Hi guys,
> Attached is a FAQ in Vim Help format, so view it in Vim. The idea is
> to generate a table of contents with a Ruby program, and convert the
> whole lot to HTML to go on the project homepage.
> This is a first draft. Little or nothing is sacred. Please critique.
> Some parts are left to be done. Note to Hugh: I haven't dealt with
> matchit adequately at all, so there's one detailed suggestion you can
> make :)
It was easy to deal with matchit, as you see. Hope the other
suggestions in the attached patch are ok.
-------------- next part --------------
--- vim-ruby-FAQ.orig 2005-10-14 09:28:42.783441000 -0700
+++ vim-ruby-FAQ 2005-10-14 10:14:09.051192000 -0700
@@ -28,7 +28,8 @@
Yes it does. You should only want to download and install this project if it
has changed since you last installed your version of Vim. Read the "News"
-section of the homepage to see when the most recent release was made.
+section of the |vim-ruby-homepage| to see when the most recent release was
*vim-ruby-faq-X* How do you get it?
@@ -37,7 +38,8 @@
gem install vim-ruby
-(This really only downloads it. See installation instructions below.)
+(This really only downloads it. See installation instructions
If you don't have RubyGems, download a tarball from: >
@@ -46,7 +48,7 @@
Again, see installation instructions below.
-*vim-ruby-faq-X* How do you install it?
+*vim-ruby-faq-X* How do you install it? *vim-ruby-install*
If you obtained the vim-ruby files via RubyGems, run: >
@@ -91,7 +93,7 @@
customisations will definitely take effect.
-*vim-ruby-faq-X* What Vim config do I need?
+*vim-ruby-faq-X* What Vim config do I need? *vim-ruby-config*
Without the following lines in your .vimrc, _vimrc, or other startup file, the
files in the vim-ruby project will be largely useless. >
@@ -101,16 +103,18 @@
filetype on " Enable filetype detection
filetype indent on " Enable filetype-specific indenting
filetype plugin on " Enable filetype-specific plugins
+ compiler ruby " Enable compiler support for ruby
- TODO: matchit support
- TODO: anything needed for compiler support?
+See |matchit-install| for how to install matchit (which allows you
+to use |%| to bounce between (class,def,while,...) and their
+respective end keywords
See |.vimrc| for more information about this important Vim configuration file.
*vim-ruby-faq-X* How do I know that everything's working?
-If you've run the installer and added the configuration above, everything should
+If you've run the installer and added the configuration
+|vim-ruby-config| above, everything should
be fine when you restart Vim. To test this:
- Edit a Ruby file with Vim (make sure it has a .rb extension).
- The code should be syntax highlighted.
@@ -128,7 +132,7 @@
-*vim-ruby-faq-X* How do I customise it?
+*vim-ruby-faq-X* How do I customise it? *vim-ruby-customize*
The most important customisation for editing Ruby code is the amount of space to
indent. The following is a typical setup. Look up the various options to read
@@ -140,6 +144,8 @@
TODO: is autoindent necessary? What other options should go here? What about
+FIXME: Autoindent is good. maybe mention |i_CTRL_D| and |i_CTRL_T| for
+moving lines about in this context?
*vim-ruby-faq-X* I want feature X. Will you include it?
@@ -157,7 +163,7 @@
*vim-ruby-faq-X* What are some other cool Ruby-related Vim tricks I can use?
An example is the following (put it in ~/.vimrc/ftplugin/ruby_extra.vim or
+similar): [similar? |$VIMRUNTIME| or what?] >
if !exists( "*EndToken" )
@@ -185,7 +191,7 @@
-*vim-ruby-faq-X* How can I report a bug?
+*vim-ruby-faq-X* How can I report a bug? *vim-ruby-bug-reporting*
Bug reports are most welcome. In order or preference:
- submit a bug at http://rubyforge.org/tracker/?group_id=16
@@ -193,6 +199,7 @@
- email the maintainer (email address appears in each configuration file)
*vim-ruby-faq-X* Does the project have a mailing list?
Yes: vim-ruby-devel at rubyforge.org. Only subscribers can post. To join, visit:
@@ -221,7 +228,7 @@
*vim-ruby-faq-X* Can you repeat all the web pages listed in this FAQ?
+Homepage *vim-ruby-homepage* : >
Project page: >
@@ -241,4 +248,4 @@
+vim: ft=help tw=78 noet :
More information about the vim-ruby-devel