sdoc 0.3.2 → 0.3.3

data/lib/rdoc/generator/template/sdoc/_context.rhtml

@@ -0,0 +1,171 @@
+<div id="content">
+    <% unless (desc = context.description).empty? %>
+    <div class="description">
+        <%= desc %>
+    </div>
+    <% end %>
+
+    <% unless context.requires.empty? %>
+    <div class="sectiontitle">Required Files</div>
+    <ul>
+        <% context.requires.each do |req| %>
+        <li><%= h req.name %></li>
+        <% end %>
+    </ul>
+    <% end %>
+
+    <% sections = context.sections.select { |section| section.title } %>
+    <% unless sections.empty? %>
+    <div class="sectiontitle">Contents</div>
+    <ul>
+        <% sections.each do |section| %>
+        <li><a href="#<%= section.sequence %>"><%= h section.title %></a></li>
+        <% end %>
+    </ul>
+    <% end %>
+
+    <% 
+        list = context.method_list
+        list = list.find_all {|m| m.visibility == :public || m.visibility == :protected || m.force_documentation }
+    %>
+    <% unless list.empty? %>
+    <div class="sectiontitle">Methods</div>
+    <dl class="methods">
+    <% each_letter_group(list) do |group| %>
+        <dt><%= group[:name] %></dt>
+        <dd>
+            <ul>
+                <% group[:methods].each_with_index do |method, i|  %>
+                <li><a href="#<%= method.aref %>"><%= method.name %></a><%= ',' unless group[:methods].size == i+1 %></li>
+                <% end %>
+            </ul>
+        </dd>
+    <% end %>
+    </dl>
+    <% end %>
+
+    <% unless context.includes.empty? %>
+    <div class="sectiontitle">Included Modules</div>
+    <ul>
+        <% context.includes.each do |inc| %>
+        <li>
+            <% unless String === inc.module %>
+            <a href="<%= context.aref_to inc.module.path %>"><%= h inc.module.full_name %></a>
+            <% else %>
+            <span><%= h inc.name %></span>
+            <% end %>
+            START:includes
+        </li>
+        <% end %>
+    </ul>
+    <% end %>
+
+    <% sections.each do |section| %>
+    <div class="sectiontitle"><a name="<%= h section.sequence %>"><%= h section.title %></a></div>
+    <% unless (description = section.description).empty? %>
+    <div class="description">
+        <%= description %>
+    </div>
+    <% end %>
+    <% end %>
+
+    <% unless context.classes_and_modules.empty? %>
+    <div class="sectiontitle">Classes and Modules</div>
+    <ul>
+        <% (context.modules.sort + context.classes.sort).each do |mod| %>
+        <li><span class="type"><%= mod.type.upcase %></span> <a href="<%= context.aref_to mod.path %>"><%= mod.full_name %></a></li>
+        <% end %>
+    </ul>
+    <% end %>
+
+    <% unless context.constants.empty? %>
+    <div class="sectiontitle">Constants</div>
+    <table border='0' cellpadding='5'>
+        <% context.each_constant do |const| %>
+        <tr valign='top'>
+            <td class="attr-name"><%= h const.name %></td>
+            <td>=</td>
+            <td class="attr-value"><%= h const.value %></td>
+        </tr>
+        <% unless (description = const.description).empty? %>
+        <tr valign='top'>
+            <td>&nbsp;</td>
+            <td colspan="2" class="attr-desc"><%= description %></td>
+        </tr>
+        <% end %>
+        <% end %>
+    </table>
+    <% end %>
+
+    <% unless context.attributes.empty? %>
+    <div class="sectiontitle">Attributes</div>
+    <table border='0' cellpadding='5'>
+        <% context.each_attribute do |attrib| %>
+        <tr valign='top'>
+            <td class='attr-rw'>
+                [<%= attrib.rw %>]
+            </td>
+            <td class='attr-name'><%= h attrib.name %></td>
+            <td class='attr-desc'><%= attrib.description.strip %></td>
+        </tr>
+        <% end %>
+    </table>
+    <% end %>
+
+    <% context.methods_by_type.each do |type, visibilities|
+        next if visibilities.empty?
+        visibilities.each do |visibility, methods|
+            next if methods.empty? 
+            next unless visibility == :public || visibility == :protected || methods.any? {|m| m.force_documentation }
+            %>
+            <div class="sectiontitle"><%= type.capitalize %> <%= visibility.to_s.capitalize %> methods</div>
+            <% methods.each do |method| %>
+            <div class="method">
+                <div class="title" id="<%= method.aref %>">
+                    <% if method.call_seq %>
+                    <a name="<%= method.aref %>"></a><b><%= method.call_seq.gsub(/->/, '&rarr;') %></b>
+                    <% else %>
+                    <a name="<%= method.aref %>"></a><b><%= h method.name %></b><%= h method.params %>
+                    <% end %>
+                </div>
+                <% unless (description = method.description).empty? %>
+                <div class="description">
+                  <%= description %>
+                </div>
+                <% end %>
+                <% unless method.aliases.empty? %>
+                <div class="aka">
+                    This method is also aliased as
+                    <% method.aliases.each do |aka| %>
+                    <a href="<%= context.aref_to aka.path %>"><%= h aka.name %></a>
+                    <% end %>
+                </div>
+                <% end %>
+                <% if method.token_stream %>
+                <% markup = method.markup_code %>
+                <div class="sourcecode">
+                    <p class="source-link">
+                        Source: <a href="javascript:toggleSource('<%= method.aref %>_source')" id="l_<%= method.aref %>_source">show</a>
+                        <% 
+                            if options.github
+                            if markup =~ /File\s(\S+), line (\d+)/
+                                path = $1
+                                line = $2.to_i
+                            end
+                            github = github_url(path)
+                            if github
+                        %>
+                        | <a href="<%= "#{github}#L#{line}" %>" target="_blank" class="github_url">on GitHub</a>
+                        <% end end %>
+                    </p>
+                    <div id="<%= method.aref %>_source" class="dyn-source x">
+                        <pre><%= method.markup_code %></pre>
+                    </div>
+                </div>
+                <% end %>
+            </div>
+            <%      end
+        end
+    end
+    %>
+</div>

