guides 0.5.0

data/lib/guides/templates/assets/stylesheets/syntaxhighlighter/shThemeMidnight.css

@@ -0,0 +1,113 @@
+/**
+ * SyntaxHighlighter
+ * http://alexgorbatchev.com/SyntaxHighlighter
+ *
+ * SyntaxHighlighter is donationware. If you are using it, please donate.
+ * http://alexgorbatchev.com/SyntaxHighlighter/donate.html
+ *
+ * @version
+ * 3.0.83 (July 02 2010)
+ * 
+ * @copyright
+ * Copyright (C) 2004-2010 Alex Gorbatchev.
+ *
+ * @license
+ * Dual licensed under the MIT and GPL licenses.
+ */
+.syntaxhighlighter {
+  background-color: #0f192a !important;
+}
+.syntaxhighlighter .line.alt1 {
+  background-color: #0f192a !important;
+}
+.syntaxhighlighter .line.alt2 {
+  background-color: #0f192a !important;
+}
+.syntaxhighlighter .line.highlighted.alt1, .syntaxhighlighter .line.highlighted.alt2 {
+  background-color: #253e5a !important;
+}
+.syntaxhighlighter .line.highlighted.number {
+  color: #38566f !important;
+}
+.syntaxhighlighter table caption {
+  color: #d1edff !important;
+}
+.syntaxhighlighter .gutter {
+  color: #afafaf !important;
+}
+.syntaxhighlighter .gutter .line {
+  border-right: 3px solid #435a5f !important;
+}
+.syntaxhighlighter .gutter .line.highlighted {
+  background-color: #435a5f !important;
+  color: #0f192a !important;
+}
+.syntaxhighlighter.printing .line .content {
+  border: none !important;
+}
+.syntaxhighlighter.collapsed {
+  overflow: visible !important;
+}
+.syntaxhighlighter.collapsed .toolbar {
+  color: #428bdd !important;
+  background: black !important;
+  border: 1px solid #435a5f !important;
+}
+.syntaxhighlighter.collapsed .toolbar a {
+  color: #428bdd !important;
+}
+.syntaxhighlighter.collapsed .toolbar a:hover {
+  color: #1dc116 !important;
+}
+.syntaxhighlighter .toolbar {
+  color: #d1edff !important;
+  background: #435a5f !important;
+  border: none !important;
+}
+.syntaxhighlighter .toolbar a {
+  color: #d1edff !important;
+}
+.syntaxhighlighter .toolbar a:hover {
+  color: #8aa6c1 !important;
+}
+.syntaxhighlighter .plain, .syntaxhighlighter .plain a {
+  color: #d1edff !important;
+}
+.syntaxhighlighter .comments, .syntaxhighlighter .comments a {
+  color: #428bdd !important;
+}
+.syntaxhighlighter .string, .syntaxhighlighter .string a {
+  color: #1dc116 !important;
+}
+.syntaxhighlighter .keyword {
+  color: #b43d3d !important;
+}
+.syntaxhighlighter .preprocessor {
+  color: #8aa6c1 !important;
+}
+.syntaxhighlighter .variable {
+  color: #ffaa3e !important;
+}
+.syntaxhighlighter .value {
+  color: #f7e741 !important;
+}
+.syntaxhighlighter .functions {
+  color: #ffaa3e !important;
+}
+.syntaxhighlighter .constants {
+  color: #e0e8ff !important;
+}
+.syntaxhighlighter .script {
+  font-weight: bold !important;
+  color: #b43d3d !important;
+  background-color: none !important;
+}
+.syntaxhighlighter .color1, .syntaxhighlighter .color1 a {
+  color: #f8bb00 !important;
+}
+.syntaxhighlighter .color2, .syntaxhighlighter .color2 a {
+  color: white !important;
+}
+.syntaxhighlighter .color3, .syntaxhighlighter .color3 a {
+  color: #ffaa3e !important;
+}

data/lib/guides/templates/assets/stylesheets/syntaxhighlighter/shThemeRDark.css

