lib/generators/extension_controller/.svn/text-base/USAGE.svn-base

   1 Description:
   2     The extension_controller generator creates stubs for a new controller and
   3     its views for an extension.
   4
   5     The generator takes an extension name, controller name, and a list of
   6     views as arguments.  The controller name may be given in CamelCase or
   7     under_score and should not be suffixed with 'Controller'.  To create a
   8     controller within a module, specify the controller name as
   9     'module/controller'.
  10
  11     The generator creates a controller class in
  12     vendor/extension_name/app/controllers with view templates in
  13     vendor/extension_name/app/views/controller_name, a helper class in
  14     vendor/extension_name/app/helpers, and a functional test suite in
  15     vendor/extension_name/test/functional.
  16
  17 Example:
  18     ./script/generate extension_controller MyExt Assets list show
  19
  20     Controller: vendor/my_ext/app/controllers/assets_controller.rb
  21     Views:      vendor/my_ext/app/views/assets/list.rhtml [...]
  22     Helper:     vendor/my_ext/app/helpers/assets_helper.rb
  23     Test:       vendor/my_ext/test/functional/assets_test.rb
  24
  25 Modules Example:
  26     ./script/generate extension_controller MyExt 'admin/assets' upload remove
  27
  28     Controller: vendor/my_ext/app/controllers/admin/assets_controller.rb
  29     Views:      vendor/my_ext/app/views/admin/assets/upload.rhtml [...]
  30     Helper:     vendor/my_ext/app/helpers/admin/assets_helper.rb
  31     Test:       vendor/my_ext/test/functional/admin/assets_controller_test.rb
  32
  33 Note: Once you have created an extension controller you will still need to
  34 map routes to the controller in the extension file.