RubyGems - erlapi - Versions diffs - 0.1.9 - Mend

erlapi 0.1.9

Files changed (100) hide show

data/lib/erlapi/generator/template/direct/resources/panel/index.html ADDED

@@ -0,0 +1,71 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.1//EN"
+	"http://www.w3.org/TR/xhtml11/DTD/xhtml11.dtd">
+<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en">
+<head>
+	<title>layout</title>
+	<link rel="stylesheet" href="../css/reset.css" type="text/css" media="screen" charset="utf-8" />
+	<link rel="stylesheet" href="../css/panel.css" type="text/css" media="screen" charset="utf-8" />
+	<script src="search_index.js" type="text/javascript" charset="utf-8"></script>
+	<script src="tree.js" type="text/javascript" charset="utf-8"></script>
+	<script src="../js/jquery-1.3.2.min.js" type="text/javascript" charset="utf-8"></script>
+	<script src="../js/searchdoc.js" type="text/javascript" charset="utf-8"></script>
+	<script type="text/javascript" charset="utf-8">
+		//<![CDATA[
+	    function placeholder() {
+ 	       if (jQuery.browser.safari) return;
+ 	       $('#search-label').click(function() {
+ 	           $('#search').focus();
+ 	           $('#search-label').hide();
+ 	       });
+ 	       $('#search').focus(function() {
+ 	           $('#search-label').hide();
+            });
+ 	       $('#search').blur(function() {
+ 	           this.value == '' && $('#search-label').show()
+ 	       });
+ 	       $('#search')[0].value == '' && $('#search-label').show();
+	    }
+	   $(function() {
+           placeholder();
+           var panel = new Searchdoc.Panel($('#panel'), search_data, tree, top.frames[1]);
+           $('#search').focus();
+           var s = window.parent.location.search.match(/\?q=([^&]+)/);
+           if (s) {
+               s = decodeURIComponent(s[1]).replace(/\+/g, ' ');
+               if (s.length > 0)
+               {
+                   $('#search').val(s);
+                   panel.search(s, true);
+               }
+           }
+	   })
+		//]]>
+	</script>
+</head>
+<body>
+    <div class="panel panel_tree" id="panel">
+        <div class="header">
+            <div>
+                <label for="search" id="search-label" style="display: none">Search</label>
+                <table>
+                <tr><td>
+                    <input type="Search" placeholder="Search" autosave="searchdoc" results="10" id="search" autocomplete="off"/>
+                </td></tr>
+            </table></div>
+        </div>
+        <div class="tree">
+            <ul>
+            </ul>
+        </div>
+        <div class="result">
+            <ul>
+            </ul>
+        </div>
+    </div>
+</body>
+</html>

data/lib/erlapi/generator/template/merge/index.rhtml ADDED

@@ -0,0 +1,14 @@
+<!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=utf-8"/>
+	<title><%= @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/erlapi/generator/template/shtml/_context.rhtml ADDED

@@ -0,0 +1,164 @@
+<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
+        unless @options.show_all
+            list = list.find_all {|m| m.visibility == :public || m.visibility == :protected || m.force_documentation }
+        end
+    %>
+    <% unless list.empty? %>
+    <div class="sectiontitle">Methods</div>
+    <ul>
+        <% list.sort{ |a, b| a.name <=> b.name }.each do |method| %>
+        <li><a href="#<%= method.aref %>"><%= method.name %></a></li>
+        <% end %>
+    </ul>
+    <% 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 @options.show_all || 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">
+                    <% 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">
+                  <%# TODO delete this dirty hack when documentation for example for JavaScriptHelper will not be cutted off by <script> tag %>
+                  <%= description.gsub('<script>'){ |m| h(m) } %>
+                </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 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 %>
+                    </p>
+                    <div id="<%= method.aref %>_source" class="dyn-source">
+                        <pre><%= method.markup_code %></pre>
+                    </div>
+                </div>
+                <% end %>
+            </div>
+            <%      end
+        end
+    end
+    %>
+</div>

data/lib/erlapi/generator/template/shtml/class.rhtml ADDED

@@ -0,0 +1,46 @@
+<?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 %>" />
+    <link rel="stylesheet" href="<%= "#{rel_prefix}/css/main.css" %>" type="text/css" media="screen" />
+    <script src="<%= "#{rel_prefix}/js/main.js" %>" type="text/javascript" charset="utf-8"></script>
+</head>
+<body>
+    <table width="100%" border='0' cellpadding='0' cellspacing='0' class='banner'>
+        <tr>
+            <td class="file-title"><span class="file-title-prefix"><%= klass.module? ? 'Module' : 'Class' %></span><br /><%= h klass.full_name %></td>
+            <td align="right">
+                <table cellspacing="0" cellpadding="2">
+                    <tr valign="top">
+                        <td>In:</td>
+                        <td>
+                            <% klass.in_files.each do |file| %>
+                            <a href="<%= "#{rel_prefix}/#{h file.path}" %>"><%= h file.absolute_name %></a>
+                            <% end  %>
+                        </td>
+                    </tr>
+                    <% if klass.type == 'class' %>
+                    <tr>
+                        <td>Parent:</td>
+                        <td>
+                            <% 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 %>
+                        </td>
+                    </tr>
+                    <% end %>
+                </table>
+            </td>
+        </tr>
+    </table>
+    <div id="bodyContent">
+        <%= include_template '_context.rhtml', {:context => klass, :rel_prefix => rel_prefix} %>
+    </div>
+  </body>
+</html>

