github/rails
1
1
Fork 0
mirror of https://github.com/github/rails.git synced 2026-04-26 03:00:59 -04:00
Code Issues Packages Projects Releases Wiki Activity

Update table syntax in guides to fix deprecation warnings during build.

Browse Source
This commit is contained in:
Mike Gunderloy
2009-01-02 20:04:37 -06:00
parent 5a798f094f
commit 8259f06e47
4 changed files with 528 additions and 1034 deletions
Download Patch File Download Diff File Expand all files Collapse all files

366
railties/doc/guides/html/getting_started_with_rails.html
View File

@@ -572,125 +572,70 @@ http://www.gnu.org/software/src-highlite -->
<div class="paragraph"><p>In any case, Rails will create a folder in your working directory called <tt>blog</tt>. Open up that folder and explore its contents. Most of the work in this tutorial will happen in the <tt>app/</tt> folder, but here&#8217;s a basic rundown on the function of each folder that Rails creates in a new application by default:</p></div>
<div class="tableblock">
<table rules="all"
frame="hsides"
width="100%"
frame="border"
cellspacing="0" cellpadding="4">
<col width="137" />
<col width="1440" />
<thead>
<tr>
<th align="left">
File/Folder
</th>
<th align="left">
Purpose
</th>
</tr>
<col width="50%" />
<col width="50%" />
<thead valign="top">
<tr>
<th align="left">File/Folder </th>
<th align="left">Purpose</th>
</tr>
</thead>
<tbody valign="top">
<tr>
<td align="left">
<tt>README</tt>
</td>
<td align="left">
This is a brief instruction manual for your application. Use it to tell others what your application does, how to set it up, and so on.
</td>
</tr>
<tr>
<td align="left">
<tt>Rakefile</tt>
</td>
<td align="left">
This file contains batch jobs that can be run from the terminal.
</td>
</tr>
<tr>
<td align="left">
<tt>app/</tt>
</td>
<td align="left">
Contains the controllers, models, and views for your application. You&#8217;ll focus on this folder for the remainder of this guide.
</td>
</tr>
<tr>
<td align="left">
<tt>config/</tt>
</td>
<td align="left">
Configure your application&#8217;s runtime rules, routes, database, and more.
</td>
</tr>
<tr>
<td align="left">
<tt>db/</tt>
</td>
<td align="left">
Shows your current database schema, as well as the database migrations. You&#8217;ll learn about migrations shortly.
</td>
</tr>
<tr>
<td align="left">
<tt>doc/</tt>
</td>
<td align="left">
In-depth documentation for your application.
</td>
</tr>
<tr>
<td align="left">
<tt>lib/</tt>
</td>
<td align="left">
Extended modules for your application (not covered in this guide).
</td>
</tr>
<tr>
<td align="left">
<tt>log/</tt>
</td>
<td align="left">
Application log files.
</td>
</tr>
<tr>
<td align="left">
<tt>public/</tt>
</td>
<td align="left">
The only folder seen to the world as-is. This is where your images, javascript, stylesheets (CSS), and other static files go.
</td>
</tr>
<tr>
<td align="left">
<tt>script/</tt>
</td>
<td align="left">
Scripts provided by Rails to do recurring tasks, such as benchmarking, plugin installation, and starting the console or the web server.
</td>
</tr>
<tr>
<td align="left">
<tt>test/</tt>
</td>
<td align="left">
Unit tests, fixtures, and other test apparatus. These are covered in <a href="../testing_rails_applications.html">Testing Rails Applications</a>
</td>
</tr>
<tr>
<td align="left">
<tt>tmp/</tt>
</td>
<td align="left">
Temporary files
</td>
</tr>
<tr>
<td align="left">
<tt>vendor/</tt>
</td>
<td align="left">
A place for third-party code. In a typical Rails application, this includes Ruby Gems, the Rails source code (if you install it into your project) and plugins containing additional prepackaged functionality.
</td>
</tr>
<tr>
<td align="left"><p class="table"><tt>README</tt></p></td>
<td align="left"><p class="table">This is a brief instruction manual for your application. Use it to tell others what your application does, how to set it up, and so on.</p></td>
</tr>
<tr>
<td align="left"><p class="table"><tt>Rakefile</tt></p></td>
<td align="left"><p class="table">This file contains batch jobs that can be run from the terminal.</p></td>
</tr>
<tr>
<td align="left"><p class="table"><tt>app/</tt></p></td>
<td align="left"><p class="table">Contains the controllers, models, and views for your application. You&#8217;ll focus on this folder for the remainder of this guide.</p></td>
</tr>
<tr>
<td align="left"><p class="table"><tt>config/</tt></p></td>
<td align="left"><p class="table">Configure your application&#8217;s runtime rules, routes, database, and more.</p></td>
</tr>
<tr>
<td align="left"><p class="table"><tt>db/</tt></p></td>
<td align="left"><p class="table">Shows your current database schema, as well as the database migrations. You&#8217;ll learn about migrations shortly.</p></td>
</tr>
<tr>
<td align="left"><p class="table"><tt>doc/</tt></p></td>
<td align="left"><p class="table">In-depth documentation for your application.</p></td>
</tr>
<tr>
<td align="left"><p class="table"><tt>lib/</tt></p></td>
<td align="left"><p class="table">Extended modules for your application (not covered in this guide).</p></td>
</tr>
<tr>
<td align="left"><p class="table"><tt>log/</tt></p></td>
<td align="left"><p class="table">Application log files.</p></td>
</tr>
<tr>
<td align="left"><p class="table"><tt>public/</tt></p></td>
<td align="left"><p class="table">The only folder seen to the world as-is. This is where your images, javascript, stylesheets (CSS), and other static files go.</p></td>
</tr>
<tr>
<td align="left"><p class="table"><tt>script/</tt></p></td>
<td align="left"><p class="table">Scripts provided by Rails to do recurring tasks, such as benchmarking, plugin installation, and starting the console or the web server.</p></td>
</tr>
<tr>
<td align="left"><p class="table"><tt>test/</tt></p></td>
<td align="left"><p class="table">Unit tests, fixtures, and other test apparatus. These are covered in <a href="../testing_rails_applications.html">Testing Rails Applications</a></p></td>
</tr>
<tr>
<td align="left"><p class="table"><tt>tmp/</tt></p></td>
<td align="left"><p class="table">Temporary files</p></td>
</tr>
<tr>
<td align="left"><p class="table"><tt>vendor/</tt></p></td>
<td align="left"><p class="table">A place for third-party code. In a typical Rails application, this includes Ruby Gems, the Rails source code (if you install it into your project) and plugins containing additional prepackaged functionality.</p></td>
</tr>
</tbody>
</table>
</div>
@@ -876,133 +821,74 @@ http://www.gnu.org/software/src-highlite -->
<div class="paragraph"><p>The scaffold generator will build 13 files in your application, along with some folders, and edit one more. Here&#8217;s a quick overview of what it creates:</p></div>
<div class="tableblock">
<table rules="all"
frame="hsides"
width="100%"
frame="border"
cellspacing="0" cellpadding="4">
<col width="525" />
<col width="1062" />
<thead>
<tr>
<th align="left">
File
</th>
<th align="left">
Purpose
</th>
</tr>
<col width="50%" />
<col width="50%" />
<thead valign="top">
<tr>
<th align="left">File </th>
<th align="left">Purpose</th>
</tr>
</thead>
<tbody valign="top">
<tr>
<td align="left">
app/models/post.rb
</td>
<td align="left">
The Post model
</td>
</tr>
<tr>
<td align="left">
db/migrate/20081013124235_create_posts.rb
</td>
<td align="left">
Migration to create the posts table in your database (your name will include a different timestamp)
</td>
</tr>
<tr>
<td align="left">
app/views/posts/index.html.erb
</td>
<td align="left">
A view to display an index of all posts
</td>
</tr>
<tr>
<td align="left">
app/views/posts/show.html.erb
</td>
<td align="left">
A view to display a single post
</td>
</tr>
<tr>
<td align="left">
app/views/posts/new.html.erb
</td>
<td align="left">
A view to create a new post
</td>
</tr>
<tr>
<td align="left">
app/views/posts/edit.html.erb
</td>
<td align="left">
A view to edit an existing post
</td>
</tr>
<tr>
<td align="left">
app/views/layouts/posts.html.erb
</td>
<td align="left">
A view to control the overall look and feel of the other posts views
</td>
</tr>
<tr>
<td align="left">
public/stylesheets/scaffold.css
</td>
<td align="left">
Cascading style sheet to make the scaffolded views look better
</td>
</tr>
<tr>
<td align="left">
app/controllers/posts_controller.rb
</td>
<td align="left">
The Posts controller
</td>
</tr>
<tr>
<td align="left">
test/functional/posts_controller_test.rb
</td>
<td align="left">
Functional testing harness for the posts controller
</td>
</tr>
<tr>
<td align="left">
app/helpers/posts_helper.rb
</td>
<td align="left">
Helper functions to be used from the posts views
</td>
</tr>
<tr>
<td align="left">
config/routes.rb
</td>
<td align="left">
Edited to include routing information for posts
</td>
</tr>
<tr>
<td align="left">
test/fixtures/posts.yml
</td>
<td align="left">
Dummy posts for use in testing
</td>
</tr>
<tr>
<td align="left">
test/unit/post_test.rb
</td>
<td align="left">
Unit testing harness for the posts model
</td>
</tr>
<tr>
<td align="left"><p class="table">app/models/post.rb</p></td>
<td align="left"><p class="table">The Post model</p></td>
</tr>
<tr>
<td align="left"><p class="table">db/migrate/20081013124235_create_posts.rb</p></td>
<td align="left"><p class="table">Migration to create the posts table in your database (your name will include a different timestamp)</p></td>
</tr>
<tr>
<td align="left"><p class="table">app/views/posts/index.html.erb</p></td>
<td align="left"><p class="table">A view to display an index of all posts</p></td>
</tr>
<tr>
<td align="left"><p class="table">app/views/posts/show.html.erb</p></td>
<td align="left"><p class="table">A view to display a single post</p></td>
</tr>
<tr>
<td align="left"><p class="table">app/views/posts/new.html.erb</p></td>
<td align="left"><p class="table">A view to create a new post</p></td>
</tr>
<tr>
<td align="left"><p class="table">app/views/posts/edit.html.erb</p></td>
<td align="left"><p class="table">A view to edit an existing post</p></td>
</tr>
<tr>
<td align="left"><p class="table">app/views/layouts/posts.html.erb</p></td>
<td align="left"><p class="table">A view to control the overall look and feel of the other posts views</p></td>
</tr>
<tr>
<td align="left"><p class="table">public/stylesheets/scaffold.css</p></td>
<td align="left"><p class="table">Cascading style sheet to make the scaffolded views look better</p></td>
</tr>
<tr>
<td align="left"><p class="table">app/controllers/posts_controller.rb</p></td>
<td align="left"><p class="table">The Posts controller</p></td>
</tr>
<tr>
<td align="left"><p class="table">test/functional/posts_controller_test.rb</p></td>
<td align="left"><p class="table">Functional testing harness for the posts controller</p></td>
</tr>
<tr>
<td align="left"><p class="table">app/helpers/posts_helper.rb</p></td>
<td align="left"><p class="table">Helper functions to be used from the posts views</p></td>
</tr>
<tr>
<td align="left"><p class="table">config/routes.rb</p></td>
<td align="left"><p class="table">Edited to include routing information for posts</p></td>
</tr>
<tr>
<td align="left"><p class="table">test/fixtures/posts.yml</p></td>
<td align="left"><p class="table">Dummy posts for use in testing</p></td>
</tr>
<tr>
<td align="left"><p class="table">test/unit/post_test.rb</p></td>
<td align="left"><p class="table">Unit testing harness for the posts model</p></td>
</tr>
</tbody>
</table>
</div>

