aboutsummaryrefslogtreecommitdiffstats
path: root/railties/lib/rails_generator/generators/components/scaffold/USAGE
blob: 1b6eaa2dd95616d8eb29d047bbc9117833f4f619 (plain) (blame)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
Description:
    The scaffold generator creates a controller to interact with a model.
    If the model does not exist, it creates the model as well.  The generated
    code is equivalent to the "scaffold :model" declaration, making it easy
    to migrate when you wish to customize your controller and views.

    The generator takes a model name, an optional controller name, and a
    list of views as arguments.  Scaffolded actions and views are created
    automatically.  Any views left over generate empty stubs.

    The scaffolded actions and views are:
        index, list, show, new, create, edit, update, destroy

    If a controller name is not given, the plural form of the model name
    will be used.  The model and controller names may be given in CamelCase
    or under_score and should not be suffixed with 'Model' or 'Controller'.
    Both model and controller names may be prefixed with a module like a
    file path; see the Modules Example for usage.

Example:
    ./script/generate scaffold Account Bank debit credit

    This will generate an Account model and BankController with a full test
    suite and a basic user interface.  Now create the accounts table in your
    database and browse to http://localhost/bank/ -- voila, you're on Rails!

Modules Example:
    ./script/generate scaffold CreditCard 'admin/credit_card' suspend late_fee

    This will generate a CreditCard model and CreditCardController controller
    in the admin module.