Alphabetize navigation command documentation

Author: tpope

doc/rails.txt

@@ -10,9 +10,7 @@ Author: Tim Pope <[email protected]>		|rails-plugin-author|
 |rails-navigation|		Navigation
 |rails-gf|			    File Under Cursor - gf
 |rails-alternate-related|	    Alternate and Related Files
-|rails-model-navigation|	    Model Navigation Commands
-|rails-controller-navigation|	    Controller Navigation Commands
-|rails-misc-navigation|		    Miscellaneous Navigation Commands
+|rails-type-navigation|		    File Type Commands
 |rails-custom-navigation|	    Custom Navigation Commands
 |rails-rake|			Rake
 |rails-scripts|			Script Wrappers
@@ -316,137 +314,94 @@ Suggestions for further contexts to consider for the alternate file, related
 file, and file under the cursor are welcome.  They are subtly tweaked from
 release to release.
 
+
+File Type Navigation Commands ~
+						*rails-type-navigation*
 For the less common cases, a more deliberate set of commands are provided.
-Each of the following takes an optional argument (with tab completion) but
-defaults to a reasonable guess that follows Rails conventions.  For example,
-when editing app/models/employee.rb, :Rcontroller will default to
-app/controllers/employees_controller.rb.
+Each of the upcoming commands takes an optional argument (with tab completion)
+but defaults to a reasonable guess.  Commands that default to the current
+model or controller generally behave like you'd expect in other file types.
+For example, in app/helpers/posts_helper.rb, the current controller is
+"posts", and in test/fixtures/comments.yml, the current model is "comment".
+In model related files, the current controller is the pluralized model name,
+and in controller related files, the current model is the singularized
+controller name.
 
 Each of the following commands has variants for splitting, vertical splitting,
 opening in a new tab, and reading the file into the current buffer.  For
 :Rmodel, those variants would be :RSmodel, :RVmodel, :RTmodel, and :RDmodel.
 There is also :REmodel which is a synonym for :Rmodel (future versions might
 allow customization of the behavior of :Rmodel).  They also allow for jumping
-to methods or line numbers using the same syntax as |:Redit|.
-
-
-Model Navigation Commands ~
-						*rails-model-navigation*
-The default for model navigation commands is the current model, if it can be
-determined.  For example, test/unit/post_test.rb would have a current model
-of post.  Otherwise, if a controller name can be determined, said controller
-name will be singularized and used.
+to methods or line numbers using the same syntax as |:Redit|, and file
+creation can be forced by adding a ! after the filename (not after the command
+itself!).
 
-:Rmodel						|rails-:Rmodel|
+:Rcontroller					|rails-:Rcontroller|
+:Renvironment					|rails-:Renvironment|
+:Rfixtures					|rails-:Rfixtures|
+:Rfunctionaltest				|rails-:Rfunctionaltest|
+:Rhelper					|rails-:Rhelper|
+:Rinitializer					|rails-:Rinitializer|
+:Rintegrationtest				|rails-:Rintegrationtest|
+:Rjavascript					|rails-:Rjavascript|
+:Rlayout					|rails-:Rlayout|
+:Rlib						|rails-:Rlib|
+:Rlocale					|rails-:Rlocale|
+:Rmetal						|rails-:Rmetal|
 :Rmigration					|rails-:Rmigration|
+:Rmodel						|rails-:Rmodel|
 :Robserver					|rails-:Robserver|
-:Rfixtures					|rails-:Rfixtures|
+:Rplugin					|rails-:Rplugin|
+:Rspec						|rails-:Rspec|
+:Rstylesheet					|rails-:Rstylesheet|
+:Rtask						|rails-:Rtask|
 :Runittest					|rails-:Runittest|