1011
railties/doc/guides/html/routing_outside_in.html
View File

File diff suppressed because it is too large Load Diff

72
railties/doc/guides/source/getting_started_with_rails.txt
View File

@@ -163,24 +163,23 @@ $ cd blog
In any case, Rails will create a folder in your working directory called +blog+. Open up that folder and explore its contents. Most of the work in this tutorial will happen in the +app/+ folder, but here's a basic rundown on the function of each folder that Rails creates in a new application by default:
[grid="all"]
`-----------`-----------------------------------------------------------------------------------------------------------------------------
File/Folder Purpose
------------------------------------------------------------------------------------------------------------------------------------------
+README+ This is a brief instruction manual for your application. Use it to tell others what your application does, how to set it up, and so on.
+Rakefile+ This file contains batch jobs that can be run from the terminal.
+app/+ Contains the controllers, models, and views for your application. You'll focus on this folder for the remainder of this guide.
+config/+ Configure your application's runtime rules, routes, database, and more.
+db/+ Shows your current database schema, as well as the database migrations. You'll learn about migrations shortly.
+doc/+ In-depth documentation for your application.
+lib/+ Extended modules for your application (not covered in this guide).
+log/+ Application log files.
+public/+ The only folder seen to the world as-is. This is where your images, javascript, stylesheets (CSS), and other static files go.
+script/+ Scripts provided by Rails to do recurring tasks, such as benchmarking, plugin installation, and starting the console or the web server.
+test/+ Unit tests, fixtures, and other test apparatus. These are covered in link:../testing_rails_applications.html[Testing Rails Applications]
+tmp/+ Temporary files
+vendor/+ A place for third-party code. In a typical Rails application, this includes Ruby Gems, the Rails source code (if you install it into your project) and plugins containing additional prepackaged functionality.
-------------------------------------------------------------------------------------------------------------------------------------------
[options="header"]
|==========================================================================================================
|File/Folder |Purpose
|+README+ |This is a brief instruction manual for your application. Use it to tell others what your application does, how to set it up, and so on.
|+Rakefile+ |This file contains batch jobs that can be run from the terminal.
|+app/+ |Contains the controllers, models, and views for your application. You'll focus on this folder for the remainder of this guide.
|+config/+ |Configure your application's runtime rules, routes, database, and more.
|+db/+ |Shows your current database schema, as well as the database migrations. You'll learn about migrations shortly.
|+doc/+ |In-depth documentation for your application.
|+lib/+ |Extended modules for your application (not covered in this guide).
|+log/+ |Application log files.
|+public/+ |The only folder seen to the world as-is. This is where your images, javascript, stylesheets (CSS), and other static files go.
|+script/+ |Scripts provided by Rails to do recurring tasks, such as benchmarking, plugin installation, and starting the console or the web server.
|+test/+ |Unit tests, fixtures, and other test apparatus. These are covered in link:../testing_rails_applications.html[Testing Rails Applications]
|+tmp/+ |Temporary files
|+vendor/+ |A place for third-party code. In a typical Rails application, this includes Ruby Gems, the Rails source code (if you install it into your project) and plugins containing additional prepackaged functionality.
|==========================================================================================================
=== Configuring a Database
@@ -339,25 +338,24 @@ NOTE: While scaffolding will get you up and running quickly, the "one size fits
The scaffold generator will build 13 files in your application, along with some folders, and edit one more. Here's a quick overview of what it creates:
[grid="all"]
`---------------------------------------------`--------------------------------------------------------------------------------------------
File Purpose
------------------------------------------------------------------------------------------------------------------------------------------
app/models/post.rb The Post model
db/migrate/20081013124235_create_posts.rb Migration to create the posts table in your database (your name will include a different timestamp)
app/views/posts/index.html.erb A view to display an index of all posts
app/views/posts/show.html.erb A view to display a single post
app/views/posts/new.html.erb A view to create a new post
app/views/posts/edit.html.erb A view to edit an existing post
app/views/layouts/posts.html.erb A view to control the overall look and feel of the other posts views
public/stylesheets/scaffold.css Cascading style sheet to make the scaffolded views look better
app/controllers/posts_controller.rb The Posts controller
test/functional/posts_controller_test.rb Functional testing harness for the posts controller
app/helpers/posts_helper.rb Helper functions to be used from the posts views
config/routes.rb Edited to include routing information for posts
test/fixtures/posts.yml Dummy posts for use in testing
test/unit/post_test.rb Unit testing harness for the posts model
-------------------------------------------------------------------------------------------------------------------------------------------
[options="header"]
|==========================================================================================================
|File |Purpose
|app/models/post.rb |The Post model
|db/migrate/20081013124235_create_posts.rb |Migration to create the posts table in your database (your name will include a different timestamp)
|app/views/posts/index.html.erb |A view to display an index of all posts
|app/views/posts/show.html.erb |A view to display a single post
|app/views/posts/new.html.erb |A view to create a new post
|app/views/posts/edit.html.erb |A view to edit an existing post
|app/views/layouts/posts.html.erb |A view to control the overall look and feel of the other posts views
|public/stylesheets/scaffold.css |Cascading style sheet to make the scaffolded views look better
|app/controllers/posts_controller.rb |The Posts controller
|test/functional/posts_controller_test.rb |Functional testing harness for the posts controller
|app/helpers/posts_helper.rb |Helper functions to be used from the posts views
|config/routes.rb |Edited to include routing information for posts
|test/fixtures/posts.yml |Dummy posts for use in testing
|test/unit/post_test.rb |Unit testing harness for the posts model
|==========================================================================================================
=== Running a Migration