@@ -0,0 +1,113 @@
+/**
+ * SyntaxHighlighter
+ * http://alexgorbatchev.com/SyntaxHighlighter
+ *
+ * SyntaxHighlighter is donationware. If you are using it, please donate.
+ * http://alexgorbatchev.com/SyntaxHighlighter/donate.html
+ *
+ * @version
+ * 3.0.83 (July 02 2010)
+ * 
+ * @copyright
+ * Copyright (C) 2004-2010 Alex Gorbatchev.
+ *
+ * @license
+ * Dual licensed under the MIT and GPL licenses.
+ */
+.syntaxhighlighter {
+  background-color: #1b2426 !important;
+}
+.syntaxhighlighter .line.alt1 {
+  background-color: #1b2426 !important;
+}
+.syntaxhighlighter .line.alt2 {
+  background-color: #1b2426 !important;
+}
+.syntaxhighlighter .line.highlighted.alt1, .syntaxhighlighter .line.highlighted.alt2 {
+  background-color: #323e41 !important;
+}
+.syntaxhighlighter .line.highlighted.number {
+  color: #b9bdb6 !important;
+}
+.syntaxhighlighter table caption {
+  color: #b9bdb6 !important;
+}
+.syntaxhighlighter .gutter {
+  color: #afafaf !important;
+}
+.syntaxhighlighter .gutter .line {
+  border-right: 3px solid #435a5f !important;
+}
+.syntaxhighlighter .gutter .line.highlighted {
+  background-color: #435a5f !important;
+  color: #1b2426 !important;
+}
+.syntaxhighlighter.printing .line .content {
+  border: none !important;
+}
+.syntaxhighlighter.collapsed {
+  overflow: visible !important;
+}
+.syntaxhighlighter.collapsed .toolbar {
+  color: #5ba1cf !important;
+  background: black !important;
+  border: 1px solid #435a5f !important;
+}
+.syntaxhighlighter.collapsed .toolbar a {
+  color: #5ba1cf !important;
+}
+.syntaxhighlighter.collapsed .toolbar a:hover {
+  color: #5ce638 !important;
+}
+.syntaxhighlighter .toolbar {
+  color: white !important;
+  background: #435a5f !important;
+  border: none !important;
+}
+.syntaxhighlighter .toolbar a {
+  color: white !important;
+}
+.syntaxhighlighter .toolbar a:hover {
+  color: #e0e8ff !important;
+}
+.syntaxhighlighter .plain, .syntaxhighlighter .plain a {
+  color: #b9bdb6 !important;
+}
+.syntaxhighlighter .comments, .syntaxhighlighter .comments a {
+  color: #878a85 !important;
+}
+.syntaxhighlighter .string, .syntaxhighlighter .string a {
+  color: #5ce638 !important;
+}
+.syntaxhighlighter .keyword {
+  color: #5ba1cf !important;
+}
+.syntaxhighlighter .preprocessor {
+  color: #435a5f !important;
+}
+.syntaxhighlighter .variable {
+  color: #ffaa3e !important;
+}
+.syntaxhighlighter .value {
+  color: #009900 !important;
+}
+.syntaxhighlighter .functions {
+  color: #ffaa3e !important;
+}
+.syntaxhighlighter .constants {
+  color: #e0e8ff !important;
+}
+.syntaxhighlighter .script {
+  font-weight: bold !important;
+  color: #5ba1cf !important;
+  background-color: none !important;
+}
+.syntaxhighlighter .color1, .syntaxhighlighter .color1 a {
+  color: #e0e8ff !important;
+}
+.syntaxhighlighter .color2, .syntaxhighlighter .color2 a {
+  color: white !important;
+}
+.syntaxhighlighter .color3, .syntaxhighlighter .color3 a {
+  color: #ffaa3e !important;
+}

data/lib/guides/templates/assets/stylesheets/syntaxhighlighter/shThemeRailsGuides.css

