webgen 1.0.0.beta2 → 1.0.0.beta3

data/COPYING

@@ -1,5 +1,5 @@
 webgen - static website generation made easy
-Copyright (C) 2003-2012 Thomas Leitner <t_leitner@gmx.at>
+Copyright (C) 2003-2013 Thomas Leitner <t_leitner@gmx.at>
 
 webgen is free software: you can redistribute it and/or modify
 it under the terms of the GNU General Public License as published by
@@ -21,3 +21,36 @@ license. These files/directories are listed here:
 data/webgen/passive_sources/stylesheets/coderay-default.css:
   This file has been generated with the coderay_stylesheet binary and
   falls under the LGPL.
+
+data/webgen/passive_sources/stylesheets/api.css
+data/webgen/passive_sources/templates/api.template
+  These files are based on the rdoc darkfish template by Michael Granger
+  and adapted for use with webgen. They are licensed under the following
+  license:
+
+  Copyright (c) 2007, 2008, Michael Granger. All rights reserved.
+
+  Redistribution and use in source and binary forms, with or without
+  modification, are permitted provided that the following conditions are met:
+
+  * Redistributions of source code must retain the above copyright notice,
+    this list of conditions and the following disclaimer.
+
+  * Redistributions in binary form must reproduce the above copyright notice,
+    this list of conditions and the following disclaimer in the documentation
+    and/or other materials provided with the distribution.
+
+  * Neither the name of the author/s, nor the names of the project's
+    contributors may be used to endorse or promote products derived from this
+    software without specific prior written permission.
+
+  THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
+  AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+  IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
+  DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE
+  FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
+  DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
+  SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
+  CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
+  OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
+  OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

data/Rakefile

@@ -93,7 +93,6 @@ EOF
                             'Rakefile',
                             'setup.rb',
                             'VERSION',
-                            'ChangeLog',
                             'AUTHORS',
                             'THANKS',
                             'COPYING',
@@ -115,12 +114,6 @@ EOF
     File.open('VERSION', 'w+') {|file| file.write(Webgen::VERSION + "\n")}
   end
 
-  CLOBBER << 'ChangeLog'
-  file 'ChangeLog' do
-    puts "Generating ChangeLog file"
-    `git log --name-only > ChangeLog`
-  end
-
   Rake::PackageTask.new('webgen', Webgen::VERSION) do |pkg|
     pkg.need_tar = true
     pkg.need_zip = true
@@ -162,7 +155,7 @@ EOF
     s.add_development_dependency('haml', '>= 3.1.0')
     s.add_development_dependency('sass', '>= 3.2.0')
     s.add_development_dependency('builder', '>= 2.1.0')
-    s.add_development_dependency('rdoc', '>= 3.0')
+    s.add_development_dependency('rdoc', '>= 4.0')
     s.add_development_dependency('coderay', '>= 1.0.0')
     s.add_development_dependency('erubis', '>= 2.6.5')
     s.add_development_dependency('rdiscount', '>= 1.3.5')

data/data/webgen/passive_sources/default.metainfo

@@ -25,6 +25,11 @@
 [/**/virtual, /**/*.virtual]:
   handler: virtual
 
+/**/*.api:
+  handler: api
+  api_template: /templates/api.template
+  prefix_for_link_defs: true
+
 [/**/*.css, /**/*.js, /**/*.html, /**/*.gif, /**/*.jpg, /**/*.png, /**/*.ico]:
   handler: copy
 

data/data/webgen/passive_sources/stylesheets/api.css