113
railties/doc/guides/source/routing_outside_in.txt
View File

@@ -132,18 +132,17 @@ map.resources :photos
creates seven different routes in your application:
[grid="all"]
`----------`---------------`-----------`--------`-------------------------------------------
HTTP verb URL controller action used for
--------------------------------------------------------------------------------------------
GET /photos Photos index display a list of all photos
GET /photos/new Photos new return an HTML form for creating a new photo
POST /photos Photos create create a new photo
GET /photos/1 Photos show display a specific photo
GET /photos/1/edit Photos edit return an HTML form for editing a photo
PUT /photos/1 Photos update update a specific photo
DELETE /photos/1 Photos destroy delete a specific photo
--------------------------------------------------------------------------------------------
[options="header"]
|==========================================================================================================
|HTTP verb |URL |controller |action |used for
|GET |/photos |Photos |index |display a list of all photos
|GET |/photos/new |Photos |new |return an HTML form for creating a new photo
|POST |/photos |Photos |create |create a new photo
|GET |/photos/1 |Photos |show |display a specific photo
|GET |/photos/1/edit |Photos |edit |return an HTML form for editing a photo
|PUT |/photos/1 |Photos |update |update a specific photo
|DELETE |/photos/1 |Photos |destroy |delete a specific photo
|==========================================================================================================
For the specific routes (those that reference just a single resource), the identifier for the resource will be available within the corresponding controller action as +params[:id]+.
@@ -197,17 +196,16 @@ map.resource :geocoder
creates six different routes in your application:
[grid="all"]
`----------`---------------`-----------`--------`-------------------------------------------
HTTP verb URL controller action used for
--------------------------------------------------------------------------------------------
GET /geocoder/new Geocoders new return an HTML form for creating the new geocoder
POST /geocoder Geocoders create create the new geocoder
GET /geocoder Geocoders show display the one and only geocoder resource
GET /geocoder/edit Geocoders edit return an HTML form for editing the geocoder
PUT /geocoder Geocoders update update the one and only geocoder resource
DELETE /geocoder Geocoders destroy delete the geocoder resource
--------------------------------------------------------------------------------------------
[options="header"]
|==========================================================================================================
|HTTP verb |URL |controller |action |used for
|GET |/geocoder/new |Geocoders |new |return an HTML form for creating the new geocoder
|POST |/geocoder |Geocoders |create |create the new geocoder
|GET |/geocoder |Geocoders |show |display the one and only geocoder resource
|GET |/geocoder/edit |Geocoders |edit |return an HTML form for editing the geocoder
|PUT |/geocoder |Geocoders |update |update the one and only geocoder resource
|DELETE |/geocoder |Geocoders |destroy |delete the geocoder resource
|==========================================================================================================
NOTE: Even though the name of the resource is singular in +routes.rb+, the matching controller is still plural.
@@ -245,18 +243,17 @@ map.resources :photos, :controller => "images"
will recognize incoming URLs containing +photo+ but route the requests to the Images controller:
[grid="all"]
`----------`---------------`-----------`--------`-------------------------------------------
HTTP verb URL controller action used for
--------------------------------------------------------------------------------------------
GET /photos Images index display a list of all images
GET /photos/new Images new return an HTML form for creating a new image
POST /photos Images create create a new image
GET /photos/1 Images show display a specific image
GET /photos/1/edit Images edit return an HTML form for editing a image
PUT /photos/1 Images update update a specific image
DELETE /photos/1 Images destroy delete a specific image
--------------------------------------------------------------------------------------------
[options="header"]
|==========================================================================================================
|HTTP verb |URL |controller |action |used for
|GET |/photos |Images |index |display a list of all images
|GET |/photos/new |Images |new |return an HTML form for creating a new image
|POST |/photos |Images |create |create a new image
|GET |/photos/1 |Images |show |display a specific image
|GET |/photos/1/edit |Images |edit |return an HTML form for editing a image
|PUT |/photos/1 |Images |update |update a specific image
|DELETE |/photos/1 |Images |destroy |delete a specific image
|==========================================================================================================
NOTE: The helpers will be generated with the name of the resource, not the name of the controller. So in this case, you'd still get +photos_path+, +new_photo_path+, and so on.
@@ -328,18 +325,17 @@ map.resources :photos, :as => "images"
will recognize incoming URLs containing +image+ but route the requests to the Photos controller:
[grid="all"]
`----------`---------------`-----------`--------`-------------------------------------------
HTTP verb URL controller action used for
--------------------------------------------------------------------------------------------
GET /images Photos index display a list of all photos
GET /images/new Photos new return an HTML form for creating a new photo
POST /images Photos create create a new photo
GET /images/1 Photos show display a specific photo
GET /images/1/edit Photos edit return an HTML form for editing a photo
PUT /images/1 Photos update update a specific photo
DELETE /images/1 Photos destroy delete a specific photo
--------------------------------------------------------------------------------------------
[options="header"]
|==========================================================================================================
|HTTP verb |URL |controller |action |used for
|GET |/images |Photos |index |display a list of all photos
|GET |/images/new |Photos |new |return an HTML form for creating a new photo
|POST |/images |Photos |create |create a new photo
|GET |/images/1 |Photos |show |display a specific photo
|GET |/images/1/edit |Photos |edit |return an HTML form for editing a photo
|PUT |/images/1 |Photos |update |update a specific photo
|DELETE |/images/1 |Photos |destroy |delete a specific photo
|==========================================================================================================
NOTE: The helpers will be generated with the name of the resource, not the path name. So in this case, you'd still get +photos_path+, +new_photo_path+, and so on.
@@ -452,18 +448,17 @@ end
In addition to the routes for magazines, this declaration will also create routes for ads, each of which requires the specification of a magazine in the URL:
[grid="all"]
`----------`-----------------------`-----------`--------`-------------------------------------------
HTTP verb URL controller action used for
--------------------------------------------------------------------------------------------
GET /magazines/1/ads Ads index display a list of all ads for a specific magazine
GET /magazines/1/ads/new Ads new return an HTML form for creating a new ad belonging to a specific magazine
POST /magazines/1/ads Ads create create a new ad belonging to a specific magazine
GET /magazines/1/ads/1 Ads show display a specific ad belonging to a specific magazine
GET /magazines/1/ads/1/edit Ads edit return an HTML form for editing an ad belonging to a specific magazine
PUT /magazines/1/ads/1 Ads update update a specific ad belonging to a specific magazine
DELETE /magazines/1/ads/1 Ads destroy delete a specific ad belonging to a specific magazine
--------------------------------------------------------------------------------------------
[options="header"]
|==========================================================================================================
|HTTP verb |URL |controller |action |used for
|GET |/magazines/1/ads |Ads |index |display a list of all ads for a specific magazine
|GET |/magazines/1/ads/new |Ads |new |return an HTML form for creating a new ad belonging to a specific magazine
|POST |/magazines/1/ads |Ads |create |create a new ad belonging to a specific magazine
|GET |/magazines/1/ads/1 |Ads |show |display a specific ad belonging to a specific magazine
|GET |/magazines/1/ads/1/edit |Ads |edit |return an HTML form for editing an ad belonging to a specific magazine
|PUT |/magazines/1/ads/1 |Ads |update |update a specific ad belonging to a specific magazine
|DELETE |/magazines/1/ads/1 |Ads |destroy |delete a specific ad belonging to a specific magazine
|==========================================================================================================
This will also create routing helpers such as +magazine_ads_url+ and +edit_magazine_ad_path+.