yard-slipstream 0.0.0 → 0.1.1

data/README.rdoc

@@ -1,16 +1,49 @@
 = yard-slipstream
 
-Description goes here.
+Small-to-meduim facelift on the default yard template. This yard plugin aims is to make yard documentation as clear and concise as possible. If you ever found yard documents were a bit hard to read, but of a strain. There arent many new features in this template. A few bug fixes.
 
-== Note on Patches/Pull Requests
+So go on, lets give yard a styleover.
+
+== Demo
+
+http://dreamcat4.github.com/plist4r/
+
+== Usage
+
+    gem install yard-slipstream
+
+* Generate your documentation with yard as per the nomal process. For jeweler, then `rake yard`. The plugin is auto-loaded from rubygems. If you use bundler in your project, Bundler wont load this plugin automatically. So it must be added it to your projects `Gemfile`.
+
+* This template is 100% compatible with yard version `0.5.4`. So for the safe road, use with `yard 0.5.4`. Other versions of yard are also known to in variying degrees. (0.5.3, 0.5.5, etc).
+
+* Yard-slipstream doesnt work on yardoc.org. Sorry. For technical reasons its not possible, although there may be future plans to eventually open up yardoc.org. We recommend to generate your docs locally, and push them up to github / gh-pages. Your docs should still do everything that they would on yardoc.org, including Search.
+
+== Improvements
+
+* Blue search box to replace 3 seperate drop-down menus (Files List, Methods List, Class List)
+* The blue Search box is similar as per yardoc.org, but positioned in top-right corner
+* New backend to power the search box (loads onfocus a local json file 'search_index.json')
+* New Frames | No Frames hyperlinks bar. Top right, next to search.
+* '_index.html' renamed to 'object_index.html' to avoid conflicts with jekyll / gh-pages
+* The above fix allows yard docs to be nestable within gh-pages / jekyll website
+* Better scrolling to embedded page links (yard issue-102)
+* Certain object navigation links emphasized (easier to click on / better prominence)
+* More rdoc-like method navigation (via the method ribbons)
+* A couple of sections re-ordered to work better in the new layout
+
+== Whats left the same?
+
+* Same basic fundamental layout. Which was already good to begin with.
+* Well, all of the other best aspects / detail from the original yard template. (We hope!)
+* We havent unintentionally broken anything from yard 0.5.4. We promise.
+
+== Future compatibility / Support
  
-* Fork the project.
-* Make your feature addition or bug fix.
-* Add tests for it. This is important so I don't break it in a
-  future version unintentionally.
-* Commit, do not mess with rakefile, version, or history.
-  (if you want to have your own version, that is fine but bump version in a commit by itself I can ignore when I pull)
-* Send me a pull request. Bonus points for topic branches.
+* The default yard template is a moving target, it changes on pretty much every new patch release.
+* This is a plugin to change the asthetics, and therefore it depends heavily on overriding the default yard template.
+* Some overrides may block future new features of yard becoming visible until the template is updated. This is usually pretty easy to fix. Just a straightforward merge of the new yard code.
+* Send me a pull request. Bonus points for describing what it fixes.
+* Of not, raise me an issue. Thanks.
 
 == Copyright
 

data/Rakefile

@@ -10,6 +10,8 @@ begin
     gem.email = "dreamcat4@gmail.com"
     gem.homepage = "http://github.com/dreamcat4/yard-slipstream"
     gem.authors = ["Dreamcat4"]
+    gem.add_dependency 'yard', ">= 0"
+    gem.add_dependency "json", ">= 0"
     gem.add_development_dependency "rspec", ">= 1.2.9"
     gem.add_development_dependency "yard", ">= 0"
     gem.add_development_dependency "cucumber", ">= 0"

data/VERSION

@@ -1 +1 @@
-0.0.0
+0.1.1

data/lib/yard-slipstream.rb

@@ -3,16 +3,3 @@ $LOAD_PATH.unshift dir unless $LOAD_PATH.include?(dir)
 
 YARD::Templates::Engine.register_template_path dir + '/../templates'
 