-
-						*rails-:Rmodel*
-:Rmodel [{name}]	Edit the specified model.
-
-						*rails-:Rmigration*
-:Rmigration [{pattern}]	If {pattern} is a number, find the migration for that
-			particular set of digits, zero-padding if necessary.
-			Otherwise, find the newest migration containing the
-			given pattern.  Omitting the pattern selects the
-			latest migration.  Give a numeric argument of 0 to edit
-			db/schema.rb.
-
-						*rails-:Robserver*
-:Robserver [{name}]	Find the observer with a name like
-			{model}_observer.rb.  When in an observer, most
-			commands (like :Rmodel) will seek based on the
-			observed model ({model}) and not the actual observer
-			({model}_observer).  However, for the command
-			:Runittest, a file of the form
-			{model}_observer_test.rb will be found.
-
-						*rails-:Rfixtures*
-:Rfixtures [{name}]	Edit the fixtures for the given model.  If an argument
-			is given, it must be pluralized, like the final
-			filename (this may change in the future).  If omitted,
-			the current model is pluralized automatically.  An
-			optional extension can be given, to distinguish
-			between YAML and CSV fixtures.
-
-						*rails-:Runittest*
-:Runittest [{name}]	Edit the unit test or model spec for the specified
-			model.
-
-Controller Navigation Commands  ~
-						*rails-controller-navigation*
-The default for controller navigation commands is the current controller, if
-it can be determined.  For example, test/functional/blog_test.rb would have a
-current controller of blog.  Otherwise, if a model name can be determined,
-said model name will be pluralized and used.
-
-:Rcontroller					|rails-:Rcontroller|
-:Rhelper					|rails-:Rhelper|
 :Rview						|rails-:Rview|
-:Rlayout					|rails-:Rlayout|
-:Rfunctionaltest				|rails-:Rfunctionaltest|
 
 						*rails-:Rcontroller*
-:Rcontroller [{name}]	Edit the specified controller.
+:Rcontroller [{name}]	Edit the specified or current controller.
 
-						*rails-:Rhelper*
-:Rhelper [{name}]	Edit the helper for the specified controller.
-
-						*rails-:Rview*
-:Rview [[{controller}/]{view}]
-			Edit the specified view.  The controller will default
-			sensibly, and the view name can be omitted when
-			editing a method of a controller.  If a view name is
-			given with an extension, a new file will be created.
-			This is a quick way to create a new view.
+						*rails-:Renvironment*
+:Renvironment [{name}]  Edit the config/environments file specified.  With no
+			argument, defaults to editing config/application.rb
+			or config/environment.rb.
 
-						*rails-:Rlayout*
-:Rlayout [{name}]	Edit the specified layout.  Defaults to the layout for
-			the current controller, or the application layout if
-			that cannot be found.  A new layout will be created if
-			an extension is given.
+						*rails-:Rfixtures*
+:Rfixtures [{name}]	Edit the fixtures for the given or current model.  If
+			an argument is given, it must be pluralized, like the
+			final filename (this may change in the future).  If
+			omitted, the current model is pluralized.  An optional
+			extension can be given, to distinguish between YAML
+			and CSV fixtures.
 
 						*rails-:Rfunctionaltest*
 :Rfunctionaltest [{name}]
 			Edit the functional test or controller spec for the
-			specified controller.
-
-						*rails-:Rapi*
-:Rapi [{name}]		This command is obsolete; add it yourself with
-			|:Rnavcommand| if you still desire it.
+			specified or current controller.
 
-Miscellaneous Navigation Commands  ~
-						*rails-misc-navigation*
-
-The following commands are not clearly associated with models or controllers.
+						*rails-:Rhelper*
+:Rhelper [{name}]	Edit the helper for the specified name or current
+			controller.
 
-:Rstylesheet					|rails-:Rstylesheet|
-:Rjavascript					|rails-:Rjavascript|
-:Rplugin					|rails-:Rplugin|
-:Rlib						|rails-:Rlib|
-:Rtask						|rails-:Rtask|
-:Rmetal						|rails-:Rmetal|
-:Renvironment					|rails-:Renvironment|
-:Rinitializer					|rails-:Rinitializer|
-:Rlocale					|rails-:Rlocale|
-:Rintegrationtest				|rails-:Rintegrationtest|
-:Rspec						|rails-:Rspec|
+						*rails-:Rinitializer*
+:Rinitializer [{name}]  Edit the config/initializers file specified.  With no
+			argument, defaults to editing config/routes.rb.
 
-						*rails-:Rstylesheet*
-:Rstylesheet [{name}]	Edit the stylesheet for the specified name, defaulting
-			to the current controller's name.
+						*rails-:Rintegrationtest*
+:Rintegrationtest [{name}]
+			Edit the integration test, integration spec, or
+			cucumber feature specified.  With no argument,
+			defaults to editing test/test_helper.rb.
 
 						*rails-:Rjavascript*
-:Rjavascript [{name}]	Edit the javascript for the specified name, defaulting
-			to the current controller's name.
+:Rjavascript [{name}]	Edit the javascript for the specified name or current
+			controller.
 
