ruby-vpi 19.0.0 → 20.0.0

data/doc/README

@@ -1,9 +0,0 @@
-The *.doc files in this directory are plain-text files!
-
-To transform them into XHTML, you need the following software:
-
-* Rake:     http://docs.rubyrake.org/
-* RedCloth: http://whytheluckystiff.net/ruby/redcloth/
-* Coderay:  http://coderay.rubychan.de/
-
-Once you have the above software, simply run the "rake" command.

data/doc/Rakefile

@@ -1,92 +0,0 @@
-# Generates the documentation in HTML format.
-#--
-# Copyright 2006 Suraj N. Kurapati
-# See the file named LICENSE for details.
-
-require 'rake/clean'
-
-
-$: << File.join(File.dirname(__FILE__), '..', 'lib')
-require 'ruby-vpi'
-include RubyVPI
-
-HISTORY_URL = PROJECT_URL + "/doc/history.html"
-RSS_URL     = PROJECT_URL + '/doc/rss.xml'
-RSS_INFO    = "RSS feed for this project."
-
-require 'ruby-vpi/erb'
-include ERB::Util
-
-
-$: << File.join(File.dirname(__FILE__), 'lib')
-require 'doc_proxy'
-
-
-def resolve_includes aFilePath
-  input = File.read(aFilePath)
-
-  input.gsub! %r{<doc_proxy_include *(.*?)>} do
-    resolve_includes($1)
-  end
-
-  input
-end
-
-
-FileList['*.doc'].each do |src|
-  prefix = File.basename(src, File.extname(src))
-  helper = prefix + '.rb'
-  dst = prefix + '.html'
-  deps = FileList[prefix + '*'].exclude(src, dst)
-
-  desc "Process file #{src.inspect}."
-  file dst => [src, 'common.tpl', *deps] do |t|
-    puts src
-
-    content = DocProxy.new.instance_eval do
-      # default output configuration
-      insert_toc = true
-      page_title = nil
-
-      # load the documentation's helper
-        if File.exist? helper
-          instance_eval File.read(helper)
-        end
-
-      # evaluate the documentation file
-        input = resolve_includes(src)
-        File.open('input', 'w') {|f| f << input} if $DEBUG
-
-        template = ERB.new(input)
-        content = template.result(binding)
-        toc, content = post_process(content)
-
-
-      # fit result into common HTML format
-        template = ERB.new(File.read(t.prerequisites[1]))
-        template.result(binding)
-    end
-
-    File.open(dst, 'w') do |f|
-      f << content
-    end
-  end
-
-  task :default => dst
-  CLOBBER.include dst
-end
-
-
-desc "Generate RSS feed."
-file 'rss.xml' => FileList['rss.erb', 'history*'] do |t|
-  template = ERB.new(File.read(t.prerequisites[0]))
-  content = template.result
-
-  File.open(t.name, 'w') do |f|
-    f << content
-    puts f.path
-  end
-end
-
-task :default => 'rss.xml'
-CLOBBER.include 'rss.xml'

data/doc/common.css

@@ -1,108 +0,0 @@
-@import 'spacing.css';
-
-body {
-  line-height: 1.8em;
-}
-
-
-/* tables */
-
-table {
-  background-color: white; /* otherwise it's transparent! */
-}
-
-th, td {
-  padding: 0.5em;
-  border: thin solid silver;
-}
-
-th {
-  background-color: whitesmoke;
-}
-
-
-/* latex */
-
-.front_cover h1,
-.front_cover h2,
-.front_cover h3,
-.front_cover h4,
-.front_cover h5,
-.front_cover h6 {
-  text-align: center;
-}
-
-
-/* admonitions */
-
-.admonition {
-  border: thin solid seagreen;
-  background-color: honeydew;
-}
-
-.admonition .icon {
-  margin-top: 0;
-  margin-left: 0;
-  float: left;
-}
-
-
-/* source code */
-
-tt {
-  font-weight: bold;
-  color: brown;
-  background-color: floralwhite;
-}
-
-pre {
-  line-height: normal;
-  display: block;
-
-  border: thin solid darkgray;
-  background-color: whitesmoke;
-}
-
-.code {
-  border: thin solid darkkhaki;
-  background-color: ivory;
-}
-
-
-/* formal blocks */
-
-.formal .title {
-  display: block;
-  font-size: large;
-  text-align: center
-}
-
-/* center-align any tables and images */
-.formal table, .formal img {
-  margin-left: auto;
-  margin-right: auto;
-}
-.formal img {
-  display: block;
-}
-
-
-
-/* emphasis */
-
-pre, code, .admonition {
-  border-radius: 1em;
-  -moz-border-radius: 1em;
-  -webkit-border-radius: 1em;
-}
-
-
-/* fix annoyances */
-
-img {
-  margin: 1em;
-}
-
-a img {
-  border: none;
-}