data/lib/erlapi/generator/template/shtml/file.rhtml ADDED

@@ -0,0 +1,37 @@
+<?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 %>" />
+    <link rel="stylesheet" href="<%= "#{rel_prefix}/css/main.css" %>" type="text/css" media="screen" />
+    <script src="<%= "#{rel_prefix}/js/main.js" %>" type="text/javascript" charset="utf-8"></script>
+</head>
+<body>
+    <table border='0' cellpadding='0' cellspacing='0' width="100%" class='banner'>
+      <tr><td>
+        <table width="100%" border='0' cellpadding='0' cellspacing='0'><tr>
+          <td class="file-title" colspan="2"><span class="file-title-prefix">File</span><br /><%= h file.name %></td>
+          <td align="right">
+            <table border='0' cellspacing="0" cellpadding="2">
+              <tr>
+                <td>Path:</td>
+                <td><%= h file.relative_name %></td>
+              </tr>
+              <tr>
+                <td>Modified:</td>
+                <td><%= file.file_stat.mtime %></td>
+              </tr>
+            </table>
+          </td></tr>
+        </table>
+      </td></tr>
+    </table><br />
+    <div id="bodyContent">
+        <%= include_template '_context.rhtml', {:context => file, :rel_prefix => rel_prefix} %>
+    </div>
+  </body>
+</html>

data/lib/erlapi/generator/template/shtml/index.rhtml ADDED

@@ -0,0 +1,14 @@
+<!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/erlapi/generator/template/shtml/resources/apple-touch-icon.png ADDED

Binary file

data/lib/erlapi/generator/template/shtml/resources/css/main.css ADDED

@@ -0,0 +1,191 @@
+a {
+  color: #00F;
+  text-decoration: none;
+}
+a:hover {
+  color: #77F;
+  text-decoration: underline;
+}
+body, td, p {
+  font-family: "Bitstream Vera Sans", Verdana, Arial, Helvetica, sans-serif;
+  background: #FFF;
+  color: #000;
+  margin: 0px;
+  font-size: small;
+}
+p {
+  margin-top: 0.5em;
+  margin-bottom: 0.5em;
+}
+#content {
+  margin: 2em;
+  margin-left: 3.5em;
+  margin-right: 3.5em;
+}
+#description p {
+  margin-bottom: 0.5em;
+}
+.sectiontitle {
+  margin-top: 1em;
+  margin-bottom: 1em;
+  padding: 0.5em;
+  padding-left: 2em;
+  background: #005;
+  color: #FFF;
+  font-weight: bold;
+}
+.attr-rw {
+  padding-left: 1em;
+  padding-right: 1em;
+  text-align: center;
+  color: #055;
+}
+.attr-name {
+  font-weight: bold;
+}
+.attr-desc {
+}
+.attr-desc p {
+    margin-top: 0;
+}
+.attr-value {
+  font-family: monospace;
+}
+.file-title-prefix {
+  font-size: large;
+}
+.file-title {
+  font-size: large;
+  font-weight: bold;
+  background: #005;
+  color: #FFF;
+}
+.banner {
+  background: #005;
+  color: #FFF;
+  border: 1px solid black;
+  padding: 1em;
+}
+.banner td {
+  background: transparent;
+  color: #FFF;
+}
+h1 a, h2 a, .sectiontitle a, .banner a {
+  color: #FF0;
+}
+h1 a:hover, h2 a:hover, .sectiontitle a:hover, .banner a:hover {
+  color: #FF7;
+}
+.dyn-source {
+  display: none;
+  background: #fffde8;
+  color: #000;
+  border: #ffe0bb dotted 1px;
+  margin: 0.5em 2em 0.5em 2em;
+  padding: 0.5em;
+}
+.dyn-source .cmt {
+  color: #00F;
+  font-style: italic;
+}
+.dyn-source .kw {
+  color: #070;
+  font-weight: bold;
+}
+.method {
+  margin-left: 1em;
+  margin-right: 1em;
+  margin-bottom: 1em;
+}
+.description pre {
+  padding: 0.5em;
+  border: #ffe0bb dotted 1px;
+  background: #fffde8;
+}
+.method .title {
+  font-family: monospace;
+  font-size: large;
+  border-bottom: 1px dashed black;
+  margin-bottom: 0.3em;
+  padding-bottom: 0.1em;
+}
+.method .description, .method .sourcecode {
+  margin-left: 1em;
+}
+.description p, .sourcecode p {
+  margin-bottom: 0.5em;
+}
+.method .sourcecode p.source-link {
+  text-indent: 0em;
+  margin-top: 0.5em;
+}
+.method .aka {
+  margin-top: 0.3em;
+  margin-left: 1em;
+  font-style: italic;
+  text-indent: 2em;
+}
+h1 {
+  padding: 1em;
+  margin-left: -1.5em;
+  font-size: x-large;
+  font-weight: bold;
+  color: #FFF;
+  background: #007;
+}
+h2 {
+  padding: 0.5em 1em 0.5em 1em;
+  margin-left: -1.5em;
+  font-size: large;
+  font-weight: bold;
+  color: #FFF;
+  background: #009;
+}
+h3, h4, h5, h6 {
+  color: #220088;
+  border-bottom: #5522bb solid 1px;
+}
+.sourcecode > pre {
+  padding: 0.5em;
+  border: 1px dotted black;
+  background: #FFE;
+}
+dt {
+  font-weight: bold
+}
+dd {
+  margin-bottom: 0.7em;
+}