Adding new stuff

vim-plugins/bundle/eclim/doc/vim/ruby/buildpath.txt

@@ -0,0 +1,113 @@
+*vim-ruby-buildpath.html*
+
+Ruby Interpreters / Build Path
+******************************
+
+*:RubyInterpreterAdd* *:RubyInterpreterRemove* *:RubyInterpreterList*
+
+
+Interpreters
+============
+
+When creating your first ruby project you will be prompted to
+configure a new interpreter if you haven't already done so in eclipse.
+You can also manually manage your ruby interpreters with the following
+commands:
+
+- :RubyInterpreterAdd [-n <name>] <path> - Add a ruby interpreter.
+- :RubyInterpreterRemove <path> - Remove a ruby interpreter.
+- :RubyInterpreterList  - List the available ruby interpreters.
+If you have more than one interpreter configured when you create
+subsequent projects you will be prompted to choose the interpreter to
+use. If you remove an interpreter used by one of your projects, you'll
+have to go back to that project and edit its .buildpath file and
+change the interpreter name in the container entry.
+
+Example (wrapped for readability): Changing ruby1.9 to ruby1.8:
+
+>
+
+   <buildpathentry kind="con"
+       path="org.eclipse.dltk.launching.INTERPRETER_CONTAINER/
+             org.eclipse.dltk.internal.debug.ui.launcher.GenericRubyInstallType/ruby1.9"/>
+
+<
+
+
+>
+
+   <buildpathentry kind="con"
+       path="org.eclipse.dltk.launching.INTERPRETER_CONTAINER/
+             org.eclipse.dltk.internal.debug.ui.launcher.GenericRubyInstallType/ruby1.8"/>
+
+<
+
+
+If there is no suffix on the container entry, that project will be
+using what ever is he default interpreter:
+
+>
+
+   <buildpathentry kind="con"
+       path="org.eclipse.dltk.launching.INTERPRETER_CONTAINER"/>
+
+<
+
+
+
+Build Path
+==========
+
+Source code completion, searching, and other features make use of the
+eclipse dltk's (http://eclipse.org/dltk/) .buildpath to locate
+resources. When you first create a dltk project (currently php
+(vim-php-index) or ruby (vim-ruby-index)), a .buildpath file is
+created in the project's root directory.  If your project depends on
+any source files located outside your project or in another project,
+then you'll need to edit your .buildpath accordingly.
+
+To help you do this, eclim provides several commands to ease the
+creation of new build path entries and variables, all of which are
+made available when you edit your .buildpath file in vim.  Also when
+you write the .buildpath file, Vim will issue a command to the eclim
+server to update the project's build path, and will report any errors
+via vim's location list (:help location-list).
+
+The following is a list of commands that eclim provides while editing
+your .buildpath.
+
+*:NewSrcEntry_dltk_ruby*
+
+- :NewSrcEntry <dir> [<dir> ...] - Adds one or more new entries
+  which reference source directories in your project.
+  >
+     <buildpathentry external="true" kind="lib" path="src/php"/>
+
+  <
+
+  This command supports command completion of project relative
+  directories.
+
+*:NewLibEntry_dltk_ruby*
+
+- :NewLibEntry <dir> [<dir> ...] - Adds one or more new entries
+  which reference external source directories.
+  >
+     <buildpathentry external="true" kind="lib" path="/usr/local/php/cake_1.1.16.5421"/>
+
+  <
+
+  This command supports command completion of directories.
+
+*:NewProjectEntry_dltk_ruby*
+
+- :NewProjectEntry <project> [<project> ...] - Adds one or more new
+  entries which reference other projects.
+  >
+     <buildpathentry combineaccessrules="false" kind="prj" path="/test_project"/>
+
+  <
+
+  This command supports command completion of project names.
+
+vim:ft=eclimhelp

vim-plugins/bundle/eclim/doc/vim/ruby/complete.txt

@@ -0,0 +1,25 @@
+*vim-ruby-complete.html*
+
+Ruby Code Completion
+********************
+
+Ruby code completion uses the standard Vim code completion mechanism
+(vim-code_completion) like so:
+
+>
+
+   class Test
+     def getName()
+     end
+
+     def getValue()
+     end
+   end
+
+   test = Test.new
+   test.get<C-X><C-U>
+   test.getName()
+
+<
+
+vim:ft=eclimhelp

vim-plugins/bundle/eclim/doc/vim/ruby/index.txt

@@ -0,0 +1,11 @@
+*vim-ruby-index.html*
+
+Ruby
+****
+
+- Ruby Interpreters / Build Path (vim-ruby-buildpath)
+- Ruby Code Completion (vim-ruby-complete)
+- Ruby Validation (vim-ruby-validate)
+- Ruby Search (vim-ruby-search)
+
+vim:ft=eclimhelp

vim-plugins/bundle/eclim/doc/vim/ruby/search.txt

