RubyGems - rpub - Versions diffs - 0.4.0 → 0.5.0 - Mend

rpub 0.4.0 → 0.5.0

Files changed (120) hide show

checksums.yaml +7 -0
data/.gitignore +1 -1
data/.rspec +0 -1
data/.travis.yml +3 -4
data/.yardopts +1 -0
data/Gemfile +1 -1
data/Gemfile.lock +70 -46
data/Guardfile +6 -0
data/HISTORY.md +10 -0
data/README.md +1 -1
data/Rakefile +7 -2
data/bin/rpub +64 -1
data/doc/.gitignore +8 -0
data/doc/api/Rpub.html +339 -0
data/doc/api/Rpub/Book.html +983 -0
data/doc/api/Rpub/Chapter.html +737 -0
data/doc/api/Rpub/Command.html +356 -0
data/doc/api/Rpub/Commands.html +117 -0
data/doc/api/Rpub/Commands/Clean.html +216 -0
data/doc/api/Rpub/Commands/Compile.html +218 -0
data/doc/api/Rpub/Commands/Generate.html +242 -0
data/doc/api/Rpub/Commands/Package.html +230 -0
data/doc/api/Rpub/Commands/Preview.html +216 -0
data/doc/api/Rpub/Commands/Stats.html +226 -0
data/doc/api/Rpub/Compressor.html +687 -0
data/doc/api/Rpub/Context.html +553 -0
data/doc/api/Rpub/Document.html +647 -0
data/doc/api/Rpub/Document/OutlineElement.html +388 -0
data/doc/api/Rpub/Epub.html +465 -0
data/doc/api/Rpub/Epub/Container.html +224 -0
data/doc/api/Rpub/Epub/Content.html +344 -0
data/doc/api/Rpub/Epub/Cover.html +236 -0
data/doc/api/Rpub/Epub/HtmlToc.html +240 -0
data/doc/api/Rpub/Epub/Toc.html +244 -0
data/doc/api/Rpub/FilesystemSource.html +544 -0
data/doc/api/Rpub/HashDelegation.html +281 -0
data/doc/api/Rpub/HashDelegation/ClassMethods.html +175 -0
data/doc/api/Rpub/MediaType.html +192 -0
data/doc/api/Rpub/Preview.html +464 -0
data/doc/api/Rpub/XmlFile.html +457 -0
data/doc/api/_index.html +405 -0
data/doc/api/class_list.html +54 -0
data/doc/api/css/common.css +1 -0
data/doc/api/css/full_list.css +57 -0
data/doc/api/css/style.css +339 -0
data/doc/api/file.HISTORY.html +131 -0
data/doc/api/file.LICENSE.html +92 -0
data/doc/api/file.README.html +337 -0
data/doc/api/file_list.html +62 -0
data/doc/api/frames.html +26 -0
data/doc/api/index.html +337 -0
data/doc/api/js/app.js +219 -0
data/doc/api/js/full_list.js +178 -0
data/doc/api/js/jquery.js +4 -0
data/doc/api/method_list.html +533 -0
data/doc/api/top-level-namespace.html +112 -0
data/doc/index.html +312 -0
data/doc/javascripts/scale.fix.js +17 -0
data/doc/params.json +1 -0
data/doc/stylesheets/pygment_trac.css +69 -0
data/doc/stylesheets/styles.css +255 -0
data/features/clean.feature +31 -0
data/features/compile.feature +49 -0
data/features/embedded_assets.feature +51 -0
data/features/generate.feature +63 -0
data/features/layout.feature +41 -0
data/features/package.feature +30 -0
data/features/previews.feature +66 -0
data/features/stats.feature +18 -0
data/features/step_definitions/general_steps.rb +60 -0
data/features/styles.feature +33 -0
data/features/support/env.rb +7 -0
data/features/table_of_contents.feature +35 -0
data/lib/rpub.rb +28 -31
data/lib/rpub/book.rb +9 -16
data/lib/rpub/chapter.rb +4 -54
data/lib/rpub/command.rb +32 -0
data/lib/rpub/commands/clean.rb +4 -49
data/lib/rpub/commands/compile.rb +4 -49
data/lib/rpub/commands/generate.rb +10 -67
data/lib/rpub/commands/package.rb +9 -37
data/lib/rpub/commands/preview.rb +4 -54
data/lib/rpub/commands/stats.rb +6 -10
data/lib/rpub/compressor.rb +3 -3
data/lib/rpub/context.rb +48 -0
data/lib/rpub/document.rb +68 -0
data/lib/rpub/epub.rb +8 -7
data/lib/rpub/epub/content.rb +9 -30
data/lib/rpub/epub/cover.rb +1 -8
data/lib/rpub/epub/html_toc.rb +4 -9
data/lib/rpub/epub/toc.rb +16 -13
data/lib/rpub/filesystem_source.rb +47 -0
data/lib/rpub/media_type.rb +16 -0
data/lib/rpub/preview.rb +29 -0
data/lib/rpub/version.rb +1 -1
data/lib/rpub/xml_file.rb +4 -1
data/rpub.gemspec +6 -7
data/spec/rpub/book_spec.rb +45 -45
data/spec/rpub/chapter_spec.rb +87 -22
data/spec/rpub/epub/container_spec.rb +3 -5
data/spec/rpub/epub/content_spec.rb +62 -41
data/spec/rpub/epub/cover_spec.rb +3 -5
data/spec/rpub/epub/html_toc_spec.rb +8 -8
data/spec/rpub/epub/toc_spec.rb +20 -22
data/spec/rpub_spec.rb +1 -3
data/spec/spec_helper.rb +28 -0
data/support/config.yml +1 -0
data/support/styles.css +3 -3
metadata +131 -120
data/lib/rpub/commander.rb +0 -23
data/lib/rpub/commands/base.rb +0 -33
data/lib/rpub/commands/help.rb +0 -37
data/lib/rpub/commands/main.rb +0 -45
data/lib/rpub/compilation_helpers.rb +0 -73
data/lib/rpub/subclass_tracker.rb +0 -53
data/spec/rpub/commands/clean_spec.rb +0 -46
data/spec/rpub/commands/generate_spec.rb +0 -52
data/spec/rpub/commands/main_spec.rb +0 -26
data/spec/rpub/commands/package_spec.rb +0 -33
data/spec/rpub/commands/preview_spec.rb +0 -43