data/lib/rdoc/generator/template/sdoc/_head.rhtml

@@ -0,0 +1,7 @@
+<link rel="stylesheet" href="<%= "#{rel_prefix}/css/reset.css" %>" type="text/css" media="screen" />
+<link rel="stylesheet" href="<%= "#{rel_prefix}/css/main.css" %>" type="text/css" media="screen" />
+<link rel="stylesheet" href="<%= "#{rel_prefix}/css/github.css" %>" type="text/css" media="screen" />
+<script src="<%= "#{rel_prefix}/js/jquery-1.3.2.min.js" %>" type="text/javascript" charset="utf-8"></script>
+<script src="<%= "#{rel_prefix}/js/jquery-effect.js" %>" type="text/javascript" charset="utf-8"></script>
+<script src="<%= "#{rel_prefix}/js/main.js" %>" type="text/javascript" charset="utf-8"></script>
+<script src="<%= "#{rel_prefix}/js/highlight.pack.js" %>" type="text/javascript" charset="utf-8"></script>

data/lib/rdoc/generator/template/sdoc/class.rhtml

@@ -0,0 +1,39 @@
+<?xml version="1.0" encoding="utf-8"?>
+<!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>
+    <title><%= h klass.full_name %></title>
+    <meta http-equiv="Content-Type" content="text/html; charset=<%= @options.charset %>" />
+    <%= include_template '_head.rhtml', {:rel_prefix => rel_prefix} %>
+</head>
+
+<body>     
+    <div class="banner">
+        <% if ENV['HORO_PROJECT_NAME'] %>
+            <span><%= ERB::Util.html_escape(ENV['HORO_PROJECT_NAME']) %> <%= ERB::Util.html_escape(ENV['HORO_PROJECT_VERSION']) %></span><br />
+        <% end %>
+        <h1>
+            <span class="type"><%= klass.module? ? 'Module' : 'Class' %></span> 
+            <%= h klass.full_name %> 
+            <% if klass.type == 'class' %>
+                <span class="parent">&lt; 
+                    <% if String === klass.superclass %>
+                    <%= klass.superclass %>
+                    <% elsif !klass.superclass.nil? %>
+                    <a href="<%= klass.aref_to klass.superclass.path %>"><%= h klass.superclass.full_name %></a>
+                    <% end %>
+                </span>
+            <% end %>
+        </h1>
+        <ul class="files">
+            <% klass.in_files.each do |file| %>
+            <li><a href="<%= "#{rel_prefix}/#{h file.path}" %>"><%= h file.absolute_name %></a></li>
+            <% end  %>
+        </ul>
+    </div>
+    <div id="bodyContent">
+        <%= include_template '_context.rhtml', {:context => klass, :rel_prefix => rel_prefix} %>
+    </div>
+  </body>
+</html>    

data/lib/rdoc/generator/template/sdoc/file.rhtml

@@ -0,0 +1,29 @@
+<?xml version="1.0" encoding="utf-8"?>
+<!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>
+    <title><%= h file.name %></title>
+    <meta http-equiv="Content-Type" content="text/html; charset=<%= @options.charset %>" />
+    <%= include_template '_head.rhtml', {:rel_prefix => rel_prefix} %>
+</head>
+
+<body>     
+    <div class="banner">
+        <% if ENV['HORO_PROJECT_NAME'] %>
+            <span><%= ERB::Util.html_escape(ENV['HORO_PROJECT_NAME']) %> <%= ERB::Util.html_escape(ENV['HORO_PROJECT_VERSION']) %></span><br />
+        <% end %>
+        <h1>
+            <%= h file.name %>
+        </h1>
+        <ul class="files">
+            <li><%= h file.relative_name %></li>
+            <li>Last modified: <%= file.file_stat.mtime %></li>
+        </ul>
+    </div>
+
+    <div id="bodyContent">
+        <%= include_template '_context.rhtml', {:context => file, :rel_prefix => rel_prefix} %>
+    </div>
+  </body>
+</html>

