vendor/rails/railties/doc/guides/html/index.html

   1 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
   2 <html xmlns="http://www.w3.org/1999/xhtml" lang="en" xml:lang="en">
   3 <head>
   4         <meta http-equiv="Content-Type" content="text/html; charset=UTF-8" />
   5         <title>Ruby on Rails guides</title>
   6         <!--[if lt IE 8]>
   7         <script src="http://ie7-js.googlecode.com/svn/version/2.0(beta3)/IE8.js" type="text/javascript"></script>
   8         <![endif]-->
   9         <link href="stylesheets/base.css" media="screen" rel="Stylesheet" type="text/css" />
  10         <link href="stylesheets/forms.css" media="screen" rel="Stylesheet" type="text/css" />
  11         <link href="stylesheets/more.css" media="screen" rel="Stylesheet" type="text/css" />
  12         <style type="text/css">
  13                 div#container {
  14         max-width: 900px;
  15         padding-bottom: 3em;
  16 }
  17
  18 div#content {
  19         margin-left: 200px;
  20 }
  21
  22 div#container.notoc {
  23         max-width: 600px;
  24 }
  25
  26 .notoc div#content {
  27         margin-left: 0;
  28 }
  29
  30 pre {
  31         line-height: 1.4em;
  32 }
  33
  34 #content p tt {
  35         background: #eeeeee;
  36         border: solid 1px #cccccc;
  37         padding: 3px;
  38 }
  39
  40 dt {
  41         font-weight: bold;
  42 }
  43
  44 #content dt tt {
  45         font-size: 10pt;
  46 }
  47
  48 dd {
  49         margin-left: 3em;
  50 }
  51
  52 #content dt tt, #content pre tt {
  53         background: none;
  54         padding: 0;
  55         border: 0;
  56 }
  57
  58 #content .olist ol {
  59         margin-left: 2em;
  60 }
  61
  62 #header {
  63         position: relative;
  64         max-width: 840px;
  65         margin-left: auto;
  66         margin-right: auto;
  67 }
  68
  69 #header.notoc {
  70         max-width: 580px;
  71 }
  72
  73 #logo {
  74         position: absolute;
  75         left: 10px;
  76         top: 10px;
  77         width: 110px;
  78         height: 140px;
  79 }
  80
  81 div#header h1#site_title {
  82         background: url('images/ruby_on_rails_by_mike_rundle2.gif') top left no-repeat;
  83         position: absolute;
  84         width: 392px;
  85         height: 55px;
  86         left: 145px;
  87         top: 20px;
  88         margin: 0;
  89         padding: 0;
  90 }
  91
  92 #site_title span {
  93         display: none;
  94 }
  95
  96 #site_title_tagline {
  97         display: none;
  98 }
  99
 100 ul#navMain {
 101         position: absolute;
 102         margin: 0;
 103         padding: 0;
 104         top: 97px;
 105         left: 145px;
 106 }
 107
 108 .left-floaty, .right-floaty {
 109         padding: 15px;
 110 }
 111
 112 .admonitionblock,
 113 .tableblock {
 114         margin-left: 1em;
 115         margin-right: 1em;
 116         margin-top: 0.25em;
 117         margin-bottom: 1em;
 118 }
 119
 120 .admonitionblock .icon {
 121         padding-right: 8px;
 122 }
 123
 124 .admonitionblock .content {
 125         border: solid 1px #ffda78;
 126         background: #fffebd;
 127         padding: 10px;
 128         padding-top: 8px;
 129         padding-bottom: 8px;
 130 }
 131
 132 .admonitionblock .title {
 133         font-size: 140%;
 134         margin-bottom: 0.5em;
 135 }
 136
 137 .tableblock table {
 138         border: solid 1px #aaaaff;
 139         background: #f0f0ff;
 140 }
 141
 142 .tableblock th {
 143         background: #e0e0e0;
 144 }
 145
 146 .tableblock th,
 147 .tableblock td {
 148         padding: 3px;
 149         padding-left: 5px;
 150         padding-right: 5px;
 151 }
 152
 153 .sidebarblock {
 154         margin-top: 0.25em;
 155         margin: 1em;
 156         border: solid 1px #ccccbb;
 157         padding: 8px;
 158         background: #ffffe0;
 159 }
 160
 161 .sidebarblock .sidebar-title {
 162         font-size: 140%;
 163         font-weight: 600;
 164         margin-bottom: 0.3em;
 165 }
 166
 167 .sidebarblock .sidebar-content > .para:last-child > p {
 168         margin-bottom: 0;
 169 }
 170
 171 .sidebarblock .sidebar-title a {
 172         text-decoration: none;
 173 }
 174
 175 .sidebarblock .sidebar-title a:hover {
 176         text-decoration: underline;
 177 }
 178
 179         </style>
 180 </head>
 181 <body>
 182         <div id="header"  class="notoc">
 183                 <div id="logo">
 184                         <a href="index.html" title="Ruby on Rails"><img src="images/rails_logo_remix.gif" alt="Rails" height="140" width="110" /></a>
 185                 </div>
 186
 187                 <h1 id="site_title"><span>Ruby on Rails</span></h1>
 188                 <h2 id="site_title_tagline">Sustainable productivity for web-application development</h2>
 189
 190                 <ul id="navMain">
 191                         <li class="first-child"><a href="http://www.rubyonrails.org/" title="Ruby on Rails" class="ruby_on_rails">Ruby on Rails</a></li>
 192                         <li><a class="manuals" href="index.html" title="Manuals Index">Guides Index</a></li>
 193                 </ul>
 194         </div>
 195
 196         <div id="container" class="notoc">
 197
 198                 <div id="content">
 199                                 <h1>Ruby on Rails guides</h1>
 200                         <div id="preamble">
 201 <div class="sectionbody">
 202 <div class="admonitionblock">
 203 <table><tr>
 204 <td class="icon">
 205 <img src="./images/icons/warning.png" alt="Warning" />
 206 </td>
 207 <td class="content">This page is the result of ongoing <a href="http://hackfest.rubyonrails.org/guide">Rails Guides hackfest</a> and a work in progress.</td>
 208 </tr></table>
 209 </div>
 210 <div class="admonitionblock">
 211 <table><tr>
 212 <td class="icon">
 213 <img src="./images/icons/caution.png" alt="Caution" />
 214 </td>
 215 <td class="content">Guides marked with this icon are currently being worked on. While they might still be useful to you, they may contain incomplete information and even errors. You can help by reviewing them and posting your comments and corrections at the respective Lighthouse ticket.</td>
 216 </tr></table>
 217 </div>
 218 <h2>Start Here</h2>
 219 <div class="sidebarblock">
 220 <div class="sidebar-content">
 221 <div class="sidebar-title"><a href="getting_started_with_rails.html">Getting Started with Rails</a></div>
 222 <div class="para"><p>Everything you need to know to install Rails and create your first application.</p></div>
 223 </div></div>
 224 <h2>Models</h2>
 225 <div class="sidebarblock">
 226 <div class="sidebar-content">
 227 <div class="sidebar-title"><a href="migrations.html">Rails Database Migrations</a></div>
 228 <div class="para"><p>This guide covers how you can use Active Record migrations to alter your database in a structured and organized manner.</p></div>
 229 </div></div>
 230 <div class="sidebarblock">
 231 <div class="sidebar-content">
 232 <div class="sidebar-title"><a href="association_basics.html">Active Record Associations</a></div>
 233 <div class="para"><p>This guide covers all the associations provided by Active Record.</p></div>
 234 </div></div>
 235 <div class="sidebarblock">
 236 <div class="sidebar-content">
 237 <div class="sidebar-title"><a href="finders.html">Active Record Finders</a></div>
 238 <div class="admonitionblock">
 239 <table><tr>
 240 <td class="icon">
 241 <img src="./images/icons/caution.png" alt="Caution" />
 242 </td>
 243 <td class="content"><a href="http://rails.lighthouseapp.com/projects/16213/tickets/16">Lighthouse Ticket</a></td>
 244 </tr></table>
 245 </div>
 246 <div class="para"><p>This guide covers the find method defined in ActiveRecord::Base, as well as named scopes.</p></div>
 247 </div></div>
 248 <h2>Views</h2>
 249 <div class="sidebarblock">
 250 <div class="sidebar-content">
 251 <div class="sidebar-title"><a href="layouts_and_rendering.html">Layouts and Rendering in Rails</a></div>
 252 <div class="para"><p>This guide covers the basic layout features of Action Controller and Action View,
 253 including rendering and redirecting, using <tt>content_for</tt> blocks, and working
 254 with partials.</p></div>
 255 </div></div>
 256 <div class="sidebarblock">
 257 <div class="sidebar-content">
 258 <div class="sidebar-title"><a href="form_helpers.html">Action View Form Helpers</a></div>
 259 <div class="admonitionblock">
 260 <table><tr>
 261 <td class="icon">
 262 <img src="./images/icons/caution.png" alt="Caution" />
 263 </td>
 264 <td class="content"><a href="http://rails.lighthouseapp.com/projects/16213/tickets/1">Lighthouse Ticket</a></td>
 265 </tr></table>
 266 </div>
 267 <div class="para"><p>Guide to using built in Form helpers.</p></div>
 268 </div></div>
 269 <h2>Controllers</h2>
 270 <div class="sidebarblock">
 271 <div class="sidebar-content">
 272 <div class="sidebar-title"><a href="routing_outside_in.html">Rails Routing from the Outside In</a></div>
 273 <div class="para"><p>This guide covers the user-facing features of Rails routing. If you want to
 274 understand how to use routing in your own Rails applications, start here.</p></div>
 275 </div></div>
 276 <div class="sidebarblock">
 277 <div class="sidebar-content">
 278 <div class="sidebar-title"><a href="actioncontroller_basics.html">Basics of Action Controller</a></div>
 279 <div class="para"><p>This guide covers how controllers work and how they fit into the request cycle in your application. It includes sessions, filters, and cookies, data streaming, and dealing with exceptions raised by a request, among other topics.</p></div>
 280 </div></div>
 281 <div class="sidebarblock">
 282 <div class="sidebar-content">
 283 <div class="sidebar-title"><a href="caching_with_rails.html">Rails Caching</a></div>
 284 <div class="admonitionblock">
 285 <table><tr>
 286 <td class="icon">
 287 <img src="./images/icons/caution.png" alt="Caution" />
 288 </td>
 289 <td class="content"><a href="http://rails.lighthouseapp.com/projects/16213/tickets/10">Lighthouse Ticket</a></td>
 290 </tr></table>
 291 </div>
 292 <div class="para"><p>This guide covers the three types of caching that Rails provides by default.</p></div>
 293 </div></div>
 294 <h2>Digging Deeper</h2>
 295 <div class="sidebarblock">
 296 <div class="sidebar-content">
 297 <div class="sidebar-title"><a href="testing_rails_applications.html">Testing Rails Applications</a></div>
 298 <div class="admonitionblock">
 299 <table><tr>
 300 <td class="icon">
 301 <img src="./images/icons/caution.png" alt="Caution" />
 302 </td>
 303 <td class="content"><a href="http://rails.lighthouseapp.com/projects/16213/tickets/8">Lighthouse Ticket</a></td>
 304 </tr></table>
 305 </div>
 306 <div class="para"><p>This is a rather comprehensive guide to doing both unit and functional tests
 307 in Rails. It covers everything from &#8220;What is a test?&#8221; to the testing APIs.
 308 Enjoy.</p></div>
 309 </div></div>
 310 <div class="sidebarblock">
 311 <div class="sidebar-content">
 312 <div class="sidebar-title"><a href="security.html">Securing Rails Applications</a></div>
 313 <div class="para"><p>This guide describes common security problems in web applications and how to
 314 avoid them with Rails.</p></div>
 315 </div></div>
 316 <div class="sidebarblock">
 317 <div class="sidebar-content">
 318 <div class="sidebar-title"><a href="debugging_rails_applications.html">Debugging Rails Applications</a></div>
 319 <div class="para"><p>This guide describes how to debug Rails applications. It covers the different
 320 ways of achieving this and how to understand what is happening "behind the scenes"
 321 of your code.</p></div>
 322 </div></div>
 323 <div class="sidebarblock">
 324 <div class="sidebar-content">
 325 <div class="sidebar-title"><a href="benchmarking_and_profiling.html">Benchmarking and Profiling Rails Applications</a></div>
 326 <div class="admonitionblock">
 327 <table><tr>
 328 <td class="icon">
 329 <img src="./images/icons/caution.png" alt="Caution" />
 330 </td>
 331 <td class="content"><a href="http://rails.lighthouseapp.com/projects/16213/tickets/4">Lighthouse Ticket</a></td>
 332 </tr></table>
 333 </div>
 334 <div class="para"><p>This guide covers ways to analyze and optimize your running Rails code.</p></div>
 335 </div></div>
 336 <div class="sidebarblock">
 337 <div class="sidebar-content">
 338 <div class="sidebar-title"><a href="creating_plugins.html">The Basics of Creating Rails Plugins</a></div>
 339 <div class="para"><p>This guide covers how to build a plugin to extend the functionality of Rails.</p></div>
 340 </div></div>
 341 <div class="para"><p>Authors who have contributed to complete guides are listed <a href="authors.html">here</a>.</p></div>
 342 <div class="para"><p>This work is licensed under a <a href="http://creativecommons.org/licenses/by-nc-sa/3.0/">Creative Commons Attribution-Noncommercial-Share Alike 3.0  License</a></p></div>
 343 </div>
 344 </div>
 345
 346                 </div>
 347         </div>
 348 </body>
 349 </html>