ruby-vpi 16.0.1 → 17.0.0

data/doc/common.css

@@ -1,57 +1,117 @@
 body {
+  margin: 0;
+  background-color: snow;
+  line-height: 160%;
+}
+
+#body {
   margin-left: auto;
   margin-right: auto;
-  max-width: 600px;
+  max-width: 37em;
+
+  background-color: white;
+  border-left: thick solid salmon;
+  border-right: thick solid salmon;
+  padding: 2em;
+}
 
-  margin-bottom: 5em; /* give space for #menu */
-  margin-top: 2.25em; /* give space for breathing */
+#body > h1 {
+  margin-top: 0;
 }
 
 
 /* headings */
 
-th, h1, h2, h3, h4, h5, h6, .title {
+h1, h2, h3, h4, h5, h6, th, .title {
   font-family: serif;
 }
 
 h1, h2, h3, h4, h5, h6 {
-  margin-top: 3em;
+  font-weight: lighter;
+  padding-top: 3em;
   border-bottom: thin solid silver;
 }
 
 
 /* table of contents */
 
-#menu {
-  position: fixed;
-  left: 0px;
-  bottom: 0px;
-  width: 100%;
+#toc-links {
+  text-align: center;
+  border-bottom: thick solid salmon;
+  background-color: white;
+  padding: 1em;
+}
+
+#toc {
+  border-top: thick solid salmon;
+  background-color: white;
+  padding: 1em;
+}
 
-  background-color: whitesmoke;
-  border-top: thin solid silver;
+#toc li {
+  margin-left: -15px;
+}
+
+
+/* latex */
+
+.front_cover {
+  margin-bottom: 10em;
+}
+
+.front_cover h1,
+.front_cover h2,
+.front_cover h3,
+.front_cover h4,
+.front_cover h5,
+.front_cover h6 {
+  border: none;
   text-align: center;
 }
 
-#menu a {
-  color: black;
+.part,
+.chapter {
+  padding-top: 3em;
+  padding-bottom: 3em;
+}
+
+.part > .title,
+.chapter > .title {
+  border: none;
+  padding-bottom: 1em;
+}
+
+.part > .title {
+  border-bottom: thick solid salmon;
+}
+
+.paragraph > .title,
+.admonition .title {
+  font-family: serif;
+  font-size: larger;
+}
+
+.paragraph > .title {
+  padding-top: 1em;
 }
 
 
 /* admonitions */
 
 .admonition {
-  border: thin solid steelblue;
-  background-color: aliceblue;
+  border: thin solid seagreen;
+  background-color: honeydew;
   padding: 1em;
-  margin-bottom: 1em;
   margin-top: 1em;
+  margin-bottom: 1em;
 
-  min-height: 170px;
+  min-height: 150px;
 }
 
-.admonition img {
-  margin-right: 2em;
+.admonition .icon {
+  margin-top: 0;
+  margin-left: 0;
+  float: left;
 }
 
 
@@ -83,6 +143,10 @@ pre {
 
 /* tables */
 
+table {
+  background-color: white; /* otherwise it's transparent! */
+}
+
 th, td {
   padding: 1em;
   border: thin solid silver;
@@ -96,15 +160,13 @@ th {
 /* formal blocks; see http://www.sagehill.net/docbookxsl/FormalTitles.html */
 
 .formal {
-  margin: 1em;
+  padding-top: 1em;
+  padding-bottom: 1em;
 }
 
-.title {
+.formal .title {
   display: block;
   font-size: large;
-}
-
-.formal .title {
   text-align: center
 }
 
@@ -145,6 +207,11 @@ big {
   font-size: larger;
 }
 
+a:hover {
+  color: red;
+}
+
+
 /* fix annoyances */
 
 img {
@@ -154,11 +221,3 @@ img {
 a img {
   border: none;
 }
-
-#menu li, .entry .toc li {
-  margin-left: -1.5em;
-}
-
-.formal .title {
-  margin-top: 3em;
-}

data/doc/common.inc

@@ -0,0 +1,13 @@
+<%
+  unindent '  ' # 2 spaces
+
+  history = YAML.load_file('history.yaml')
+  version = history.first['Version']
+
+  downloadURL = 'http://rubyforge.org/frs/?group_id=1339'
+  forumURL    = 'http://rubyforge.org/forum/?group_id=1339'
+  trackerURL  = 'http://rubyforge.org/tracker/?group_id=1339'
+  portalURL   = 'http://rubyforge.org/projects/ruby-vpi'
+  codeURL     = 'http://ruby-vpi.rubyforge.org/src/ruby-vpi'
+  projectURL  = 'http://ruby-vpi.rubyforge.org'
+%>

data/doc/common.tpl

@@ -2,11 +2,26 @@
   require 'doc_format'
 
   # set default page title if none was given
-    unless page_title
-      if h = @headings.first
-        page_title = h.title
-      end
+  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>
@@ -19,39 +34,38 @@
   </head>
   <body>
   <% if insert_toc %>
-    <h1 style="margin-top: 0"><%= page_title %></h1>
-
-    <%= %{p=. !images/tango/home.png(Return to main page)!:readme.html}.redcloth %>
-
-    <div id="menu">
-      <%=
-        links = @indexes.values.flatten.map do |i|
-          %{<a href="##{i.name.downcase}">#{i.name}</a>}
+    <div id="toc-links">
+      <%
+        links = listings.map do |x|
+          %{<a href="##{x.anchor}">#{x.name}</a>}
         end
-        links.unshift %{<a href="#index">Contents</a>}
-
-        links.join ' &middot; '
+        links.unshift %{<a href="#toc:contents">Contents</a>}
       %>
+      <% links.each do |link| %>
+        <%= link %> &middot;
+      <% end %>
+
+      <a href="readme.html" style="color: green; font-size: larger;">Home page</a>
     </div>
+  <% end %>
 
-    <div id="index">
-      <h1>Contents</h1>
-      <%= toc %>
+    <div id="body"><%= content %></div>
 
-      <% @indexes.each_pair do |cat, lists| %>
-        <h1><%= cat %></h1>
+  <% if insert_toc %>
+    <hr style="display: none"/>
+    <div id="toc">
+      <h1 id="toc:contents">Contents</h1>
+      <%= toc %>
 
-        <% lists.each do |list| %>
-          <h2 id="<%= list.name.downcase %>"><%= list.name %></h2>
-          <%=
-            list.items.inject('') do |memo, block|
-              memo << "# #{(block.title || block.anchor).inspect}:##{block.anchor}\n"
-            end.redcloth
-          %>
+      <% 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 %>
-    <%= content %>
   </body>
 </html>

data/doc/history.doc

@@ -1,17 +1,17 @@
-h1. Release history
+<doc_proxy_include common.inc>
 
-This is a record of important changes that have occurred with each release.
+<% 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.
 
-h2. Version numbering system
+    * 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.
 
-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 *minor* number increases, functionally _compatible changes_ have occurred. Thus, what worked in the previous version will work in the new one.
 
-* 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 *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 %>
 
-* 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.
-
-
-<%= @history.join "\n\n" %>
+<doc_proxy_include history.inc>