-						*rails-:Rplugin*
-:Rplugin [{plugin}[/{path}]]
-			Edits a file within a plugin.  If the path to the file
-			is omitted, it defaults to init.rb.  If no argument is
-			given, it defaults to editing the application Gemfile.
+						*rails-:Rlayout*
+:Rlayout [{name}]	Edit the specified layout.  Defaults to the layout for
+			the current controller, or the application layout if
+			that cannot be found.  A new layout will be created if
+			an extension is given.
 
 						*rails-:Rlib*
 :Rlib [{name}]		Edit the library from the lib directory for the
@@ -455,37 +410,41 @@ The following commands are not clearly associated with models or controllers.
 			specified as well.  With no argument, defaults to
 			editing config/routes.rb.
 
-						*rails-:Rtask*
-:Rtask [{name}]		Edit the .rake file from lib/tasks for the specified
-			name.  If the current file is part of a plugin, the
-			tasks for that plugin can be specified as well.  If no
-			argument is given, either the current plugin's
-			Rakefile or the application Rakefile will be edited.
+						*rails-:Rlocale*
+:Rlocale [{name}]	Edit the config/locale file specified, optionally
+			adding a yml or rb extension if none is given.  With
+			no argument, checks config/environment.rb for the
+			default locale.
 
 						*rails-:Rmetal*
 :Rmetal [{name}]	Edit the app/metal file specified.  With no argument,
 			defaults to editing config/boot.rb.
 
-						*rails-:Renvironment*
-:Renvironment [{name}]  Edit the config/environments file specified.  With no
-			argument, defaults to editing config/application.rb
-			or config/environment.rb.
+						*rails-:Rmigration*
+:Rmigration [{pattern}]	If {pattern} is a number, find the migration for that
+			particular set of digits, zero-padding if necessary.
+			Otherwise, find the newest migration containing the
+			given pattern.  Omitting the pattern selects the
+			latest migration.  Give a numeric argument of 0 to edit
+			db/schema.rb.
 
-						*rails-:Rinitializer*
-:Rinitializer [{name}]  Edit the config/initializers file specified.  With no
-			argument, defaults to editing config/routes.rb.
+						*rails-:Rmodel*
+:Rmodel [{name}]	Edit the specified or current model.
 
-						*rails-:Rlocale*
-:Rlocale [{name}]	Edit the config/locale file specified, optionally
-			adding a yml or rb extension if none is given.  With
-			no argument, checks config/environment.rb for the
-			default locale.
+						*rails-:Robserver*
+:Robserver [{name}]	Find the observer with a name like
+			{model}_observer.rb.  When in an observer, most
+			commands (like :Rmodel) will seek based on the
+			observed model ({model}) and not the actual observer
+			({model}_observer).  However, for the command
+			:Runittest, a file of the form
+			{model}_observer_test.rb will be found.
 
-						*rails-:Rintegrationtest*
-:Rintegrationtest [{name}]
-			Edit the integration test, integration spec, or
-			cucumber feature specified.  With no argument,
-			defaults to editing test/test_helper.rb.
+						*rails-:Rplugin*
+:Rplugin [{plugin}[/{path}]]
+			Edits a file within a plugin.  If the path to the file
+			is omitted, it defaults to init.rb.  If no argument is
+			given, it defaults to editing the application Gemfile.
 
 						*rails-:Rspec*
 :Rspec [{name}]		Edit the given spec.  With no argument, defaults to
@@ -494,6 +453,29 @@ The following commands are not clearly associated with models or controllers.
 			command is only defined if there is a spec folder in
 			the root of the application.
 
+						*rails-:Rstylesheet*
+:Rstylesheet [{name}]	Edit the stylesheet for the specified name or current
+			controller.
+
+						*rails-:Rtask*
+:Rtask [{name}]		Edit the .rake file from lib/tasks for the specified
+			name.  If the current file is part of a plugin, the
+			tasks for that plugin can be specified as well.  If no
+			argument is given, either the current plugin's
+			Rakefile or the application Rakefile will be edited.
+
+						*rails-:Runittest*
+:Runittest [{name}]	Edit the unit test or model spec for the specified
+			name or current model.
+
+						*rails-:Rview*
+:Rview [[{controller}/]{view}]
+			Edit the specified view.  The controller will default
+			sensibly, and the view name can be omitted when
+			editing a method of a controller.  If a view name is
+			given with an extension, a new file will be created.
+			This is a quick way to create a new view.
+
 Custom Navigation Commands  ~
 						*rails-custom-navigation*