data/doc/common.inc

@@ -1,14 +0,0 @@
-<%
-  unindent '  ' # 2 spaces
-
-  history = YAML.load_file('history.yaml')
-  version = history.first['Version']
-
-  projectURL  = 'http://ruby-vpi.rubyforge.org/'
-  downloadURL = projectURL + 'download/'
-  forumURL    = projectURL + 'forum/'
-  mailListURL = projectURL + 'mail/'
-  trackerURL  = projectURL + 'tracker/'
-  portalURL   = projectURL + 'portal/'
-  codeURL     = projectURL + 'code/'
-%>

data/doc/common.tpl

@@ -1,90 +0,0 @@
-<%
-  require 'doc_format'
-
-  # set default page title if none was given
-  unless page_title
-    if h = @nodeTree.group2nodes[:latex].first
-      page_title = h.title
-    end
-  end
-
-  Listing = Struct.new(:name, :anchor, :key, :nodes) unless defined? Listing
-
-  listings = (
-    DocProxy::GROUP2TYPES[:admonition] +
-    DocProxy::GROUP2TYPES[:formal]
-  ).flatten.inject([]) do |ary, key|
-    nodes = @nodeTree.type2nodes[key]
-
-    unless nodes.empty?
-      ary << Listing.new(key.to_s.capitalize << 's', "toc:#{key}".to_html_anchor, key, nodes)
-    end
-
-    ary
-  end
-%>
-<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
-<html>
-  <head>
-    <meta http-equiv="content-type" content="text/html; charset=utf-8"/>
-    <link rel="stylesheet" type="text/css" href="screen.css" media="screen" />
-    <link rel="stylesheet" type="text/css" href="print.css" media="print" />
-    <link rel="alternate stylesheet" type="text/css" href="print.css" title="Print Preview" />
-    <link rel="alternate" type="application/rss+xml" href="<%= RSS_URL %>" title="<%= RSS_INFO %>" />
-    <title><%= page_title %></title>
-  </head>
-  <body>
-    <div id="menu">
-      <h1>Site navigation</h1>
-      <ul id="site-links">
-        <li><a href="readme.html">Home</a></li>
-        <%
-          Dir['*.doc'].each do |src|
-            name, ext = src.split('.', 2)
-            next if name == 'readme'
-        %>
-          <li><a href="<%= name %>.html"><%= name.capitalize %></a></li>
-        <% end %>
-      </ul>
-
-      <% if insert_toc %>
-        <%
-          links = listings.map do |x|
-            %{<a href="##{x.anchor}">#{x.name}</a>}
-          end
-
-          unless links.empty?
-        %>
-        <h1>Menu navigation</h1>
-        <ul id="toc-links">
-          <%=
-            links.unshift %{<a href="#toc-contents">Contents</a>}
-            links.map {|x| "<li>#{x}</li>"}.join
-          %>
-        </ul>
-        <% end %>
-
-        <div id="toc">
-          <h1 id="toc-contents">Contents</h1>
-          <%= toc %>
-
-          <% listings.each do |x| %>
-            <h1 id="<%= x.anchor %>"><%= x.name %></h1>
-            <ol>
-            <% x.nodes.map do |node| %>
-              <%= %{<li><a href="##{node.anchor}" id="#{node.tocAnchor}">#{node.title.to_html}</a></li>} %>
-            <% end %>
-            </ol>
-          <% end %>
-        </div>
-      <% end %>
-    </div>
-
-    <div id="body">
-      <%= content %>
-      <br/>
-      <hr/>
-      This website is maintained by Suraj N. Kurapati (SNK at GNA dot ORG). This particular webpage was last updated on <%= Time.now %>.
-    </div>
-  </body>
-</html>

data/doc/history.doc

@@ -1,17 +0,0 @@
-<doc_proxy_include common.inc>
-
-<% front_cover "Release history" do %>
-  This is a record of important changes that have occurred with each release.
-
-  <% paragraph "Version numbering system" do %>
-    Ruby-VPI uses the "RubyGems rational versioning policy":http://www.rubygems.org/read/chapter/7 to number its releases. This "major.minor.build" numbering policy "is summarized":http://ablog.apress.com/?p=738 as follows.
-
-    * When the *major* number increases, functionally _incompatible changes_ have occurred. Thus, what may have worked in the previous version may not work in the new one.
-
-    * When the *minor* number increases, functionally _compatible changes_ have occurred. Thus, what worked in the previous version will work in the new one.
-
-    * When the *build* number increases, the _underlying implementation_ has changed. The functionality has not changed and no features have been added. Thus, what worked in the previous version will work in the new one.
-  <% end %>
-<% end %>
-
-<doc_proxy_include history.inc>