aboutsummaryrefslogtreecommitdiffstats
path: root/railties/doc/guides/source
diff options
context:
space:
mode:
Diffstat (limited to 'railties/doc/guides/source')
-rw-r--r--railties/doc/guides/source/index.txt28
-rw-r--r--railties/doc/guides/source/stylesheets/base.css358
-rw-r--r--railties/doc/guides/source/stylesheets/forms.css35
-rw-r--r--railties/doc/guides/source/stylesheets/more.css82
-rw-r--r--railties/doc/guides/source/templates/guides.html.erb97
-rw-r--r--railties/doc/guides/source/templates/inline.css165
6 files changed, 751 insertions, 14 deletions
diff --git a/railties/doc/guides/source/index.txt b/railties/doc/guides/source/index.txt
index dfbb3d2799..4ca842bd75 100644
--- a/railties/doc/guides/source/index.txt
+++ b/railties/doc/guides/source/index.txt
@@ -9,7 +9,7 @@ CAUTION: Guides marked with this icon are currently being worked on. While they
<h2>Start Here</h2>
++++++++++++++++++++++++++++++++++++++
-.link:getting_started_with_rails/getting_started_with_rails.html[Getting Started with Rails]
+.link:getting_started_with_rails.html[Getting Started with Rails]
***********************************************************
CAUTION: link:http://rails.lighthouseapp.com/projects/16213/tickets/2[Lighthouse Ticket]
@@ -20,17 +20,17 @@ Everything you need to know to install Rails and create your first application.
<h2>Models</h2>
++++++++++++++++++++++++++++++++++++++
-.link:migrations/migrations.html[Rails Database Migrations]
+.link:migrations.html[Rails Database Migrations]
***********************************************************
This guide covers how you can use Active Record migrations to alter your database in a structured and organized manner.
***********************************************************
-.link:activerecord/association_basics.html[Active Record Associations]
+.link:association_basics.html[Active Record Associations]
***********************************************************
This guide covers all the associations provided by Active Record.
***********************************************************
-.link:activerecord/finders.html[Active Record Finders]
+.link:finders.html[Active Record Finders]
***********************************************************
CAUTION: link:http://rails.lighthouseapp.com/projects/16213/tickets/16[Lighthouse Ticket]
@@ -41,14 +41,14 @@ This guide covers the find method defined in ActiveRecord::Base, as well as name
<h2>Views</h2>
++++++++++++++++++++++++++++++++++++++
-.link:actionview/layouts_and_rendering.html[Layouts and Rendering in Rails]
+.link:layouts_and_rendering.html[Layouts and Rendering in Rails]
***********************************************************
This guide covers the basic layout features of Action Controller and Action View,
including rendering and redirecting, using +content_for_ blocks, and working
with partials.
***********************************************************
-.link:forms/form_helpers.html[Action View Form Helpers]
+.link:form_helpers.html[Action View Form Helpers]
***********************************************************
CAUTION: link:http://rails.lighthouseapp.com/projects/16213/tickets/1[Lighthouse Ticket]
@@ -59,20 +59,20 @@ Guide to using built in Form helpers.
<h2>Controllers</h2>
++++++++++++++++++++++++++++++++++++++
-.link:routing/routing_outside_in.html[Rails Routing from the Outside In]
+.link:routing_outside_in.html[Rails Routing from the Outside In]
***********************************************************
This guide covers the user-facing features of Rails routing. If you want to
understand how to use routing in your own Rails applications, start here.
***********************************************************
-.link:actioncontroller/actioncontroller.html[Basics of Action Controller]
+.link:actioncontroller_basics.html[Basics of Action Controller]
***********************************************************
CAUTION: link:http://rails.lighthouseapp.com/projects/16213/tickets/17[Lighthouse Ticket]
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.
***********************************************************
-.link:caching/caching_with_rails.html[Rails Caching]
+.link:caching_with_rails.html[Rails Caching]
***********************************************************
CAUTION: link:http://rails.lighthouseapp.com/projects/16213/tickets/10[Lighthouse Ticket]
@@ -83,7 +83,7 @@ This guide covers the three types of caching that Rails provides by default.
<h2>Digging Deeper</h2>
++++++++++++++++++++++++++++++++++++++
-.link:testing_rails_applications/testing_rails_applications.html[Testing Rails Applications]
+.link:testing_rails_applications.html[Testing Rails Applications]
***********************************************************
CAUTION: link:http://rails.lighthouseapp.com/projects/16213/tickets/8[Lighthouse Ticket]
@@ -92,7 +92,7 @@ in Rails. It covers everything from ``What is a test?'' to the testing APIs.
Enjoy.
***********************************************************
-.link:securing_rails_applications/security.html[Securing Rails Applications]
+.link:security.html[Securing Rails Applications]
***********************************************************
CAUTION: link:http://rails.lighthouseapp.com/projects/16213/tickets/7[Lighthouse Ticket]
@@ -100,7 +100,7 @@ This manual describes common security problems in web applications and how to
avoid them with Rails.
***********************************************************
-.link:debugging/debugging_rails_applications.html[Debugging Rails Applications]
+.link:debugging_rails_applications.html[Debugging Rails Applications]
***********************************************************
CAUTION: link:http://rails.lighthouseapp.com/projects/16213/tickets/5[Lighthouse Ticket]
@@ -109,14 +109,14 @@ ways of achieving this and how to understand what is happening "behind the scene
of your code.
***********************************************************
-.link:benchmarking_and_profiling/index.html[Benchmarking and Profiling Rails Applications]
+.link:benchmarking_and_profiling.html[Benchmarking and Profiling Rails Applications]
***********************************************************
CAUTION: link:http://rails.lighthouseapp.com/projects/16213/tickets/4[Lighthouse Ticket]
This guide covers ways to analyze and optimize your running Rails code.
***********************************************************
-.link:creating_plugins/creating_plugins.html[The Basics of Creating Rails Plugins]
+.link:creating_plugins.html[The Basics of Creating Rails Plugins]
***********************************************************
This guide covers how to build a plugin to extend the functionality of Rails.
***********************************************************
diff --git a/railties/doc/guides/source/stylesheets/base.css b/railties/doc/guides/source/stylesheets/base.css
new file mode 100644
index 0000000000..76ee6e2ca9
--- /dev/null
+++ b/railties/doc/guides/source/stylesheets/base.css
@@ -0,0 +1,358 @@
+/* ----------------------------------------------------------------------------
+
+ Ruby on Rails, hijacked for Hieraki
+ Stylesheet for http://rubyonrails.org
+
+ 1. General HTML elements
+ 2. General classes
+ 3. General structure
+ 1. header
+ 2. Content
+ 3. Sidebar
+ 4. Sitewide elements
+ 1. Introduction boxes
+ 2. Navigation
+ 5. Elements for specific areas
+ 1. Weblog
+
+---------------------------------------------------------------------------- */
+
+* {
+ margin: 0;
+ padding: 0;
+}
+
+body {
+ color: #333333;
+
+ background-color: #FFFFFF;
+ background-image: url(../images/header_backdrop.png);
+ background-repeat: repeat-x;
+ background-position: 0 -25px;
+
+ font-size: 80%;
+ font-family: verdana, helvetica, arial, sans-serif;
+ line-height: 1.7em;
+
+ /* Center in IE5.5 */
+ text-align: center;
+}
+
+h1 {
+ font-size: 2em;
+ font-weight: normal;
+ letter-spacing: -0.04em;
+}
+
+h2 {
+ font-size: 1.5em;
+ font-weight: normal;
+ letter-spacing: -0.04em;
+}
+
+h1,h2,h3,h4,h5,h6 {
+ margin-top: 1em;
+ margin-bottom: 0.5em;
+}
+.pageheader a:link, .pageheader a:visited{
+ color: #333;
+ text-decoration: none;
+}
+
+img {
+ border: none;
+}
+
+p {
+ margin-bottom: 1em;
+}
+
+a:link {
+ color: #BB2233;
+}
+
+a:visited {
+ color: #991122;
+}
+
+a:hover {
+ color: #CC2233;
+ background-color: #EEEEEE;
+}
+
+a:active {
+}
+
+ul {
+ margin-top: 1em;
+ list-style-type: none;
+}
+
+ul li {
+ margin-left: 0.5em;
+ padding-left: 1em;
+
+ background-image: url(../images/bullet.gif);
+ background-repeat: no-repeat;
+ background-position: 0 0.55em;
+}
+
+/* ----------------------------------------------------------------------------
+ Structure
+---------------------------------------------------------------------------- */
+
+div#container {
+ width: 90%;
+ max-width: 790px;
+
+ margin-top: 10px;
+ margin-left: auto;
+ margin-right: auto;
+
+ font-size: 1em;
+
+ /* Don't center text, only div#container */
+ text-align: left;
+}
+
+div#header {
+ /* This height controls the vertical position of #content and #sidebar */
+ height: 160px;
+ overflow: hidden;
+}
+
+div#header h1 {
+ height: 30px;
+
+ margin: 0;
+ margin-top: 10px;
+ margin-left: 100px;
+ padding: 0;
+ font-weight: bold;
+ font-size: 24pt;
+}
+div#header p {
+ height: 30px;
+ margin: 0;
+ margin-left: 160px;
+ padding: 0;
+ font-weight: bold;
+ font-size: 14pt;
+ color: #999;
+}
+/*
+div#logo {
+ float: left;
+ width: 110px;
+ height: 140px;
+ margin-right: 31px;
+}
+*/
+
+
+div#content {
+ margin-left: 170px;
+}
+
+/* Fix the IE only 3pixel jog - documented at http://www.positioniseverything.net/articles/hollyhack.html#haslayout \*/
+* html #content {
+ height: 1px;
+}
+/* End hide from IE5-mac */
+
+div#sidebar {
+ float: left;
+ width: 170px;
+ margin-top: -4px;
+ font-size: 0.8em;
+}
+
+div#sidebar h2 {
+ margin: 0;
+ font-size: 1.1em;
+ font-weight: bold;
+}
+
+div#sidebar ul {
+ margin-top: 0;
+ margin-bottom: 1em;
+ padding: 0;
+}
+
+div#sidebar ol li {
+ margin: 0 0 2px 0px;
+ padding: 0;
+ line-height: 1.3em;
+ background-image: none;
+}
+
+div#sidebar ol li a {
+ display: block;
+ width: 150px;
+ padding: 0.2em 0;
+}
+
+div#sidebar ul li {
+ margin-left: 10px;
+}
+
+div#sidebar ol>ol {
+ padding-left: 5px;
+ padding-right: 5px;
+ list-style-type: none;
+
+}
+
+div#sidebar ol>ol li a {
+ display: block;
+ width: 140px;
+ padding: 0.2em 0;
+ margin-left: 10px;
+
+}
+
+div#sidebar ol li a:hover {
+}
+
+/* ----------------------------------------------------------------------------
+ Specific site-wide elements
+---------------------------------------------------------------------------- */
+
+/* Introduction boxes */
+
+.introduction {
+
+ margin-bottom: 1em;
+ padding: 1em;
+ background-color: #D6DFE8;
+}
+
+.introduction p {
+ margin-bottom: 0;
+}
+
+/* Navigation */
+
+ul#navMain {
+ height: 22px;
+ margin: 0;
+ margin-left: 140px;
+ padding: 16px 0;
+
+ list-style-type: none;
+}
+
+ul#navMain li {
+ display: inline;
+ background-image: none;
+ margin: 0;
+ padding: 0;
+}
+
+ul#navMain li {
+ border-left: 1px solid #FFFFFF;
+}
+
+ul#navMain li.first-child {
+ /* Wouldn't it be nice if IE was up-to-date with the rest of the world so we could skip
+ superfluous classes? */
+ border-left: none;
+}
+
+ul#navMain li a {
+ padding: 0.2em 1em;
+
+ color: #FFFFFF;
+ text-decoration: none;
+}
+
+ul#navMain li.first-child a {
+ /* Wouldn't it be nice if IE was up-to-date with the rest of the world? */
+ padding-left: 0;
+}
+
+ul#navMain li a:hover {
+ text-decoration: underline;
+ background-color: transparent;
+}
+
+/* Mark the current page */
+ul#navMain li.current a {
+ font-weight: bold;
+}
+
+
+/* ----------------------------------------------------------------------------
+ Elements for specific areas
+---------------------------------------------------------------------------- */
+
+/* Weblog */
+
+.blogEntry {
+ margin-bottom: 2em;
+}
+
+.blogEntry h2 {
+ margin-top: 0;
+ margin-bottom: 0;
+}
+
+p.metaData {
+ color: #999999;
+ font-size: 0.9em;
+}
+
+
+/* Reference documentation */
+
+#reference #sidebar {
+ display: none;
+ width: 0;
+}
+
+#reference #content {
+ margin-left: 0;
+}
+
+#reference #content #api {
+ width: 100%;
+ height: 800px;
+}
+
+#reference #logo {
+ width: 80px;
+ height: 86px;
+
+ margin-right: 0;
+}
+
+#reference #logo img {
+ height: 84px;
+}
+
+#reference {
+ /* The header is smaller on the reference page, move the background up so the menu is in the
+ proper place still */
+ background-position: 0 -70px;
+}
+
+#reference #header {
+ height: 90px;
+}
+
+#reference #header h1 {
+ height: 24px;
+
+ margin-top: 2px;
+ margin-left: 0;
+
+ background-image: none;
+
+ text-indent: 0;
+ font-size: 1.5em;
+ font-weight: bold;
+
+}
+#reference #container {
+ max-width: 100%;
+} \ No newline at end of file
diff --git a/railties/doc/guides/source/stylesheets/forms.css b/railties/doc/guides/source/stylesheets/forms.css
new file mode 100644
index 0000000000..a3fce205b7
--- /dev/null
+++ b/railties/doc/guides/source/stylesheets/forms.css
@@ -0,0 +1,35 @@
+label, input {
+ display: block;
+ float: left;
+ margin-bottom: 10px;
+}
+
+label {
+ text-align: right;
+ width: 80px;
+ padding-right: 5px;
+ font-weight: bold;
+}
+
+
+table {
+ border: 0;
+}
+
+form>h1{
+
+ padding-bottom: 2px;
+ border-bottom: 1px solid gray;
+ margin-bottom: 30px;
+
+}
+
+td {
+ vertical-align: top;
+}
+
+#livepreview {
+ padding: 5px;
+ border: 1px solid #ccc;
+
+} \ No newline at end of file
diff --git a/railties/doc/guides/source/stylesheets/more.css b/railties/doc/guides/source/stylesheets/more.css
new file mode 100644
index 0000000000..9446b439d4
--- /dev/null
+++ b/railties/doc/guides/source/stylesheets/more.css
@@ -0,0 +1,82 @@
+.admin {
+ display:none;
+}
+
+#navAuthor {
+ text-align: right;
+}
+
+.bookinfo, .userinfo, pre {
+ padding: 10px;
+ background: #eee;
+ border: 1px solid #ccc;
+}
+
+pre {
+ overflow: auto;
+}
+
+#content pre, #content ul {
+ margin-bottom: 10px;
+}
+
+#content ol>ol {
+ padding-left : 30px;
+}
+
+div#header h1 a{
+ color: #333333;
+ text-decoration: none;
+}
+
+div#header p a{
+ text-decoration: none;
+ color: #999;
+}
+
+.left-floaty {
+ padding: 3px 15px;
+ float:left;
+}
+
+.right-floaty {
+ float:right;
+ padding: 3px 15px;
+}
+
+.figure {
+ border: 1px solid black;
+ line-height: normal;
+ background: #FFE;
+ margin: 1em;
+}
+
+.figure .caption {
+ background: #B00;
+ color: white;
+ font-weight: bold;
+ padding: 4px 24px 4px 8px;
+ margin-left: -4px;
+ border: 1px dotted #F77;
+}
+
+.figure .body {
+ padding: 0.5em;
+ margin-top: 0.5em;
+}
+
+.figure pre {
+ padding: 0px;
+ background: transparent;
+ border: none;
+ font-size: small;
+ font-family: mono;
+}
+
+.figure .lineno {
+ text-align: right;
+ color: #B00;
+ font-family: mono;
+ font-size: small;
+ padding-right: 1em;
+}
diff --git a/railties/doc/guides/source/templates/guides.html.erb b/railties/doc/guides/source/templates/guides.html.erb
new file mode 100644
index 0000000000..8966147e93
--- /dev/null
+++ b/railties/doc/guides/source/templates/guides.html.erb
@@ -0,0 +1,97 @@
+<%-
+ manuals_index_url = ENV['MANUALSONRAILS_INDEX_URL'] || "http://guides.rubyonrails.org/"
+ show_toc = ENV['MANUALSONRAILS_TOC'] != 'no'
+-%>
+<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
+<html xmlns="http://www.w3.org/1999/xhtml" lang="en" xml:lang="en">
+<head>
+ <meta http-equiv="Content-Type" content="text/html; charset=UTF-8" />
+ <title><%- if multi_page? && !is_preamble? -%><%=h current_chapter.plain_title %> :: <% end %><%=h title %></title>
+ <!--[if lt IE 8]>
+ <script src="http://ie7-js.googlecode.com/svn/version/2.0(beta3)/IE8.js" type="text/javascript"></script>
+ <![endif]-->
+ <link href="stylesheets/base.css" media="screen" rel="Stylesheet" type="text/css" />
+ <link href="stylesheets/forms.css" media="screen" rel="Stylesheet" type="text/css" />
+ <link href="stylesheets/more.css" media="screen" rel="Stylesheet" type="text/css" />
+ <style type="text/css">
+ <%= include_file('inline.css') %>
+ </style>
+</head>
+<body>
+ <div id="header" <% if !show_toc %> class="notoc"<% end %>>
+ <div id="logo">
+ <a href="http://www.rubyonrails.org/" title="Ruby on Rails"><img src="http://web.rubyonrails.com/images/rails_logo_remix.gif" alt="Rails" height="140" width="110" /></a>
+ </div>
+
+ <h1 id="site_title"><span>Ruby on Rails</span></h1>
+ <h2 id="site_title_tagline">Sustainable productivity for web-application development</h2>
+
+ <ul id="navMain">
+ <li class="first-child"><a href="http://www.rubyonrails.org/" title="Ruby on Rails" class="ruby_on_rails">Ruby on Rails</a></li>
+ <li><a class="manuals" href="<%=h manuals_index_url %>" title="Manuals Index">Guides Index</a></li>
+ </ul>
+ </div>
+
+ <div id="container"<% if !show_toc %> class="notoc"<% end %>>
+ <% if show_toc %>
+ <div id="sidebar">
+ <h2>Chapters</h2>
+ <%- if multi_page? -%>
+ <a href="<%=h chapters.first.basename %>">Preamble</a>
+ <%- end -%>
+ <ol>
+ <%- if multi_page? -%>
+ <%- for heading in table_of_contents -%>
+ <li>
+ <a href="<%=h heading.basename %>"><%= heading.title_without_numbers %></a>
+ <%- if !heading.children.empty? -%>
+ <ul>
+ <% for h in heading.children %>
+ <li><a href="<%=h h.basename %><%=h h.anchor %>"><%= h.title_without_numbers %></a></li>
+ <% end %>
+ </ul>
+ <%- end -%>
+ </li>
+ <%- end -%>
+ <%- else -%>
+ <%- for heading in table_of_contents -%>
+ <li>
+ <a href="<%=h heading.anchor %>"><%= heading.title_without_numbers %></a>
+ <%- if !heading.children.empty? -%>
+ <ul>
+ <% for h in heading.children %>
+ <li><a href="<%=h h.anchor %>"><%= h.title_without_numbers %></a></li>
+ <% end %>
+ </ul>
+ <%- end -%>
+ </li>
+ <%- end -%>
+ <%- end -%>
+ </ol>
+ </div>
+ <% end %>
+ <div id="content">
+ <%- if multi_page? && !is_preamble? -%>
+ <h2 id="<%=h current_chapter.anchor_id %>"><%= current_chapter.title %></h2>
+ <%- else -%>
+ <h1><%=h title %></h1>
+ <%- end -%>
+ <%= contents %>
+ <%- if multi_page? -%>
+ <div id="chapter_navigation">
+ <%- if prev_chapter -%>
+ <div class="left-floaty">
+ <a href="<%=h prev_chapter.basename %>">&laquo; <%= prev_chapter.title %></a>
+ </div>
+ <%- end -%>
+ <%- if next_chapter -%>
+ <div class="right-floaty">
+ <a href="<%=h next_chapter.basename %>"><%= next_chapter.title %> &raquo;</a>
+ </div>
+ <%- end -%>
+ </div>
+ <%- end -%>
+ </div>
+ </div>
+</body>
+</html>
diff --git a/railties/doc/guides/source/templates/inline.css b/railties/doc/guides/source/templates/inline.css
new file mode 100644
index 0000000000..66964c80e5
--- /dev/null
+++ b/railties/doc/guides/source/templates/inline.css
@@ -0,0 +1,165 @@
+div#container {
+ max-width: 900px;
+ padding-bottom: 3em;
+}
+
+div#content {
+ margin-left: 200px;
+}
+
+div#container.notoc {
+ max-width: 600px;
+}
+
+.notoc div#content {
+ margin-left: 0;
+}
+
+pre {
+ line-height: 1.4em;
+}
+
+#content p tt {
+ background: #eeeeee;
+ border: solid 1px #cccccc;
+ padding: 3px;
+}
+
+dt {
+ font-weight: bold;
+}
+
+#content dt tt {
+ font-size: 10pt;
+}
+
+dd {
+ margin-left: 3em;
+}
+
+#content dt tt, #content pre tt {
+ background: none;
+ padding: 0;
+ border: 0;
+}
+
+#content .olist ol {
+ margin-left: 2em;
+}
+
+#header {
+ position: relative;
+ max-width: 840px;
+ margin-left: auto;
+ margin-right: auto;
+}
+
+#header.notoc {
+ max-width: 580px;
+}
+
+#logo {
+ position: absolute;
+ left: 10px;
+ top: 10px;
+ width: 110px;
+ height: 140px;
+}
+
+div#header h1#site_title {
+ background: url('http://web.rubyonrails.com/images/ruby_on_rails_by_mike_rundle2.gif') top left no-repeat;
+ position: absolute;
+ width: 392px;
+ height: 55px;
+ left: 145px;
+ top: 20px;
+ margin: 0;
+ padding: 0;
+}
+
+#site_title span {
+ display: none;
+}
+
+#site_title_tagline {
+ display: none;
+}
+
+ul#navMain {
+ position: absolute;
+ margin: 0;
+ padding: 0;
+ top: 97px;
+ left: 145px;
+}
+
+.left-floaty, .right-floaty {
+ padding: 15px;
+}
+
+.admonitionblock,
+.tableblock {
+ margin-left: 1em;
+ margin-right: 1em;
+ margin-top: 0.25em;
+ margin-bottom: 1em;
+}
+
+.admonitionblock .icon {
+ padding-right: 8px;
+}
+
+.admonitionblock .content {
+ border: solid 1px #ffda78;
+ background: #fffebd;
+ padding: 10px;
+ padding-top: 8px;
+ padding-bottom: 8px;
+}
+
+.admonitionblock .title {
+ font-size: 140%;
+ margin-bottom: 0.5em;
+}
+
+.tableblock table {
+ border: solid 1px #aaaaff;
+ background: #f0f0ff;
+}
+
+.tableblock th {
+ background: #e0e0e0;
+}
+
+.tableblock th,
+.tableblock td {
+ padding: 3px;
+ padding-left: 5px;
+ padding-right: 5px;
+}
+
+.sidebarblock {
+ margin-top: 0.25em;
+ margin: 1em;
+ border: solid 1px #ccccbb;
+ padding: 8px;
+ background: #ffffe0;
+}
+
+.sidebarblock .sidebar-title {
+ font-size: 140%;
+ font-weight: 600;
+ margin-bottom: 0.3em;
+}
+
+.sidebarblock .sidebar-content > .para:last-child > p {
+ margin-bottom: 0;
+}
+
+.sidebarblock .sidebar-title a {
+ text-decoration: none;
+}
+
+.sidebarblock .sidebar-title a:hover {
+ text-decoration: underline;
+}
generated by cgit v1.2.3 (git 2.25.1) at 2025-04-29 04:34:51 +0000