@@ -0,0 +1,116 @@
+/**
+ * Theme by fxn, took shThemeEclipse.css as starting point.
+ */
+.syntaxhighlighter {
+  background-color: #eee !important;
+  font-family: "Anonymous Pro", "Inconsolata", "Menlo", "Consolas", "Bitstream Vera Sans Mono", "Courier New", monospace !important;
+  overflow-y: hidden !important;
+  overflow-x: auto !important;
+}
+.syntaxhighlighter .line.alt1 {
+  background-color: #eee !important;
+}
+.syntaxhighlighter .line.alt2 {
+  background-color: #eee !important;
+}
+.syntaxhighlighter .line.highlighted.alt1, .syntaxhighlighter .line.highlighted.alt2 {
+  background-color: #c3defe !important;
+}
+.syntaxhighlighter .line.highlighted.number {
+  color: #eee !important;
+}
+.syntaxhighlighter table caption {
+  color: #222 !important;
+}
+.syntaxhighlighter .gutter {
+  color: #787878 !important;
+}
+.syntaxhighlighter .gutter .line {
+  border-right: 3px solid #d4d0c8 !important;
+}
+.syntaxhighlighter .gutter .line.highlighted {
+  background-color: #d4d0c8 !important;
+  color: #eee !important;
+}
+.syntaxhighlighter.printing .line .content {
+  border: none !important;
+}
+.syntaxhighlighter.collapsed {
+  overflow: visible !important;
+}
+.syntaxhighlighter.collapsed .toolbar {
+  color: #3f5fbf !important;
+  background: #eee !important;
+  border: 1px solid #d4d0c8 !important;
+}
+.syntaxhighlighter.collapsed .toolbar a {
+  color: #3f5fbf !important;
+}
+.syntaxhighlighter.collapsed .toolbar a:hover {
+  color: #aa7700 !important;
+}
+.syntaxhighlighter .toolbar {
+  color: #a0a0a0 !important;
+  background: #d4d0c8 !important;
+  border: none !important;
+}
+.syntaxhighlighter .toolbar a {
+  color: #a0a0a0 !important;
+}
+.syntaxhighlighter .toolbar a:hover {
+  color: red !important;
+}
+.syntaxhighlighter .plain, .syntaxhighlighter .plain a {
+  color: #222 !important;
+}
+.syntaxhighlighter .comments, .syntaxhighlighter .comments a {
+  color: #708090 !important;
+}
+.syntaxhighlighter .string, .syntaxhighlighter .string a {
+  font-style: italic !important;
+  color: #6588A8 !important;
+}
+.syntaxhighlighter .keyword {
+  color: #64434d !important;
+}
+.syntaxhighlighter .preprocessor {
+  color: #646464 !important;
+}
+.syntaxhighlighter .variable {
+  color: #222 !important;
+}
+.syntaxhighlighter .value {
+  color: #009900 !important;
+}
+.syntaxhighlighter .functions {
+  color: #ff1493 !important;
+}
+.syntaxhighlighter .constants {
+  color: #0066cc !important;
+}
+.syntaxhighlighter .script {
+  color: #222 !important;
+  background-color: none !important;
+}
+.syntaxhighlighter .color1, .syntaxhighlighter .color1 a {
+  color: gray !important;
+}
+.syntaxhighlighter .color2, .syntaxhighlighter .color2 a {
+  color: #222 !important;
+  font-weight: bold !important;
+}
+.syntaxhighlighter .color3, .syntaxhighlighter .color3 a {
+  color: red !important;
+}
+
+.syntaxhighlighter .xml .keyword {
+  color: #64434d !important;
+  font-weight: normal !important;
+}
+.syntaxhighlighter .xml .color1, .syntaxhighlighter .xml .color1 a {
+  color: #7f007f !important;
+}
+.syntaxhighlighter .xml .string {
+  font-style: italic !important;
+  color: #6588A8 !important;
+}

data/lib/guides/templates/guides.yml.tt

@@ -0,0 +1,35 @@
+title: <%= title %>
+description: Enter your description here.
+  It can take up several lines. This description
+  will appear immediately below the main title in
+  the outputted guides.
+
+authors:
+  Documentation Team:
+    - name: Yehuda Katz
+      nick: wycats
+      description: Yehuda wrote the Rails guides gem.
+  Designers:
+    - name: Jason Zimdars
+      nick: jz
+      description: Jason Zimdars is an experienced creative director and web designer who has lead UI and UX design for numerous websites and web applications. You can see more of his design and writing at <a href="http://www.thinkcage.com/">Thinkcage.com</a> or follow him on <a href="http://twitter.com/JZ">Twitter</a>
+
+index:
+  Start Here:
+    - title: Getting Started
+      url: getting_started
+      text: Everything you need to know to install Rails and create your first application
+  Models:
+    - title: Rails Database Migrations
+      url: migrations
+      text: This guide covers how you can use Active Record migrations to alter your database in a structured and organized manner.
+    - title: Active Record Validations and Callbacks
+      url: validations
+      text: This guide covers how you can use Active Record validations and callbacks.
+  Controllers:
+    - title: Action Controller Overview
+      url: controllers
+      text: 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.
+    - title: Rails Routing from the Outside In
+      url: routing
+      text: 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.