@@ -0,0 +1,284 @@
+/*
+ * "Darkfish" Rdoc CSS
+ * $Id: rdoc.css 54 2009-01-27 01:09:48Z deveiant $
+ *
+ * Author: Michael Granger <ged@FaerieMUD.org>
+ *
+ * Adapted for webgen by Thomas Leitner <t_leitner@gmx.at>
+ *
+ */
+
+.api-documentation h1 span,
+.api-documentation h2 span,
+.api-documentation h3 span,
+.api-documentation h4 span,
+.api-documentation h5 span,
+.api-documentation h6 span {
+  display: none;
+}
+
+.api-documentation pre {
+  background: #ddd;
+  padding: 0.5em 0;
+}
+
+.api-documentation blockquote {
+  background: #ddd;
+  margin: 1em;
+  padding: 0.25em;
+}
+
+.api-documentation blockquote > :first-child {
+  margin-top: 0 !important;
+}
+
+.api-documentation .missing-docs {
+  font-size: 120%;
+  background: white;
+  color: #ccc;
+  line-height: 2em;
+  border: 1px solid #d00;
+  opacity: 1;
+  padding-left: 20px;
+  text-indent: 24px;
+  letter-spacing: 3px;
+  font-weight: bold;
+  -webkit-border-radius: 5px;
+  -moz-border-radius: 5px;
+}
+
+.api-documentation .target-section {
+  border: 2px solid #dcce90;
+  border-left-width: 8px;
+  padding: 0 1em;
+  background: #fff3c2;
+}
+
+/* @group Documentation Section */
+.api-documentation .description {
+  font-size: 100%;
+  color: #333;
+}
+
+.api-documentation .description p {
+  margin: 1em 0.4em;
+}
+
+.api-documentation .description li p {
+  margin: 0;
+}
+
+.api-documentation .description ol,
+.api-documentation .description ul {
+  margin-left: 1.5em;
+}
+.api-documentation .description ol li,
+.api-documentation .description ul li {
+  line-height: 1.4em;
+}
+
+.api-documentation .note-list {
+  margin: 8px 0;
+}
+
+.api-documentation .label-list {
+  margin: 8px 1.5em;
+  border: 1px solid #ccc;
+}
+.api-documentation .description .label-list {
+  font-size: 14px;
+}
+
+.api-documentation .note-list dt {
+  font-weight: bold;
+}
+.api-documentation .note-list dd {
+  padding: 0 12px;
+}
+
+.api-documentation .label-list dt {
+  padding: 2px 4px;
+  font-weight: bold;
+  background: #ddd;
+}
+.api-documentation .label-list dd {
+  padding: 2px 12px;
+}
+.api-documentation .label-list dd + dt,
+.api-documentation .note-list dd + dt {
+  margin-top: 0.7em;
+}
+
+.api-documentation .section {
+  font-size: 90%;
+}
+
+.api-documentation h2.section-header {
+  margin-top: 1em;
+  padding: 0.25em 0.5em;
+  background: #ccc;
+  color: #333;
+  font-size: 175%;
+  border: 1px solid #bbb;
+  -moz-border-radius: 3px;
+  -webkit-border-radius: 3px;
+}
+
+.documentation-section-title {
+  position: relative;
+}
+.documentation-section-title .section-click-top {
+  position: absolute;
+  top: 6px;
+  right: 12px;
+  font-size: 10px;
+  color: #9b9877;
+  visibility: hidden;
+  padding-right: 0.5px;
+}
+
+.documentation-section-title:hover .section-click-top {
+  visibility: visible;
+}
+
+.api-documentation h3.section-header {
+  margin-top: 1em;
+  padding: 0.25em 0.5em;
+  background-color: #dedede;
+  color: #333;
+  font-size: 150%;
+  border: 1px solid #bbb;
+  -moz-border-radius: 3px;
+  -webkit-border-radius: 3px;
+}
+
+.documentation-section h2 {
+  position: relative;
+}
+
+.documentation-section h2 a {
+  position: absolute;
+  top: 8px;
+  right: 10px;
+  font-size: 12px;
+  color: #9b9877;
+  visibility: hidden;
+}
+
+.documentation-section h2:hover a {
+  visibility: visible;
+}
+
+/* @group Method Details */
+
+.api-documentation .method-source-code {
+  display: none;
+}
+
+.api-documentation .method-description .method-calls-super {
+  color: #333;
+  font-weight: bolder;
+}
+
+.api-documentation .method-detail {
+  margin: 0.5em 0;
+  padding: 0.5em 0;
+  cursor: pointer;
+}
+.api-documentation .method-detail:hover {
+  background-color: #f1edba;
+}
+.api-documentation .method-heading {
+  position: relative;
+  padding: 2px 4px 0 20px;
+  font-size: 125%;
+  font-weight: bold;
+  color: #333;
+}
+.api-documentation .method-heading :link,
+.api-documentation .method-heading :visited {
+  color: inherit;
+}
+.api-documentation .method-click-advice {
+  position: absolute;
+  top: 2px;
+  right: 5px;
+  font-size: 10px;
+  color: #9b9877;
+  visibility: hidden;
+  padding-right: 20px;
+  line-height: 20px;
+}
+.api-documentation .method-heading:hover .method-click-advice {
+  visibility: visible;
+}
+
+.api-documentation .method-alias .method-heading {
+  color: #666;
+}
+
+.api-documentation .method-description,
+.api-documentation .aliases {
+  margin: 0 20px;
+  color: #666;
+}
+
+.api-documentation .method-description p,
+.api-documentation .aliases p {
+  line-height: 1.2em;
+}
+
+.api-documentation .aliases {
+  padding-top: 4px;
+  font-style: italic;
+  cursor: default;
+}
+.api-documentation .method-description p {
+  margin-bottom: 0.5em;
+}
+.api-documentation .method-description ul {
+  margin-left: 1.5em;
+}
+.api-documentation pre {
+  margin: 0.5em 0;
+}
+
+.api-documentation #attribute-method-details .method-detail:hover {
+  background-color: transparent;
+  cursor: default;
+}
+.api-documentation .attribute-access-type {
+  font-size: 60%;
+  text-transform: uppercase;
+  vertical-align: super;
+  padding: 0 2px;
+}
+/* @end */
+
+/* @end */
+
+/* @group Source Code */
+
+.api-documentation pre {
+  overflow: auto;
+  background: #262626;
+  color: white;
+  border: 1px dashed #999;
+  padding: 0.5em;
+}
+
+.api-documentation .description pre {
+  margin: 0 0.4em;
+}
+
+.ruby-constant   { color: #7fffd4; background: transparent; }
+.ruby-keyword    { color: #00ffff; background: transparent; }
+.ruby-ivar       { color: #eedd82; background: transparent; }
+.ruby-operator   { color: #00ffee; background: transparent; }
+.ruby-identifier { color: #ffdead; background: transparent; }
+.ruby-node       { color: #ffa07a; background: transparent; }
+.ruby-comment    { color: #dc0000; font-weight: bold; background: transparent; }
+.ruby-regexp     { color: #ffa07a; background: transparent; }
+.ruby-value      { color: #7fffd4; background: transparent; }
+
+/* @end */

data/data/webgen/passive_sources/templates/api.template

@@ -0,0 +1,151 @@
+--- name:content pipeline:erb
+<% klass = context.node.node_info[:api_class_object] %>
+<div class="api-documentation api-<%= klass.type %>">
+  <h1 class="<%= klass.type %>"><%= klass.type %> <%= klass.full_name %></h1>
+
+  <div class="description">
+    <%= klass.description %>
+  </div><!-- description -->
+
+  <% klass.each_section do |section, constants, attributes| %>
+  <% constants = constants.select { |const| const.display? } %>
+  <% attributes = attributes.select { |attr| attr.display? } %>
+  <section id="<%= section.aref %>" class="documentation-section">
+    <% if section.title then %>
+    <div class="documentation-section-title">
+      <h2 class="section-header">
+        <%= section.title %>
+      </h2>
+    </div>
+    <% end %>
+
+    <% if section.comment then %>
+    <div class="description">
+      <%= section.description %>
+    </div>
+    <% end %>
+
+    <% unless constants.empty? then %>
+    <!-- Constants -->
+    <section id="constants-list" class="section">
+      <h3 class="section-header">Constants</h3>
+      <dl>
+      <% constants.each do |const| %>
+        <dt id="<%= const.name %>"><%= const.name %>
+        <% if const.comment then %>
+        <dd class="description"><%= const.description.strip %>
+        <% else %>
+        <dd class="description missing-docs">(Not documented)
+        <% end %>
+      <% end %>
+      </dl>
+    </section>
+    <% end %>
+
+    <% unless attributes.empty? then %>
+    <!-- Attributes -->
+    <section id="attribute-method-details" class="method-section section">
+      <h3 class="section-header">Attributes</h3>
+
+      <% attributes.each do |attrib| %>
+      <div id="<%= attrib.aref %>" class="method-detail">
+        <div class="method-heading attribute-method-heading">
+          <span class="method-name"><%= h attrib.name %></span><span
+            class="attribute-access-type">[<%= attrib.rw %>]</span>
+        </div>
+
+        <div class="method-description">
+        <% if attrib.comment then %>
+        <%= attrib.description.strip %>
+        <% else %>
+        <p class="missing-docs">(Not documented)
+        <% end %>
+        </div>
+      </div>
+      <% end %>
+    </section><!-- attribute-method-details -->
+    <% end %>
+
+    <!-- Methods -->
+    <% klass.methods_by_type(section).each do |type, visibilities|
+       next if visibilities.empty?
+       visibilities.each do |visibility, methods|
+         next if methods.empty? %>
+     <section id="<%= visibility %>-<%= type %>-<%= section.aref %>-method-details" class="method-section section">
+      <h3 class="section-header"><%= visibility.to_s.capitalize %> <%= type.capitalize %> Methods</h3>
+
+    <% methods.each do |method| %>
+      <div id="<%= method.aref %>" class="method-detail <%= method.is_alias_for ? "method-alias" : '' %>">
+        <% if method.call_seq then %>
+        <%   method.call_seq.strip.split("\n").each_with_index do |call_seq, i| %>
+        <div class="method-heading">
+          <span class="method-callseq">
+            <%= h(call_seq.strip.
+                  gsub( /^\w+\./m, '')).
+                  gsub(/(.*)[-=]&gt;/, '\1&rarr;') %>
+          </span>
+          <% if i == 0 and method.token_stream then %>
+          <span class="method-click-advice">click to toggle source</span>
+          <% end %>
+        </div>
+        <%   end %>
+        <% else %>
+        <div class="method-heading">
+          <span class="method-name"><%= h method.name %></span><span
+            class="method-args"><%= method.param_seq %></span>
+          <% if method.token_stream then %>
+          <span class="method-click-advice">click to toggle source</span>
+          <% end %>
+        </div>
+        <% end %>
+
+        <div class="method-description">
+          <% if method.comment then %>
+          <%= method.description.strip %>
+          <% else %>
+          <p class="missing-docs">(Not documented)
+          <% end %>
+          <% if method.calls_super then %>
+            <div class="method-calls-super">
+              Calls superclass method
+              <%=
+                  method.superclass_method ?
+                  method.formatter.link(method.superclass_method.full_name, method.superclass_method.full_name) : nil
+              %>
+            </div>
+          <% end %>
+
+          <% if method.token_stream then %>
+          <div class="method-source-code" id="<%= method.html_name %>-source">
+            <pre><%= method.markup_code %></pre>
+          </div><!-- <%= method.html_name %>-source -->
+          <% end %>
+        </div>
+
+        <% unless method.aliases.empty? then %>
+        <div class="aliases">
+          Also aliased as: <%= method.aliases.map do |aka|
+            if aka.parent then # HACK lib/rexml/encodings
+              %{<a href="#{klass.aref_to aka.path}">#{h aka.name}</a>}
+            else
+              h aka.name
+            end
+          end.join ", " %>
+        </div>
+        <% end %>
+
+        <% if method.is_alias_for then %>
+        <div class="aliases">
+          Alias for: <a href="<%= klass.aref_to method.is_alias_for.path %>"><%= h method.is_alias_for.name %></a>
+        </div>
+        <% end %>
+      </div><!-- <%= method.html_name %>-method -->
+
+    <% end %>
+    </section><!-- <%= visibility %>-<%= type %>-method-details -->
+  <% end
+     end %>
+  </section><!-- <%= section.aref %> -->
+<% end %>
+
+</div><!-- documentation -->