-# require 'yard-slipstream/handler' if RUBY19
-# require 'yard-slipstream/legacy'
-
-# todo
-
-# * info box in top right
-# * search form in top right
-
-# rm -rf .yardoc doc ; /Users/id/tmp/yard/bin/yardoc -t "default" -p "/Users/id/tmp/yard/templates"
-
-# rm -rf .yardoc doc ; /Users/id/tmp/yard/bin/yardoc -t "default" -p "/Users/id/tmp/yard/templates" -e "/Users/id/tmp/yard-slipstream/lib/yard-slipstream.rb" lib/yard/templates/template.rb
-
-

data/templates/default/class/html/subclasses.erb

@@ -0,0 +1,10 @@
+<div id="subclasses">
+  <h3 class="inherited">Direct Known Subclasses</h3>
+  <ul id="classes_ribbon">
+  <% n = 1 %>
+  <% @subclasses.each do |name,child| %>
+    <li class="r<%= n %>"><%= linkify(child,name) %></li>
+    <% n = n == 2 ? 1 : 2 %>
+  <% end %>
+  </ul>
+</div>

data/templates/default/fulldoc/html/css/custom.css

@@ -8,6 +8,52 @@
 #header { position: relative; }
 
 
+/*.method_details { border-top: 1px dotted #aaa; margin-top: 15px; padding-top: 0; }*/
+/*.method_details.first { position: relative; top: -15px; margin-bottom: -15px; border-top: transparent solid; }*/
+
+
+/*#info_box { position: relative; float: right; top: 0px; }*/
+#info_box { position: relative; float: left; top: 0px; }
+/*#info_box { margin-top: 15px; margin-bottom: -30px; }*/
+
+#info_box { 
+	  border: 1px solid #aaa;
+	  border-width: 1px 1px 1px 1px;
+}
+
+#info_box a:hover { background: #eef; color: #06b; }
+#info_box a.active { 
+  background: #568; padding-bottom: 20px; color: #fff; border: 1px solid #457; 
+  -moz-border-radius-topleft: 5px; -moz-border-radius-topright: 5px;
+  -webkit-border-top-left-radius: 5px; -webkit-border-top-right-radius: 5px;
+}
+#info_box a.inactive { color: #999; }
+/*.frames #info_box { display: none; }*/
+
+dl.box    { display: inline; }
+dl.box dt { clear: both; }
+dl.box dd { word-wrap: break-word; }
+
+#files_ribbon { padding-left: 15px; font-size: 1.1em; padding: 0; }
+#files_ribbon li { list-style: none; display: inline; padding: 7px 12px; line-height: 35px; }
+
+#methods_ribbon { padding-left: 15px; font-size: 1.1em; }
+#methods_ribbon li { list-style: none; display: inline; padding: 7px 12px; line-height: 35px; }
+
+#classes_ribbon { padding-left: 15px; font-size: 1.1em; }
+#classes_ribbon li { list-style: none; display: inline; padding: 7px 12px; line-height: 35px; }
+
+#modules_ribbon { padding-left: 15px; font-size: 1.1em; }
+#modules_ribbon li { list-style: none; display: inline; padding: 7px 12px; line-height: 35px; }
+
+.method_details.first { position: relative; top: -15px; margin-bottom: -15px; border-top: transparent solid; }
+
+#content { position: relative; }
+
+#header { position: relative; }
+#search { float: right; }
+
+
 form.search {
 /*  position: relative;*/
 	visibility: hidden;
@@ -19,14 +65,36 @@ form.search {
 }
 form.search input { margin-left: 5px; width: 250px; border: 1px solid #99f; -moz-border-radius: 3px; font-family: monospace; }
 
+#menu .noframes { margin-right: 355px; float: right; }
+
+/*#menu  a.link_disabled:link { color: inherit; font-size:20;}*/
+/*#menu  a.link_disabled:visited { color: inherit; font-size:20;}*/
+#menu  a.link_disabled:hover { color: inherit; font-size:20;}
+
+#search2 { float: right; z-index: 1; }
+#search2 { position: absolute; right: 0px; top: 0px; }
+
+div.search2_center {
+	position: relative;
+	text-align: center;
+	width: 350px;
+}
+
 form.search2 {
 /*  position: relative;*/
   color: #000;
-  margin-top: 3px; padding: 7px; border: 1px solid #99f; width: 315px; background: #05a; 
+	margin: 3px;
+	padding: 10px;
+	border: 1px solid #99f; background: #05a;
   -moz-border-radius: 4px; -webkit-border-radius: 4px;
-  margin-bottom: 10px;
 }
-form.search2 input { margin-left: 5px; width: 250px; border: 1px solid #99f; -moz-border-radius: 3px; font-family: monospace; }
+
+form.search2 input {
+	width: 300px;
+	height: 15px;
+	border: 1px solid #99f;
+	-moz-border-radius: 10px;
+}
 
 #menu { padding-top: 5px; }
 #content h1 { margin-top: 0; border-top: 0; }

data/templates/default/fulldoc/html/css/style.css

@@ -3,7 +3,7 @@ body {
   font-family: "Lucida Sans", "Lucida Grande", Verdana, Arial, sans-serif; 
   font-size: 13px;
 }
-body.frames { padding: 0 5px; }
+/*body.frames { padding: 0 5px; }*/
 h1 { font-size: 25px; margin: 1em 0 0.5em; padding-top: 4px; border-top: 1px dotted #d5d5d5; }
 h1.noborder { border-top: 0px; margin-top: 0; padding-top: 4px; }
 h1.title { margin-bottom: 10px; }
@@ -16,6 +16,8 @@ h2 {
   margin: 1.8em 0 0.5em;
 }
 .clear { clear: both; }
+.inline { display: inline; }
+.inline p:first-child { display: inline; }
 .docstring h1, .docstring h2, .docstring h3, .docstring h4 { padding: 0; border: 0; border-bottom: 1px dotted #bbb; }
 .docstring h1 { font-size: 1.2em; }
 .docstring h2 { font-size: 1.1em; }
@@ -52,31 +54,6 @@ p.inherited {
   margin-left: 25px;
 }
 
-
-/*.method_details { border-top: 1px dotted #aaa; margin-top: 15px; padding-top: 0; }*/
-/*.method_details.first { position: relative; top: -15px; margin-bottom: -15px; border-top: transparent solid; }*/
-
-
-#info_box { position: relative; float: left; top: -20px; }
-#info_box { margin-top: 15px; margin-bottom: -30px; }
-
-/*#info_box a:link, #info_box a:visited { 
-  display: block; float: left; margin-right: 4px;
-  padding: 8px 10px; text-decoration: none; color: #05a; background: #eaeaff;
-  border: 1px solid #d8d8e5;
-  -moz-border-radius-bottomleft: 3px; -moz-border-radius-bottomright: 3px; 
-  -webkit-border-bottom-left-radius: 3px; -webkit-border-bottom-right-radius: 3px;
-}
-*//*#info_box a:hover { background: #eef; color: #06b; }
-*//*#info_box a.active { 
-  background: #568; padding-bottom: 20px; color: #fff; border: 1px solid #457; 
-  -moz-border-radius-topleft: 5px; -moz-border-radius-topright: 5px;
-  -webkit-border-top-left-radius: 5px; -webkit-border-top-right-radius: 5px;
-}
-*//*#info_box a.inactive { color: #999; }*/
-/*.frames #info_box { display: none; }*/
-
-
 dl.box {
   width: 520px;
   font-size: 1em;
@@ -88,8 +65,8 @@ dl.box dt {
   margin: 0;
   text-align: right;
   font-weight: bold;
-  border: 1px solid #aaa;
-  border-width: 1px 0px 0px 1px;
+/*  border: 1px solid #aaa;*/
+/*  border-width: 1px 0px 0px 1px;*/
   padding: 6px 0;
   padding-right: 10px;
 }
@@ -100,30 +77,19 @@ dl.box dd {
   margin: 0;
   padding: 6px 0;
   padding-right: 20px;
-  border: 1px solid #aaa;
-  border-width: 1px 1px 0 0;
+/*  border: 1px solid #aaa;*/
+/*  border-width: 1px 1px 0 0;*/
 }
 dl.box .last {
-  border-bottom: 1px solid #aaa;
+/*  border-bottom: 1px solid #aaa;*/
 }
 dl.box .r1 { background: #eee; }
 
-
-
-
 ul.toplevel { list-style: none; padding-left: 0; font-size: 1.1em; }
+/*#files { padding-left: 15px; font-size: 1.1em; }*/
 
-#files_ribbon { padding-left: 15px; font-size: 1.1em; padding: 0; }
-#files_ribbon li { list-style: none; display: inline; padding: 7px 12px; line-height: 35px; }
-
-#methods_ribbon { padding-left: 15px; font-size: 1.1em; }
-#methods_ribbon li { list-style: none; display: inline; padding: 7px 12px; line-height: 35px; }
-
-#classes_ribbon { padding-left: 15px; font-size: 1.1em; }
-#classes_ribbon li { list-style: none; display: inline; padding: 7px 12px; line-height: 35px; }
-
-#modules_ribbon { padding-left: 15px; font-size: 1.1em; }
-#modules_ribbon li { list-style: none; display: inline; padding: 7px 12px; line-height: 35px; }
+/*#files { padding: 0; }*/
+/*#files li { list-style: none; display: inline; padding: 7px 12px; line-height: 35px; }*/
 
 dl.constants { margin-left: 40px; }
 dl.constants dt { font-weight: bold; font-size: 1.1em; margin-bottom: 5px; }
@@ -131,11 +97,12 @@ dl.constants dd { width: 75%; white-space: pre; font-family: monospace; margin-b
 
 .summary_desc { margin-left: 32px; display: block; font-family: sans-serif; }
 .summary_desc tt { font-size: 0.9em; }
-dl.constants .summary_desc { font-size: 0.9em; font-weight: normal; }
+dl.constants .docstring { margin-left: 32px; font-size: 0.9em; font-weight: normal; }
+dl.constants .discussion *:first-child { margin-top: 0; }
+dl.constants .discussion *:last-child { margin-bottom: 0; }
 
 .method_details { border-top: 1px dotted #aaa; margin-top: 15px; padding-top: 0; }
-.method_details.first { position: relative; top: -15px; margin-bottom: -15px; border-top: transparent solid; }
-
+/*.method_details.first { border: 0; }*/
 p.signature { 
   font-size: 1.1em; font-weight: normal; font-family: Monaco, Consolas, Courier, monospace; 
   padding: 6px 10px; margin-top: 18px; 
@@ -172,7 +139,6 @@ p.signature .aliases .names { font-family: Monaco, Consolas, Courier, monospace;
 .showSource { font-size: 0.9em; }
 .showSource a:link, .showSource a:visited { text-decoration: none; color: #666; }
 
-#content { position: relative; }
 #content a:link, #content a:visited { text-decoration: none; color: #05a; }
 #content a:hover { background: #ffffa5; }
 .docstring { margin-right: 6em; }
@@ -212,10 +178,14 @@ ul.fullTree ul { margin-left: 0; padding-left: 0; list-style: none; }
 ul.fullTree li { text-align: center; }
 ul.fullTree li.next:before { font-size: 1.2em; content: '\2B06'; color: #bbb; display: block; margin-top: 3px; }
 
-#header { position: relative; }
 #search { position: absolute; right: 14px; top: 0px; }
-#search { float: right; }
-
+#search a:link, #search a:visited { 
+  display: block; float: left; margin-right: 4px;
+  padding: 8px 10px; text-decoration: none; color: #05a; background: #eaeaff;
+  border: 1px solid #d8d8e5;
+  -moz-border-radius-bottomleft: 3px; -moz-border-radius-bottomright: 3px; 
+  -webkit-border-bottom-left-radius: 3px; -webkit-border-bottom-right-radius: 3px;
+}
 #search a:hover { background: #eef; color: #06b; }
 #search a.active { 
   background: #568; padding-bottom: 20px; color: #fff; border: 1px solid #457; 
@@ -228,10 +198,11 @@ ul.fullTree li.next:before { font-size: 1.2em; content: '\2B06'; color: #bbb; di
 
 #menu { font-size: 1.3em; color: #bbb; top: -5px; position: relative; }
 #menu .title, #menu a { font-size: 0.7em; }
+#menu .title a { font-size: 1em; }
 #menu .title { color: #555; }
 #menu a:link, #menu a:visited { color: #333; text-decoration: none; border-bottom: 1px dotted #bbd; }
 #menu a:hover { color: #05a; }
-#menu .noframes { display: none; }
+/*#menu .noframes { display: none; }*/
 .frames #menu .noframes { display: inline; float: right; }
 
 #footer { margin-top: 15px; border-top: 1px solid #ccc; text-align: center; padding: 7px 0; color: #999; }

data/templates/default/fulldoc/html/js/app.js

@@ -0,0 +1,116 @@
+function createSourceLinks() {
+    $('.method_details_list .source_code').
+        before("<span class='showSource'>[<a href='#' class='toggleSource'>View source</a>]</span>");
+    $('.toggleSource').toggle(function() {
+       $(this).parent().next().slideDown(100);
+       $(this).text("Hide source");
+    },
+    function() {
+        $(this).parent().next().slideUp(100);
+        $(this).text("View source");
+    });
+}
+
+function createDefineLinks() {
+    var tHeight = 0;
+    $('.defines').after(" <a href='#' class='toggleDefines'>more...</a>");
+    $('.toggleDefines').toggle(function() {
+        tHeight = $(this).parent().prev().height();
+        $(this).prev().show();
+        $(this).parent().prev().height($(this).parent().height());
+        $(this).text("(less)");
+    },
+    function() {
+        $(this).prev().hide();
+        $(this).parent().prev().height(tHeight);
+        $(this).text("more...")
+    });
+}
+
+function createFullTreeLinks() {
+    var tHeight = 0;
+    $('.inheritanceTree').toggle(function() {
+        tHeight = $(this).parent().prev().height();
+        $(this).prev().prev().hide();
+        $(this).prev().show();
+        $(this).text("(hide)");
+        $(this).parent().prev().height($(this).parent().height());
+    },
+    function() {
+        $(this).prev().prev().show();
+        $(this).prev().hide();
+        $(this).parent().prev().height(tHeight);
+        $(this).text("show all")
+    });
+}
+
+function fixBoxInfoHeights() {
+    $('dl.box dd.r1, dl.box dd.r2').each(function() {
+       $(this).prev().height($(this).height()); 
+    });
+}
+
+function searchFrameLinks() {
+  $('#method_list_link').click(function() {
+    toggleSearchFrame(this, relpath + 'method_list.html');
+  });
+
+  $('#class_list_link').click(function() {
+    toggleSearchFrame(this, relpath + 'class_list.html');
+  });
+
+  $('#file_list_link').click(function() {
+    toggleSearchFrame(this, relpath + 'file_list.html');
+  });
+}
+
+function toggleSearchFrame(id, link) {
+  var frame = $('#search_frame');
+  $('#search a').removeClass('active').addClass('inactive');
+  if (frame.attr('src') == link && frame.css('display') != "none") {
+    frame.slideUp(100);
+    $('#search a').removeClass('active inactive');
+  }
+  else {
+    $(id).addClass('active').removeClass('inactive');
+    frame.attr('src', link).slideDown(100);
+  }
+}
+
+function linkSummaries() {
+  $('.summary_signature').click(function() {
+    document.location = $(this).find('a').attr('href');
+  });
+}
+
+function framesInit() {
+  if (window.top.frames.main) {
+    document.body.className = 'frames';
+    $('#noframes_link').attr('href', document.location);
+    $('#noframes_link').removeClass('link_disabled');
+  }
+	else {
+    $('#frames_link').attr('href', relpath+"frames.html");
+    $('#frames_link').removeClass('link_disabled');
+	}
+}
+
+function keyboardShortcuts() {
+  $(document).keypress(function(evt) {
+    if (evt.altKey || evt.ctrlKey || evt.metaKey || evt.shiftKey) return;
+    switch (evt.charCode) {
+      case 67: case 99:  $('#class_list_link').click(); break;  // 'c'
+      case 77: case 109: $('#method_list_link').click(); break; // 'm'
+      case 70: case 102: $('#file_list_link').click(); break;   // 'f'
+    }
+  });
+}
+
+$(framesInit);
+$(createSourceLinks);
+$(createDefineLinks);
+$(createFullTreeLinks);
+$(fixBoxInfoHeights);
+$(searchFrameLinks);
+$(linkSummaries);
+$(keyboardShortcuts);