@@ -0,0 +1,26 @@
+<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Frameset//EN"
+	"http://www.w3.org/TR/xhtml1/DTD/xhtml1-frameset.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>Rpub, a simple ePub generator library in Ruby</title>
+</head>
+<script type="text/javascript" charset="utf-8">
+window.onload = function() {
+  var match = unescape(window.location.hash).match(/^#!(.+)/);
+  var name = match ? match[1] : 'index.html';
+  name = name.replace(/^(\w+):\/\//, '').replace(/^\/\//, '');
+  document.writeln('<frameset cols="20%,*">' +
+    '<frame name="list" src="class_list.html" />' +
+    '<frame name="main" src="' + escape(name) + '" />' +
+    '</frameset>');
+}
+</script>
+<noscript>
+  <frameset cols="20%,*">
+    <frame name="list" src="class_list.html" />
+    <frame name="main" src="index.html" />
+  </frameset>
+</noscript>
+</html>

data/doc/api/index.html ADDED

@@ -0,0 +1,337 @@
+<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
+  "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.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>
+  File: README
+    &mdash; Rpub, a simple ePub generator library in Ruby
+</title>
+  <link rel="stylesheet" href="css/style.css" type="text/css" charset="utf-8" />
+  <link rel="stylesheet" href="css/common.css" type="text/css" charset="utf-8" />
+<script type="text/javascript" charset="utf-8">
+  hasFrames = window.top.frames.main ? true : false;
+  relpath = '';
+  framesUrl = "frames.html#!file.README.html";
+</script>
+  <script type="text/javascript" charset="utf-8" src="js/jquery.js"></script>
+  <script type="text/javascript" charset="utf-8" src="js/app.js"></script>
+  </head>
+  <body>
+    <div id="header">
+      <div id="menu">
+    <a href="_index.html">Index</a> &raquo;
+    <span class="title">File: README</span>
+  <div class="noframes"><span class="title">(</span><a href="." target="_top">no frames</a><span class="title">)</span></div>
+</div>
+      <div id="search">
+    <a class="full_list_link" id="class_list_link"
+        href="class_list.html">
+      Class List
+    </a>
+    <a class="full_list_link" id="method_list_link"
+        href="method_list.html">
+      Method List
+    </a>
+    <a class="full_list_link" id="file_list_link"
+        href="file_list.html">
+      File List
+    </a>
+</div>
+      <div class="clear"></div>
+    </div>
+    <iframe id="search_frame"></iframe>
+    <div id="content"><div id='filecontents'><h1 id="rpub----an-epub-generator-in-ruby-build-statushttpssecuretravis-ciorgavdgaagrpubpngbranchmasterhttptravis-ciorgavdgaagrpub-coverage-statushttpscoverallsioreposavdgaagrpubbadgepnghttpscoverallsioravdgaagrpub">Rpub – an ePub generator in Ruby <a href="http://travis-ci.org/avdgaag/rpub"><img src="https://secure.travis-ci.org/avdgaag/rpub.png?branch=master" alt="Build Status" /></a> <a href="https://coveralls.io/r/avdgaag/rpub"><img src="https://coveralls.io/repos/avdgaag/rpub/badge.png" alt="Coverage Status" /></a></h1>
+<h2 id="introduction">Introduction</h2>
+<p>Rpub is a command-line tool that generates a collection of plain text input
+files into an eBook in ePub format. It provides several related functions to
+make working with ePub files a little easier:</p>
+<ul>
+  <li>Generation of table of contents</li>
+  <li>Packaging your eBook in an archive with additional README file</li>
+  <li>Embedding fonts</li>
+  <li>Easy previewing as you write</li>
+  <li>.mobi compatibility</li>
+</ul>
+<h2 id="installation">Installation</h2>
+<p>Rpub is distributed as a Ruby gem, which should be installed on most Macs and
+Linux systems. Once you have ensured you have a working installation of Ruby
+and Ruby gems, install the gem as follows from the command line:</p>
+<pre class="code ruby"><code class="ruby">$ gem install rpub
+</code></pre>
+<p>You can verify the gem has installed correctly by checking its version number:</p>
+<pre class="code ruby"><code class="ruby">$ rpub -v
+</code></pre>
+<p>If this generates an error, something has gone wrong. You should see something
+along the lines of <code>rpub 1.0.0</code>.</p>
+<h2 id="usage">Usage</h2>
+<h3 id="basics">Basics</h3>
+<p>ePubs are basically collections of HTML files, combined in a single archive
+according to a set of predefined rules. Rpub generates these files for you from
+simple text files written in <a href="http://daringfireball.net/projects/markdown">Markdown</a>, a very readable markup language created
+by <a href="http://daringfireball.net">John Gruber</a>. This very README file is an example of a Markdown document.</p>
+<p>The idea is you write several Markdown files using your favourite text editor,
+and save them as plain text in your project directory. Usually you would write
+one file per chapter. By invoking the <code>rpub</code> program you convert those files to
+HTML and combine them in an ePub archive:</p>
+<pre class="code ruby"><code class="ruby">$ rpub compile
+Generating my-new-book-0.1.0.epub... Done!
+</code></pre>
+<p>After you have run the <code>rpub compile</code> command, you will find a new <code>.epub</code> file
+in your project directory. The name of this file depends on the title of your
+book, and its version number. You can set these values, as well as a few others,
+in a special configuration file called <code>config.yml</code>:</p>
+<pre class="code ruby"><code class="ruby">---
+author: Your Name
+title: My new book
+version: 0.1.0
+</code></pre>
+<p>This file is written in <a href="http://yaml.org">YAML</a> and sets basic properties of
+your book project.</p>
+<p>Since regenerating your ePub file and opening it in a suitable reader
+application is cumbersome, Rpub can generate a simple preview document for you:</p>
+<pre class="code ruby"><code class="ruby">$ rpub preview
+</code></pre>
+<p>This will generate a new HTML file in your project directory with a name similar
+to your ePub file. This is the entire text of your book as a single web page for
+easy viewing in any browser.</p>
+<h3 id="generating-a-mobi-file">Generating a .mobi file</h3>
+<p>Since the ePub and Mobipocket file formats are very (<em>very</em>) similar it is
+quite easy to create a <code>.mobi</code> version of your book, suitable for reading on
+Amazon’s Kindle. To do so, you will need to install the <a href="http://www.amazon.com/gp/feature.html?ie=UTF8&amp;docId=1000765211">kindlegen program
+Amazon provides</a>.</p>
+<p>Here’s how it works:</p>
+<ol>
+  <li>Install <code>kindlegen</code> (<a href="http://www.amazon.com/gp/feature.html?ie=UTF8&amp;docId=1000765211">download it here</a>)</li>
+  <li>Compile your book as usual using <code>rpub compile</code></li>
+  <li>Compile <code>my-book.epub</code> to <code>my-book.mobi</code>: <code>kindlegen my-book.epub</code>.</li>
+</ol>
+<p>Optionally, include your <code>my-book.mobi</code> in your package by adding it to your
+list of packaged files (see “Packaging for distribution”).</p>
+<h3 id="advanced-features">Advanced features</h3>
+<h4 id="packaging-for-distribution">Packaging for distribution</h4>
+<p>Often you want to distribute your ebook over the internet, along with some
+extra files. You’ll probably want to include a README file, a license or
+references to extra online resources. A <code>package</code> task is defined to generate a
+single compressed archive file from your generated ebook along with such
+additional files.</p>
+<p>You list the files to include with your ebook in your <code>config.yml</code> file, along
+with the resulting packaged file name:</p>
+<pre class="code ruby"><code class="ruby">---
+package_file: mybook.zip
+package:
+  - README
+  - license.txt
+  - code-samples.rb
+</code></pre>
+<p>All the filenames listed under <code>package</code> are looked up in the root of your
+project directory. These files will be combined with the ebook in the
+<code>mybook.zip</code> file in your project directory.</p>
+<h4 id="automatic-table-of-contents">Automatic table of contents</h4>
+<p>Rpub automatically generates a table of contents for you, if you want it to. It
+does this by scanning all your markdown files for headings and listing them on
+a single page in the ebook. Each entry in the table of contents is linked to
+its appropriate heading in the chapter, and has various hooks for your
+stylesheet to determine its formatting.</p>
+<p>To enable the automatic generation of a table of contents, add the following
+configuration to your <code>config.yml</code> file:</p>
+<pre class="code ruby"><code class="ruby">toc: true
+</code></pre>
+<p>Note that this only affects the human-readable table of contents, represented
+as a page in your book. Rpub will alway generate the .epub table of contents
+for you, which contains the machine-readable references to your chapters. It
+will, by default, reference all chapter titles and subheadings for you, but
+you can customize the number of levels that will be included using the
+following in your <code>config.yml</code> file:</p>
+<pre class="code ruby"><code class="ruby">max_level: 3
+</code></pre>
+<h4 id="custom-layout-and-styles">Custom layout and styles</h4>
+<p>When you compile a set of Markdown files to an ePub file, rpub uses a default
+HTML layout and set of styles to determine the look and feel of the book. These
+will do fine for most cases, but you can provide your own, if you are so
+inclined.</p>
+<p>Simply define a <code>layout.html</code> and/or <code>styles.css</code> in your project directory.
+Your HTML file will be parsed with Erb, an so you can include your writing
+using the <code>@body</code> instance variable:</p>
+<pre class="code ruby"><code class="ruby">&lt;html&gt;
+&lt;body&gt;
+  &lt;%= @body %&gt;
+&lt;/body&gt;
+&lt;/html&gt;
+</code></pre>
+<p><strong>Note 1</strong>: this feature is actually provided by the <a href="http://kramdown.rubyforge.org">Kramdown gem</a>,
+so have a look at <a href="https://github.com/gettalong/kramdown/blob/master/data/kramdown/document.html">the standard Kramdown document template</a> to see some
+nifty tricks.</p>
+<p><strong>Note 2</strong>: despite the name ‘html’ and <code>.html</code> extension, your file actually has
+to be XHTML-compliant.</p>
+<p>You can also provide custom layouts or styles to use when invoking the <code>compile</code>
+or <code>preview</code> commands, using the <code>-l</code> or <code>-s</code> options:</p>
+<pre class="code ruby"><code class="ruby">$ rpub compile -l /tmp/my-layout.html
+</code></pre>
+<p>If you like the default layout or styles, but want to adapt them, you can copy
+those files into your project using the <code>generate</code> subcommand:</p>
+<pre class="code ruby"><code class="ruby">$ rpub generate
+</code></pre>
+<h3 id="command-reference">Command reference</h3>
+<dl>
+  <dt><code>rpub compile</code></dt>
+  <dd>generate .epub file</dd>
+  <dt><code>rpub package</code></dt>
+  <dd>create zip file with compiled book and other listed files</dd>
+  <dt><code>rpub preview</code></dt>
+  <dd>generate preview HTML file</dd>
+  <dt><code>rpub generate</code></dt>
+  <dd>copy default layout.html, styles.css and config.yml</dd>
+  <dt><code>rpub help</code></dt>
+  <dd>get help on subcommands</dd>
+  <dt><code>rpub clean</code></dt>
+  <dd>remove generated files</dd>
+</dl>
+<h3 id="configuration-reference">Configuration reference</h3>
+<dl>
+  <dt><code>title</code></dt>
+  <dd>the book title (string)</dd>
+  <dt><code>descrption</code></dt>
+  <dd>one-line summary of the book (string)</dd>
+  <dt><code>creator</code></dt>
+  <dd>author name (string)</dd>
+  <dt><code>publisher</code></dt>
+  <dd>publisher name (string)</dd>
+  <dt><code>subject</code></dt>
+  <dd>book subject/category (string)</dd>
+  <dt><code>language</code></dt>
+  <dd>language code of the book contents, e.g. ‘en’ (string)</dd>
+  <dt><code>rights</code></dt>
+  <dd>copyright line (string)</dd>
+  <dt><code>version</code></dt>
+  <dd>version number of the book to include in the .epub filename (string)</dd>
+  <dt><code>toc</code></dt>
+  <dd>whether to generate a table of contents as book page (boolean, default false)</dd>
+  <dt><code>max_level</code></dt>
+  <dd>the maximum depth of the .epub table of contents (number, default 2)</dd>
+  <dt><code>ignore</code></dt>
+  <dd>list of files not to include in the epub, that otherwise would (array)</dd>
+  <dt><code>package</code></dt>
+  <dd>list of files to be included in the archive created by the package task (array)</dd>
+</dl>
+<h3 id="examples">Examples</h3>
+<p>See the <a href="https://github.com/avdgaag/rpub/tree/master/example">examples directory</a> for two example projects.</p>
+<h3 id="documentation">Documentation</h3>
+<p>See the inline <a href="http://rubydoc.info/github/avdgaag/rpub/master/frames">API docs</a> for more information.</p>
+<h2 id="other">Other</h2>
+<h3 id="note-on-patchespull-requests">Note on Patches/Pull Requests</h3>
+<ol>
+  <li>Fork the project.</li>
+  <li>Make your feature addition or bug fix.</li>
+  <li>Add tests for it. This is important so I don’t break it in a future version
+unintentionally.</li>
+  <li>Commit, do not mess with rakefile, version, or history. (if you want to have
+your own version, that is fine but bump version in a commit by itself I can
+ignore when I pull)</li>
+  <li>Send me a pull request. Bonus points for topic branches.</li>
+</ol>
+<h3 id="issues">Issues</h3>
+<p>Please report any issues, defects or suggestions in the <a href="https://github.com/avdgaag/rpub/issues">Github issue
+tracker</a>.</p>
+<h3 id="what-has-changed">What has changed?</h3>
+<p>See the <a href="https://github.com/avdgaag/rpub/blob/master/HISTORY.md">HISTORY</a> file for a detailed changelog.</p>
+<h3 id="credits">Credits</h3>
+<p>Created by: Arjan van der Gaag<br />
+URL: <a href="http://arjanvandergaag.nl">http://arjanvandergaag.nl</a><br />
+Project homepage: <a href="http://avdgaag.github.com/rpub">http://avdgaag.github.com/rpub</a><br />
+Date: april 2012<br />
+License: <a href="https://github.com/avdgaag/rpub/LICENSE">MIT-license</a> (same as Ruby)</p>
+</div></div>
+    <div id="footer">
+  Generated on Thu Aug 14 19:54:32 2014 by
+  <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
+  0.8.7.4 (ruby-2.1.2).
+</div>
+  </body>
+</html>

data/doc/api/js/app.js ADDED

@@ -0,0 +1,219 @@
+function createSourceLinks() {
+    $('.method_details_list .source_code').
+        before("<span class='showSource'>[<a href='#' class='toggleSource'>View source</a>]</span>");
+    $('.toggleSource').toggle(function() {
+       $(this).parent().nextAll('.source_code').slideDown(100);
+       $(this).text("Hide source");
+    },
+    function() {
+        $(this).parent().nextAll('.source_code').slideUp(100);
+        $(this).text("View source");
+    });
+}
+function createDefineLinks() {
+    var tHeight = 0;
+    $('.defines').after(" <a href='#' class='toggleDefines'>more...</a>");
+    $('.toggleDefines').toggle(function() {
+        tHeight = $(this).parent().prev().height();
+        $(this).prev().show();
+        $(this).parent().prev().height($(this).parent().height());
+        $(this).text("(less)");
+    },
+    function() {
+        $(this).prev().hide();
+        $(this).parent().prev().height(tHeight);
+        $(this).text("more...");
+    });
+}
+function createFullTreeLinks() {
+    var tHeight = 0;
+    $('.inheritanceTree').toggle(function() {
+        tHeight = $(this).parent().prev().height();
+        $(this).parent().toggleClass('showAll');
+        $(this).text("(hide)");
+        $(this).parent().prev().height($(this).parent().height());
+    },
+    function() {
+        $(this).parent().toggleClass('showAll');
+        $(this).parent().prev().height(tHeight);
+        $(this).text("show all");
+    });
+}
+function fixBoxInfoHeights() {
+    $('dl.box dd.r1, dl.box dd.r2').each(function() {
+       $(this).prev().height($(this).height());
+    });
+}
+function searchFrameLinks() {
+  $('.full_list_link').click(function() {
+    toggleSearchFrame(this, $(this).attr('href'));
+    return false;
+  });
+}
+function toggleSearchFrame(id, link) {
+  var frame = $('#search_frame');
+  $('#search a').removeClass('active').addClass('inactive');
+  if (frame.attr('src') == link && frame.css('display') != "none") {
+    frame.slideUp(100);
+    $('#search a').removeClass('active inactive');
+  }
+  else {
+    $(id).addClass('active').removeClass('inactive');
+    frame.attr('src', link).slideDown(100);
+  }
+}
+function linkSummaries() {
+  $('.summary_signature').click(function() {
+    document.location = $(this).find('a').attr('href');
+  });
+}
+function framesInit() {
+  if (hasFrames) {
+    document.body.className = 'frames';
+    $('#menu .noframes a').attr('href', document.location);
+    try {
+      window.top.document.title = $('html head title').text();
+    } catch(error) {
+      // some browsers will not allow this when serving from file://
+      // but we don't want to stop the world.
+    }
+  }
+  else {
+    $('#menu .noframes a').text('frames').attr('href', framesUrl);
+  }
+}
+function keyboardShortcuts() {
+  if (window.top.frames.main) return;
+  $(document).keypress(function(evt) {
+    if (evt.altKey || evt.ctrlKey || evt.metaKey || evt.shiftKey) return;
+    if (typeof evt.target !== "undefined" &&
+        (evt.target.nodeName == "INPUT" ||
+        evt.target.nodeName == "TEXTAREA")) return;
+    switch (evt.charCode) {
+      case 67: case 99:  $('#class_list_link').click(); break;  // 'c'
+      case 77: case 109: $('#method_list_link').click(); break; // 'm'
+      case 70: case 102: $('#file_list_link').click(); break;   // 'f'
+      default: break;
+    }
+  });
+}
+function summaryToggle() {
+  $('.summary_toggle').click(function() {
+    if (localStorage) {
+      localStorage.summaryCollapsed = $(this).text();
+    }
+    $('.summary_toggle').each(function() {
+      $(this).text($(this).text() == "collapse" ? "expand" : "collapse");
+      var next = $(this).parent().parent().nextAll('ul.summary').first();
+      if (next.hasClass('compact')) {
+        next.toggle();
+        next.nextAll('ul.summary').first().toggle();
+      }
+      else if (next.hasClass('summary')) {
+        var list = $('<ul class="summary compact" />');
+        list.html(next.html());
+        list.find('.summary_desc, .note').remove();
+        list.find('a').each(function() {
+          $(this).html($(this).find('strong').html());
+          $(this).parent().html($(this)[0].outerHTML);
+        });
+        next.before(list);
+        next.toggle();
+      }
+    });
+    return false;
+  });
+  if (localStorage) {
+    if (localStorage.summaryCollapsed == "collapse") {
+      $('.summary_toggle').first().click();
+    }
+    else localStorage.summaryCollapsed = "expand";
+  }
+}
+function fixOutsideWorldLinks() {
+  $('a').each(function() {
+    if (window.location.host != this.host) this.target = '_parent';
+  });
+}
+function generateTOC() {
+  if ($('#filecontents').length === 0) return;
+  var _toc = $('<ol class="top"></ol>');
+  var show = false;
+  var toc = _toc;
+  var counter = 0;
+  var tags = ['h2', 'h3', 'h4', 'h5', 'h6'];
+  var i;
+  if ($('#filecontents h1').length > 1) tags.unshift('h1');
+  for (i = 0; i < tags.length; i++) { tags[i] = '#filecontents ' + tags[i]; }
+  var lastTag = parseInt(tags[0][1], 10);
+  $(tags.join(', ')).each(function() {
+    if ($(this).parents('.method_details .docstring').length != 0) return;
+    if (this.id == "filecontents") return;
+    show = true;
+    var thisTag = parseInt(this.tagName[1], 10);
+    if (this.id.length === 0) {
+      var proposedId = $(this).attr('toc-id');
+      if (typeof(proposedId) != "undefined") this.id = proposedId;
+      else {
+        var proposedId = $(this).text().replace(/[^a-z0-9-]/ig, '_');
+        if ($('#' + proposedId).length > 0) { proposedId += counter; counter++; }
+        this.id = proposedId;
+      }
+    }
+    if (thisTag > lastTag) {
+      for (i = 0; i < thisTag - lastTag; i++) {
+        var tmp = $('<ol/>'); toc.append(tmp); toc = tmp;
+      }
+    }
+    if (thisTag < lastTag) {
+      for (i = 0; i < lastTag - thisTag; i++) toc = toc.parent();
+    }
+    var title = $(this).attr('toc-title');
+    if (typeof(title) == "undefined") title = $(this).text();
+    toc.append('<li><a href="#' + this.id + '">' + title + '</a></li>');
+    lastTag = thisTag;
+  });
+  if (!show) return;
+  html = '<div id="toc"><p class="title"><a class="hide_toc" href="#"><strong>Table of Contents</strong></a> <small>(<a href="#" class="float_toc">left</a>)</small></p></div>';
+  $('#content').prepend(html);
+  $('#toc').append(_toc);
+  $('#toc .hide_toc').toggle(function() {
+    $('#toc .top').slideUp('fast');
+    $('#toc').toggleClass('hidden');
+    $('#toc .title small').toggle();
+  }, function() {
+    $('#toc .top').slideDown('fast');
+    $('#toc').toggleClass('hidden');
+    $('#toc .title small').toggle();
+  });
+  $('#toc .float_toc').toggle(function() {
+    $(this).text('float');
+    $('#toc').toggleClass('nofloat');
+  }, function() {
+    $(this).text('left');
+    $('#toc').toggleClass('nofloat');
+  });
+}
+$(framesInit);
+$(createSourceLinks);
+$(createDefineLinks);
+$(createFullTreeLinks);
+$(fixBoxInfoHeights);
+$(searchFrameLinks);
+$(linkSummaries);
+$(keyboardShortcuts);
+$(summaryToggle);
+$(fixOutsideWorldLinks);
+$(generateTOC);