data/lib/guides/templates/source/_clickable_index.html.erb

@@ -0,0 +1,17 @@
+<dl class="L">
+  <% lgroup.each do |group, guides| %>
+    <dt><%= group %></dt>
+    <% guides.each do |guide| %>
+      <dd><%= link_to guide["title"], "#{guide["url"]}.html" %></dd>
+    <% end %>
+  <% end %>
+</dl>
+<dl class="R">
+  <% rgroup.each do |group, guides| %>
+    <dt><%= group %></dt>
+    <% guides.each do |guide| %>
+      <dd><%= link_to guide["title"], "#{guide["url"]}.html" %></dd>
+    <% end %>
+  <% end %>
+</dl>
+

data/lib/guides/templates/source/_full_index.html.erb

@@ -0,0 +1,16 @@
+<% guides.each do |name, list| %>
+  <h3><%= name %></h3>
+
+  <dl>
+    <% list.each do |guide| %>
+      <dt><%= link_to guide["title"], "#{guide["url"]}.html" %></dt>
+      <dd>
+        <% if guide["construction"] %>
+          <img src="images/construction.png" />
+        <% end %>
+        <p><%= guide["text"] %></p>
+      </dd>
+    <% end %>
+  </dl>
+<% end %>
+

data/lib/guides/templates/source/_sections.html.erb

@@ -0,0 +1,24 @@
+<%# This will replace the <title> element in your page. By default, it uses the title key in your guides.yml %>
+<%= content_for :page_title do %><%= Guides.meta["title"] %><% end %>
+
+<%# This content will go in the top navigation area. Leave it blank if you don't want nav %>
+<%= content_for :top_nav do %>
+<% end %>
+
+<%# This content will be used when you mark your guides as belonging to an edge release of your project. It defaults
+    to showing a diagonal "edge" badge %>
+<%= content_for :edge do %>
+  <div>
+    <img src="images/edge_badge.png" alt="edge-badge" id="edge-badge" />
+  </div>
+<% end %>
+
+<%= content_for :license do %>
+  <p>This work is licensed under a
+    <%= link_to "Creative Commons Attribution Share Alike 3.0", "http://creativecommons.org/licenses/by-sa/3.0/" %>
+    license.
+  </p>
+  <p>
+    <%# Any additional trademark information should be entered here %>
+  </p>
+<% end %>

data/lib/guides/templates/source/contribute.textile

@@ -0,0 +1,47 @@
+h2. Contribute
+
+Replace this with some introductory material on contributing
+
+endprologue.
+
+h3. How to Contribute?
+
+* Make a list
+* of useful information
+* on contributing
+
+h3. What to Contribute?
+
+* We need authors, editors, proofreaders, and translators. Adding a single paragraph of quality content to a guide is a good way to get started.
+* The easiest way to start is by improving an existing guide:
+** Improve the structure to make it more coherent.
+** Add missing information.
+** Correct any factual errors.
+** Fix typos or improve style.
+** Bring it up to date with the latest Edge Rails.
+* We're also open to suggestions for entire new guides:
+** Contact REPLACE_THIS to get your idea approved. See the Contact section below.
+
+h3. How is the process?
+
+* Describe the process
+* you will use
+* in this section
+
+h3. Rules
+
+* Guides are licensed under a Creative Commons Attribution-Share Alike 3.0 License.
+* If you're not sure whether a guide is actively being worked on, stop by IRC and ask.
+* Set up additional rules here
+
+TODO: Set up some conventions for authors to follow. https://github.com/lifo/docrails/wiki/rails-guides-conventions Is a good starting poing
+
+h3. Mailing List
+
+TODO: Specify the mailing list where people can ask about the efforts
+
+h3. Contact
+
+* IRC : TODO
+* Twitter: TODO
+* Email : TODO