copland 0.8.0

data/doc/manual/chapter.erb

@@ -0,0 +1,18 @@
+<h1><%= object.index %>. <%= object.title %></h1>
+
+<% object.sections.each do |section|
+
+   if section.title %>
+
+     <h2>
+       <a name="s<%= section.index %>"></a>
+       <%= object.index %>.<%= section.index %>. <%= section.title %>
+     </h2>
+
+   <% end %>
+
+   <div class="section">
+     <%= section.content.to_html %>
+   </div>
+
+<% end %>

data/doc/manual/example.erb

@@ -0,0 +1,18 @@
+<h1>Example #<%= object.index %>. <%= object.title %></h1>
+
+<h2>Introduction</h2>
+
+<%= object.intro.to_html %>
+
+<h2>Design</h2>
+
+<%= object.design.to_html %>
+
+<h2>Implementation</h2>
+
+<%= object.implementation.to_html %>
+
+<h2>Summary</h2>
+
+<%= object.summary.to_html %>
+

data/doc/manual/index.erb

@@ -0,0 +1,30 @@
+<p class="product-manual">Product Manual</p>
+
+<p align="center">
+  <img src="<%= manual.product.logo %>"
+       alt="<%= manual.product.name %>: <%= manual.product.tagline %>" />
+</p>
+
+<p align="center">
+  <%= manual.product.name %> Website:
+    <a href="<%= manual.product.web %>"><%= manual.product.web %></a><br />
+  <%= manual.product.name %> Project Website:
+    <a href="<%= manual.product.project %>"><%= manual.product.project %></a><br />
+</p>
+
+<% if manual.recent_updates && manual.recent_updates.length > 0 %>
+  <p align="center"><strong>Recent Updates to This Manual</strong></p>
+  <table border='0' cellpadding='0' cellspacing='0' align='center'><tr><td>
+    <ul>
+      <% manual.recent_updates.each do |update| %>
+        <li><%= update %></li>
+      <% end %>
+    </ul>
+  </table>
+<% end %>
+
+<p class="copyright">
+  Copyright &copy; <%= manual.meta.copyright %>
+                   <%= manual.meta.author %>
+                   (<a href="mailto:<%= manual.meta.email %>"><%= manual.meta.email %></a>)
+</p>

data/doc/manual/manual.css

@@ -0,0 +1,179 @@
+body {
+  background: #FFF;
+  font-family: sans-serif;
+  color: #000;
+  margin: 0px;
+}
+
+a {
+  color: #00F;
+  text-decoration: none;
+}
+
+a:hover {
+  text-decoration: underline;
+}
+
+.product-manual {
+  text-align: center;
+  font-size: x-large;
+  font-variant: small-caps;
+  font-weight: bold;
+  color: #005;
+}
+
+.copyright {
+  text-align: center;
+  font-size: small;
+  font-style: italic;
+  color: #005;
+  margin-top: 1in;
+}
+
+#banner {
+  background: #005;
+  color: #FFF;
+  border-bottom: 1px solid #000;
+  padding-top: 0.5em;
+  padding-bottom: 0.5em;
+  padding-left: 1em;
+  margin-bottom: 1em;
+}
+
+#banner .title {
+  font-size: x-large;
+}
+
+#banner .title:first-letter {
+  font-size: 250%;
+  font-weight: normal;
+  float: left;
+  margin-top: -7px;
+  margin-bottom: -7px;
+}
+
+#banner .product {
+  font-weight: bold;
+  color: #FF7;
+  letter-spacing: 0.5em;
+}
+
+#banner .tagline {
+  font-style: italic;
+  font-size: large;
+  color: #FFF;
+}
+
+#banner .info {
+  color: white;
+  font-size: small;
+  padding-right: 1em;
+}
+
+#content {
+  margin-left: 0cm;
+  margin-right: 1cm;
+}
+
+#navigation {
+  font-size: x-small;
+  border-right: 2px groove black;
+  border-top: 2px groove black;
+  margin-right: 1em;
+  width: 200px;
+  height: 100%;
+  background: #FFD;
+}
+
+#navigation ul, #navigation ol {
+  margin-left: 1.5em;
+  padding-left: 1.5em;
+}
+
+#navigation .license {
+  font-size: x-small;
+  text-align: center;
+  border-top: 1px dashed #005;
+  margin-top: 2em;
+  padding: 1em;
+}
+
+.section {
+  margin-bottom: 1em;
+}
+
+.section p {
+  text-align: justify;
+}
+
+#content pre {
+  background: #FFE;
+  border: 1px dotted #AAA;
+  padding: 1em;
+}
+
+#content h1 {
+  background: #005;
+  color: #FFF;
+  font-size: x-large;
+  font-weight: bold;
+  font-variant: small-caps;
+  padding: 0.5em;
+  border: 1px solid #000;
+  margin-top: 0px;
+  margin-bottom: 1em;
+}
+
+#content h2 {
+  background: #005;
+  color: #FFF;
+  font-size: large;
+  font-weight: bold;
+  font-variant: small-caps;
+  padding: 0.25em;
+  padding-left: 0.5em;
+  border: 1px solid #000;
+  margin-bottom: 1em;
+}
+
+#content h3 {
+  background: #FFD;
+  color: #000;
+  font-size: normal;
+  font-weight: bold;
+  font-variant: small-caps;
+  padding: 0.25em;
+  padding-left: 0.5em;
+  border: 1px dotted #000;
+  margin-bottom: 1em;
+}
+
+#navigation h1 {
+  margin: 0px;
+  padding: 1em;
+  color: #005;
+  background: transparent;
+  font-weight: bold;
+  font-size: 150%;
+  font-variant: small-caps;
+  text-align: center;
+}
+
+#navigation h2 {
+  margin: 0px;
+  margin-bottom: 1em;
+  padding: 0.5em;
+  border-top: 1px dashed #005;
+  border-bottom: 1px dashed #005;
+  color: #005;
+  background: transparent;
+  font-weight: bold;
+  font-size: 125%;
+  font-variant: small-caps;
+  text-align: center;
+}
+
+table.list td {
+  border-bottom: 1px dotted #005;
+  padding-bottom: 5px;
+}