@@ -0,0 +1,117 @@
+*vim-ruby-search.html*
+
+Ruby Search
+***********
+
+*:RubySearch*
+
+
+Pattern Search
+==============
+
+Pattern searching provides a means to widen a search beyond a single
+element.  A pattern search can be executed using the command
+
+:RubySearch -p <pattern> [-t <type> -s <scope> -i -a <action>]
+
+When there is more than 1 result, those results will be placed into
+vim's quickfix list (:help quickfix) so that you can easily navigate
+them using vim's quickfix commands.
+
+Vim command completion is supported through out the command with the
+exception of the pattern to search for.
+
+>
+
+   :RubySearch <Tab>
+   :RubySearch -p MyClass* <Tab>
+   :RubySearch -p MyClass* -t <Tab>
+   :RubySearch -p MyClass* -t class <Tab>
+   :RubySearch -p MyClass* -t class -s <Tab>
+   :RubySearch -p MyClass* -t class -s project
+
+<
+
+
+- -p <pattern>: The pattern to search for.
+  Ex.
+
+  >
+     MyClass
+     myFunction
+     my*
+
+  <
+
+- -t <type> (Default: all): The type of element to search for where
+  possible types include
+  - class
+  - method
+  - field
+- -x <context> (Default: declarations): The context of the search,
+  where possible values include
+  - all - All occurances.
+  - declarations - Declarations matching the pattern or element.
+  - references - References of the pattern or element.
+- -s <scope> (Default: all): The scope of the search where possible
+  values include
+  - all - Search the whole workspace.
+  - project - Search the current project, dependent projects, and
+    libraries.
+- -i: Ignore case when searching.
+- -a: The vim command to use to open the result (edit, split,
+  vsplit, etc).
+
+Element Search
+==============
+
+Element searching allows you to place the cursor over just about any
+element in a source file (method call, class name, constant) and
+perform a search for that element.  Performing an element search is
+the same as performing a pattern search with the exception that you do
+not specify the -p option since the element under the cursor will be
+searched for instead.
+
+If only one result is found and that result is in the current source
+file, the cursor will be moved to the element found. Otherwise, on
+single result matches, the value of |g:EclimRubySearchSingleResult|
+will be consulted for the action to take. If there are multiple
+results, the quickfix list will be opened with the list of results.
+
+*:RubySearchContext*
+
+As a convenience eclim also provides the command :RubySearchContext.
+This command accepts only the optional -a argument described above,
+and will perform the appropriate search depending on the context of
+the element under the cursor.
+
+- If the cursor is on a the definition of a method, class, module,
+  etc. then a search will be performed for all uses of that element.
+- Otherwise, it will search for the declaration of the element.
+
+Configuration
+=============
+
+Vim Settings (vim-settings)
+
+*g:EclimRubySearchSingleResult*
+
+- g:EclimRubySearchSingleResult (Default: 'split') - Determines what
+  action to take when a only a single result is found.
+  Possible values include:
+
+  - 'split' - open the result in a new window via "split".
+  - 'edit' - open the result in the current window.
+  - 'tabnew' - open the result in a new tab.
+  This setting overrides the global default for all supported language
+  types which can be set using the g:EclimDefaultFileOpenAction
+  setting which accepts the same possible values.
+
+- g:EclimQuickFixOpen (Default: 'botright copen') Specifies the
+  command used to open the quickfix window when multiple results are
+  found.
+- g:EclimQuickFixHeight (Default: 10) - Sets the height, in lines,
+  of the quickfix window when eclim opens it to display search
+  results.
+
+vim:ft=eclimhelp

vim-plugins/bundle/eclim/doc/vim/ruby/validate.txt

@@ -0,0 +1,48 @@
+*vim-ruby-validate.html*
+
+*:Validate_ruby*
+
+
+Ruby Validation
+***************
+
+When saving a ruby source file that resides in a project, eclim will
+update that source file in Eclipse and will report any validation
+errors found.  Any errors will be placed in the current window's
+location list (:help location-list) and the corresponding lines in the
+source file will be marked via Vim's :sign functionality with '>>'
+markers in the left margin.
+
+Automatic validation of ruby source files can be disabled via the
+g:EclimRubyValidate variable (described below).  If you choose to
+disable automatic validation, you can still use the :Validate command
+to manually validate the current file.
+
+
+Configuration
+=============
+
+Vim Settings (vim-settings)
+
+*g:EclimRubyValidate*
+
+- g:EclimRubyValidate (Default: 1) - If set to 0, disables source
+  code validation.
+  Note: When enabled, syntastic
+    (https://github.com/scrooloose/syntastic) is disabled so that
+    eclim and syntastic don't step on each other. If you'd like to use
+    syntastic over eclim for validation, then simply disable eclim's
+    validation.If you'd like to disable eclim's source code validation
+    for all languages, eclim provides a global variable for that as
+    well:>
+
+       let g:EclimFileTypeValidate = 0
+
+    <
+
+
+- g:EclimValidateSortResults (Default: 'occurrence') - If set to
+  'severity', the validation results will be sorted by severity
+  (errors > warnings > info > etc.)
+
+vim:ft=eclimhelp