RubyGems - openskies - Versions diffs - 0.0.1 - Mend

openskies 0.0.1

Files changed (494) hide show

data/guides/source/kindle/KINDLE.md ADDED Viewed

@@ -0,0 +1,26 @@
+# Rails Guides on the Kindle
+## Synopsis
+  1. Obtain `kindlegen` from the link below and put the binary in your path
+  2. Run `KINDLE=1 rake generate_guides` to generate the guides and compile the `.mobi` file
+  3. Copy `output/kindle/rails_guides.mobi` to your Kindle
+## Resources
+  * [StackOverflow: Kindle Periodical Format](http://stackoverflow.com/questions/5379565/kindle-periodical-format)
+  * Example Periodical [.ncx](https://gist.github.com/808c971ed087b839d462) and [.opf](https://gist.github.com/d6349aa8488eca2ee6d0)
+  * [Kindle Publishing guidelines](http://kindlegen.s3.amazonaws.com/AmazonKindlePublishingGuidelines.pdf)
+  * [KindleGen & Kindle Previewer](http://www.amazon.com/gp/feature.html?ie=UTF8&docId=1000234621)
+## TODO
+### Post release
+  * Integrate generated Kindle document in to published HTML guides
+  * Tweak heading styles (most docs use h3/h4/h5, which end up being smaller than the text under it)
+  * Tweak table styles (smaller text? Many of the tables are unusable on a Kindle in portrait mode)
+  * Have the HTML/XML TOC 'drill down' into the TOCs of the individual guides
+  * `.epub` generation.

data/guides/source/kindle/copyright.html.erb ADDED Viewed

	@@ -0,0 +1 @@
1	+ <%= render 'license' %>

data/guides/source/kindle/layout.html.erb ADDED Viewed

@@ -0,0 +1,27 @@
+<!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" xml:lang="en" lang="en">
+<head>
+<meta http-equiv="Content-Type" content="text/html; charset=utf-8"/>
+<title><%= yield(:page_title) || 'Ruby on Rails Guides' %></title>
+<link rel="stylesheet" type="text/css" href="stylesheets/kindle.css" />
+</head>
+<body class="guide">
+  <% if content_for? :header_section %>
+    <%= yield :header_section %>
+    <div class="pagebreak">
+  <% end %>
+  <% if content_for? :index_section %>
+    <%= yield :index_section %>
+    <div class="pagebreak">
+  <% end %>
+  <%= yield.html_safe %>
+</body>
+</html>

data/guides/source/kindle/rails_guides.opf.erb ADDED Viewed

@@ -0,0 +1,52 @@
+<?xml version="1.0" encoding="utf-8"?>
+<package xmlns="http://www.idpf.org/2007/opf" version="2.0" unique-identifier="RailsGuides">
+<metadata>
+  <meta name="cover" content="cover" />
+  <dc-metadata xmlns:dc="http://purl.org/dc/elements/1.1/">
+  	<dc:title>Ruby on Rails Guides (<%= @version %>)</dc:title>
+  	<dc:language>en-us</dc:language>
+  	<dc:creator>Ruby on Rails</dc:creator>
+  	<dc:publisher>Ruby on Rails</dc:publisher>
+  	<dc:subject>Reference</dc:subject>
+  	<dc:date><%= Time.now.strftime('%Y-%m-%d') %></dc:date>
+    <dc:description>These guides are designed to make you immediately productive with Rails, and to help you understand how all of the pieces fit together.</dc:description>
+  </dc-metadata>
+  <x-metadata>
+    <output content-type="application/x-mobipocket-subscription-magazine" encoding="utf-8"/>
+  </x-metadata>
+</metadata>
+<manifest>
+  <!-- HTML content files [mandatory] -->
+  <% documents_flat.each do |document| %>
+    <item id="<%= document['url'] %>" media-type="text/html" href="<%= document['url'] %>" />
+  <% end %>
+  <% %w{toc.html credits.html welcome.html copyright.html}.each do |url| %>
+    <item id="<%= url %>" media-type="text/html" href="<%= url %>" />
+  <% end %>
+  <item id="toc" media-type="application/x-dtbncx+xml" href="toc.ncx" />
+  <item id="cover" media-type="image/jpeg" href="images/rails_guides_kindle_cover.jpg"/>
+</manifest>
+<spine toc="toc">
+  <itemref idref="toc.html" />
+  <itemref idref="welcome.html" />
+  <itemref idref="credits.html" />
+  <itemref idref="copyright.html" />
+  <% documents_flat.each do |document| %>
+    <itemref idref="<%= document['url'] %>" />
+  <% end %>
+</spine>
+<guide>
+	<reference type="toc" title="Table of Contents" href="toc.html"></reference>
+</guide>
+</package>

data/guides/source/kindle/toc.html.erb ADDED Viewed

@@ -0,0 +1,24 @@
+<% content_for :page_title do %>
+Ruby on Rails Guides
+<% end %>
+<h1>Table of Contents</h1>
+<div id="toc">
+  <ul><li><a href="welcome.html">Welcome</a></li></ul>
+<% documents_by_section.each_with_index do |section, i| %>
+  <h3><%= "#{i + 1}." %> <%= section['name'] %></h3>
+  <ul>
+    <% section['documents'].each do |document| %>
+      <li>
+        <a href="<%= document['url'] %>"><%= document['name'] %></a>
+        <% if document['work_in_progress']%>(WIP)<% end %>
+      </li>
+    <% end %>
+  </ul>
+<% end %>
+<hr />
+<ul>
+  <li><a href="credits.html">Credits</a></li>
+  <li><a href="copyright.html">Copyright &amp; License</a></li>
+<ul>
+</div>

data/guides/source/kindle/toc.ncx.erb ADDED Viewed

@@ -0,0 +1,64 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<!DOCTYPE ncx PUBLIC "-//NISO//DTD ncx 2005-1//EN"
+	"http://www.daisy.org/z3986/2005/ncx-2005-1.dtd">
+<ncx xmlns="http://www.daisy.org/z3986/2005/ncx/" version="2005-1" xml:lang="en-US">
+<head>
+  <meta name="dtb:uid" content="RailsGuides"/>
+  <meta name="dtb:depth" content="2"/>
+  <meta name="dtb:totalPageCount" content="0"/>
+  <meta name="dtb:maxPageNumber" content="0"/>
+</head>
+<docTitle><text>Ruby on Rails Guides</text></docTitle>
+<docAuthor><text>docrails</text></docAuthor>
+<navMap>
+  <navPoint playOrder="0" class="periodical" id="periodical">
+    <navLabel>
+      <text>Table of Contents</text>
+    </navLabel>
+    <content src="toc.html"/>
+    <navPoint class="section" id="welcome" playOrder="1">
+      <navLabel>
+        <text>Introduction</text>
+      </navLabel>
+      <content src="welcome.html"/>
+      <navPoint class="article" id="welcome" playOrder="2">
+        <navLabel>
+          <text>Welcome</text>
+        </navLabel>
+        <content src="welcome.html"/>
+      </navPoint>
+      <navPoint class="article" id="credits" playOrder="3">
+        <navLabel><text>Credits</text></navLabel>
+        <content src="credits.html">
+      </navPoint>
+      <navPoint class="article" id="copyright" playOrder="4">
+        <navLabel><text>Copyright &amp; License</text></navLabel>
+        <content src="copyright.html">
+      </navPoint>
+    </navPoint>
+    <% play_order = 4 %>
+    <% documents_by_section.each_with_index do |section, section_no| %>
+      <navPoint class="section" id="chapter_<%= section_no + 1 %>" playOrder="<% play_order +=1 %>">
+        <navLabel>
+          <text><%= section['name'] %></text>
+        </navLabel>
+        <content src="<%=section['documents'].first['url'] %>"/>
+        <% section['documents'].each_with_index do |document, document_no| %>
+          <navPoint class="article" id="_<%=section_no+1%>.<%=document_no+1%>" playOrder="<%=play_order +=1 %>">
+            <navLabel>
+              <text><%= document['name'] %></text>
+            </navLabel>
+            <content src="<%=document['url'] %>"/>
+          </navPoint>
+        <% end %>
+      </navPoint>
+    <% end %>
+  </navPoint>
+</navMap>
+</ncx>

data/guides/source/kindle/welcome.html.erb ADDED Viewed

@@ -0,0 +1,5 @@
+<%= render 'welcome' %>
+<h3>Kindle Edition</h3>
+The Kindle Edition of the Rails Guides should be considered a work in progress. Feedback is really welcome, please see the "Feedback" section at the end of each guide for instructions.

data/guides/source/layout.html.erb ADDED Viewed

@@ -0,0 +1,124 @@
+<!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" xml:lang="en" lang="en">
+<head>
+<meta http-equiv="Content-Type" content="text/html; charset=utf-8"/>
+<title><%= yield(:page_title) || 'Ruby on Rails Guides' %></title>
+<link rel="stylesheet" type="text/css" href="stylesheets/style.css" />
+<link rel="stylesheet" type="text/css" href="stylesheets/print.css" media="print" />
+<link rel="stylesheet" type="text/css" href="stylesheets/syntaxhighlighter/shCore.css" />
+<link rel="stylesheet" type="text/css" href="stylesheets/syntaxhighlighter/shThemeRailsGuides.css" />
+<link rel="stylesheet" type="text/css" href="stylesheets/fixes.css" />
+</head>
+<body class="guide">
+  <% if @edge %>
+  <div>
+    <img src="images/edge_badge.png" alt="edge-badge" id="edge-badge" />
+  </div>
+  <% end %>
+  <div id="topNav">
+    <div class="wrapper">
+      <strong>More at <a href="http://rubyonrails.org/">rubyonrails.org:</a> </strong>
+      <a href="http://rubyonrails.org/">Overview</a> |
+      <a href="http://rubyonrails.org/download">Download</a> |
+      <a href="http://rubyonrails.org/deploy">Deploy</a> |
+      <a href="https://github.com/rails/rails">Code</a> |
+      <a href="http://rubyonrails.org/screencasts">Screencasts</a> |
+      <a href="http://rubyonrails.org/documentation">Documentation</a> |
+      <a href="http://rubyonrails.org/ecosystem">Ecosystem</a> |
+      <a href="http://rubyonrails.org/community">Community</a> |
+      <a href="http://weblog.rubyonrails.org/">Blog</a>
+    </div>
+  </div>
+  <div id="header">
+    <div class="wrapper clearfix">
+      <h1><a href="index.html" title="Return to home page">Guides.rubyonrails.org</a></h1>
+      <ul class="nav">
+        <li><a href="index.html">Home</a></li>
+        <li class="index"><a href="index.html" onclick="guideMenu(); return false;" id="guidesMenu">Guides Index</a>
+          <div id="guides" class="clearfix" style="display: none;">
+            <hr />
+            <% ['L', 'R'].each do |position| %>
+              <dl class="<%= position %>">
+              <% docs_for_menu(position).each do |section| %>
+                <dt><%= section['name'] %></dt>
+                <% finished_documents(section['documents']).each do |document| %>
+                <dd><a href="<%= document['url'] %>"><%= document['name'] %></a></dd>
+                <% end %>
+              <% end %>
+              </dl>
+            <% end %>
+          </div>
+        </li>
+        <li><a href="contributing_to_ruby_on_rails.html">Contribute</a></li>
+        <li><a href="credits.html">Credits</a></li>
+      </ul>
+    </div>
+  </div>
+  <hr class="hide" />
+  <div id="feature">
+    <div class="wrapper">
+      <%= yield :header_section %>
+      <%= yield :index_section %>
+    </div>
+  </div>
+  <div id="container">
+    <div class="wrapper">
+      <div id="mainCol">
+        <%= yield.html_safe %>
+        <h3>Feedback</h3>
+        <p>
+          You're encouraged to help improve the quality of this guide.
+        </p>
+        <p>
+          If you see any typos or factual errors you are confident to
+          patch, please clone <%= link_to 'docrails', 'https://github.com/lifo/docrails' %>
+          and push the change yourself. That branch of Rails has public write access.
+          Commits are still reviewed, but that happens after you've submitted your
+          contribution. <%= link_to 'docrails', 'https://github.com/lifo/docrails' %> is
+          cross-merged with master periodically.
+        </p>
+        <p>
+          You may also find incomplete content, or stuff that is not up to date.
+          Please do add any missing documentation for master. Check the
+          <%= link_to 'Ruby on Rails Guides Guidelines', 'ruby_on_rails_guides_guidelines.html' %>
+          for style and conventions.
+        </p>
+        <p>
+          If for whatever reason you spot something to fix but cannot patch it yourself, please
+          <%= link_to 'open an issue', 'https://github.com/rails/rails/issues' %>.
+        </p>
+        <p>And last but not least, any kind of discussion regarding Ruby on Rails
+          documentation is very welcome in the <%= link_to 'rubyonrails-docs mailing list', 'http://groups.google.com/group/rubyonrails-docs' %>.
+        </p>
+      </div>
+    </div>
+  </div>
+  <hr class="hide" />
+  <div id="footer">
+    <div class="wrapper">
+      <%= render 'license' %>
+    </div>
+  </div>
+  <script type="text/javascript" src="javascripts/guides.js"></script>
+  <script type="text/javascript" src="javascripts/syntaxhighlighter/shCore.js"></script>
+  <script type="text/javascript" src="javascripts/syntaxhighlighter/shBrushRuby.js"></script>
+  <script type="text/javascript" src="javascripts/syntaxhighlighter/shBrushXml.js"></script>
+  <script type="text/javascript" src="javascripts/syntaxhighlighter/shBrushSql.js"></script>
+  <script type="text/javascript" src="javascripts/syntaxhighlighter/shBrushPlain.js"></script>
+  <script type="text/javascript">
+    SyntaxHighlighter.all()
+  </script>
+</body>
+</html>