data/lib/rdoc/generator/template/sdoc/index.rhtml

@@ -0,0 +1,13 @@
+<!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=<%= @options.charset %>" />
+    <title><%= @options.title %></title>
+</head>
+<frameset cols="300,*" frameborder="1" border="1" bordercolor="#666666" framespacing="1">
+    <frame src="panel/index.html" title="Search" name="panel" />
+    <frame src="<%= index_path %>" name="docwin" />
+</frameset>
+</html>

data/lib/rdoc/generator/template/sdoc/resources/css/github.css

@@ -0,0 +1,129 @@
+/*
+
+github.com style (c) Vasily Polovnyov <vast@whiteants.net>
+
+*/
+
+pre code {
+  display: block; padding: 0.5em;
+  color: #000;
+  background: #f8f8ff
+}
+
+pre .comment,
+pre .template_comment,
+pre .diff .header,
+pre .javadoc {
+  color: #998;
+  font-style: italic
+}
+
+pre .keyword,
+pre .css .rule .keyword,
+pre .winutils,
+pre .javascript .title,
+pre .lisp .title,
+pre .subst {
+  color: #000;
+  font-weight: bold
+}
+
+pre .number,
+pre .hexcolor {
+  color: #40a070
+}
+
+pre .string,
+pre .tag .value,
+pre .phpdoc,
+pre .tex .formula {
+  color: #d14
+}
+
+pre .title,
+pre .id {
+  color: #900;
+  font-weight: bold
+}
+
+pre .javascript .title,
+pre .lisp .title,
+pre .subst {
+  font-weight: normal
+}
+
+pre .class .title,
+pre .haskell .label,
+pre .tex .command {
+  color: #458;
+  font-weight: bold
+}
+
+pre .tag,
+pre .tag .title,
+pre .rules .property,
+pre .django .tag .keyword {
+  color: #000080;
+  font-weight: normal
+}
+
+pre .attribute,
+pre .variable,
+pre .instancevar,
+pre .lisp .body {
+  color: #008080
+}
+
+pre .regexp {
+  color: #009926
+}
+
+pre .class {
+  color: #458;
+  font-weight: bold
+}
+
+pre .symbol,
+pre .ruby .symbol .string,
+pre .ruby .symbol .keyword,
+pre .ruby .symbol .keymethods,
+pre .lisp .keyword,
+pre .tex .special,
+pre .input_number {
+  color: #990073
+}
+
+pre .builtin,
+pre .built_in,
+pre .lisp .title {
+  color: #0086b3
+}
+
+pre .preprocessor,
+pre .pi,
+pre .doctype,
+pre .shebang,
+pre .cdata {
+  color: #999;
+  font-weight: bold
+}
+
+pre .deletion {
+  background: #fdd
+}
+
+pre .addition {
+  background: #dfd
+}
+
+pre .diff .change {
+  background: #0086b3
+}
+
+pre .chunk {
+  color: #aaa
+}
+
+pre .tex .formula {
+  opacity: 0.5;
+}

data/lib/rdoc/generator/template/sdoc/resources/css/reset.css

@@ -0,0 +1,53 @@
+/* http://meyerweb.com/eric/tools/css/reset/ */
+/* v1.0 | 20080212 */
+
+html, body, div, span, applet, object, iframe,
+h1, h2, h3, h4, h5, h6, p, blockquote, pre,
+a, abbr, acronym, address, big, cite, code,
+del, dfn, em, font, img, ins, kbd, q, s, samp,
+small, strike, strong, sub, sup, tt, var,
+b, u, i, center,
+dl, dt, dd, ol, ul, li,
+fieldset, form, label, legend,
+table, caption, tbody, tfoot, thead, tr, th, td {
+	margin: 0;
+	padding: 0;
+	border: 0;
+	outline: 0;
+	font-size: 100%;
+	vertical-align: baseline;
+	background: transparent;
+}
+body {
+	line-height: 1;
+}
+ol, ul {
+	list-style: none;
+}
+blockquote, q {
+	quotes: none;
+}
+blockquote:before, blockquote:after,
+q:before, q:after {
+	content: '';
+	content: none;
+}
+
+/* remember to define focus styles! */
+:focus {
+	outline: 0;
+}
+
+/* remember to highlight inserts somehow! */
+ins {
+	text-decoration: none;
+}
+del {
+	text-decoration: line-through;
+}
+
+/* tables still need 'cellspacing="0"' in the markup */
+table {
+	border-collapse: collapse;
+	border-spacing: 0;
+}