data/doc/manual/manual.rb

@@ -0,0 +1,239 @@
+# --------------------------------------------------------------------------
+# Portions of this code were taken from the "poignant.rb" script created
+# by whytheluckystiff, which generates "Why's (Poignant) Guide to Ruby".
+# The original script may be obtained from the poignant CVS repository,
+# at http://poignant.rubyforge.org.
+#
+# This script is distributed under the by-sa/1.0 Creative Commons license.
+# --------------------------------------------------------------------------
+
+require 'erb'
+require 'ftools'
+require 'yaml'
+
+require 'rubygems'
+require_gem 'RedCloth'
+
+module Copland
+  module Manual
+
+    class Manual
+      attr_accessor :product, :meta, :chapters, :tutorials, :examples, :recent_updates
+
+      def Manual.load( file_name )
+        File.open( file_name ) { |file| YAML.load( file ) }
+      end
+    end
+
+    class Meta
+      attr_accessor :copyright, :author, :email
+    end
+
+    class Product
+      attr_accessor :name, :tagline, :version, :logo, :web, :project
+    end
+
+    class Sidebar
+      attr_accessor :title, :content
+    end
+
+    class Chapter
+      attr_accessor :index, :title, :sections
+
+      def initialize( index, title, sections )
+        @index = index
+        @title = title
+
+        section_index = 0
+        @sections = sections.collect do |section|
+          section_index += 1
+          if section.respond_to? :keys
+            Section.new( section_index, section.keys.first, section.values.first )
+          else
+            section_index -= 1
+            Section.new( section_index, nil, section )
+          end
+        end
+      end
+
+      def page_title
+        "Chapter #{index}: #{title}"
+      end
+    end
+
+    class Tutorial
+      attr_accessor :index, :title, :brief, :intro, :steps, :summary
+
+      def initialize( index, title, brief, intro, steps, summary )
+        @index = index
+        @title = title
+        @brief = RedCloth.new( brief )
+        @intro = RedCloth.new( intro ) if intro
+        @summary = RedCloth.new( summary ) if summary
+        @steps = steps.map { |step| RedCloth.new( step ) }
+      end
+
+      def page_title
+        "Tutorial #{index}: #{title}"
+      end
+    end
+
+    class Example
+      attr_accessor :index, :title, :brief, :intro, :design, :implementation, :summary
+
+      def initialize( index, title, brief, intro, design, implementation, summary )
+        @index = index
+        @title = title
+        @brief = RedCloth.new( brief )
+        @intro = RedCloth.new( intro )
+        @design = RedCloth.new( design )
+        @implementation = RedCloth.new( implementation )
+        @summary = RedCloth.new( summary )
+      end
+
+      def page_title
+        "Example #{index}: #{title}"
+      end
+    end
+
+    class Section
+      attr_accessor :index, :title, :content
+
+      def initialize( index, title, content )
+        @index = index
+        @title = title
+        @content = RedCloth.new( content )
+      end
+    end
+
+    YAML.add_domain_type( 'jamisbuck.org,2004', 'manual' ) do |taguri, val|
+      index = 0
+
+      val['chapters'].collect! do |chapter|
+        index += 1
+        Chapter.new( index, chapter.keys.first, chapter.values.first )
+      end
+
+      index = 0
+      ( val['tutorials'] ||= [] ).collect! do |tutorial|
+        index += 1
+        content = tutorial.values.first
+        Tutorial.new( index, tutorial.keys.first, content['brief'], content['intro'],
+                      content['steps'], content['summary'] )
+      end
+
+      index = 0
+      ( val['examples'] ||= [] ).collect! do |example|
+        index += 1
+        content = example.values.first
+        Example.new( index, example.keys.first, content['brief'], content['intro'], content['design'],
+                     content['implementation'], content['summary'] )
+      end
+
+      YAML.object_maker( Manual, val )
+    end
+
+    YAML.add_domain_type( 'jamisbuck.org,2004', 'meta' ) do |taguri, val|
+      YAML.object_maker( Meta, val )
+    end
+
+    YAML.add_domain_type( 'jamisbuck.org,2004', 'product' ) do |taguri, val|
+      version = val["version"]
+      if version.respond_to?( :type_id )
+        if version.type_id == "version"
+          if version.value =~ %r{(.*)/(.*)}
+            require_file, constant = $1, $2
+          else
+            constant = version.value
+          end
+
+          require require_file if require_file
+          val["version"] = eval(constant)
+        else
+          raise "Unexpected type: #{val.type_id}"
+        end
+      end
+      YAML.object_maker( Product, val )
+    end
+
+    YAML.add_domain_type( 'jamisbuck.org,2004', 'sidebar' ) do |taguri, val|
+      YAML.object_maker( Sidebar,
+                         'title' => val.keys.first,
+                         'content'=> RedCloth.new( val.values.first ) )
+    end
+
+  end
+end
+
+if __FILE__ == $0
+
+  def log_action( action )
+    $stderr.puts action
+  end
+
+  unless ( output_path = ARGV[0] )
+    $stderr.puts "Usage: #{$0} [/path/to/save/html]"
+    exit
+  end
+
+  Dir.mkdir output_path rescue nil
+
+  log_action "Loading manual.yml..."
+  manual = Copland::Manual::Manual.load( 'manual.yml' )
+
+  # force these to be defined at the TOPLEVEL_BINDING
+  object = nil
+  guts = nil
+
+  page = File.open( "page.erb" ) { |file| ERB.new( file.read ) }
+  page.filename = "page.erb"
+
+  template = File.open( "index.erb" ) { |file| ERB.new( file.read ) }
+  template.filename = "index.erb"
+
+  File.open( File.join( output_path, "index.html" ), "w" ) do |file|
+    guts = template.result
+    file << page.result
+  end
+
+  template = File.open( "chapter.erb" ) { |file| ERB.new( file.read ) }
+  template.filename = "chapter.erb"
+
+  manual.chapters.each do |object|
+    log_action "Processing chapter ##{object.index}..."
+    File.open( File.join( output_path, "chapter-#{object.index}.html" ), "w" ) do |file|
+      guts = template.result
+      file << page.result
+    end
+  end
+
+  template = File.open( "tutorial.erb" ) { |file| ERB.new( file.read ) }
+  template.filename = "tutorial.erb"
+
+  manual.tutorials.each do |object|
+    log_action "Processing tutorial ##{object.index}..."
+    File.open( File.join( output_path, "tutorial-#{object.index}.html" ), "w" ) do |file|
+      guts = template.result
+      file << page.result
+    end
+  end
+
+#  template = File.open( "example.erb" ) { |file| ERB.new( file.read ) }
+#  template.filename = "example.erb"
+
+#  manual.examples.each do |object|
+#    log_action "Processing example ##{object.index}..."
+#    File.open( File.join( output_path, "example-#{object.index}.html" ), "w" ) do |file|
+#      guts = template.result
+#      file << page.result
+#    end
+#  end
+
+  log_action "Copying manual.css..."
+  File.copy( "manual.css", output_path )
+
+  log_action "Copying copland.png..."
+  File.copy( "img/copland.png", output_path )
+
+  log_action "Done!"
+end