rdoc-generator-fivefish 0.0.1.pre.52 → 0.0.1.pre.56

data/ChangeLog

@@ -1,16 +1,36 @@
+2012-05-21  Michael Granger  <ged@FaerieMUD.org>
+
+	* README.rdoc, assets/js/fivefish.js, assets/js/jquery.hotkeys.js:
+	Add search hotkey shortcut
+	[8331c3a93b42] [tip]
+
+	* assets/css/fivefish.css:
+	Make section H3s stand out
+	[e969a0f6925c]
+
+	* assets/css/fivefish.css:
+	Fixed bottom margin for method aliases in class view
+	[f5dc93c8a5cc]
+
+2012-05-10  Michael Granger  <ged@FaerieMUD.org>
+
+	* .rvm.gems, Manifest.txt, Rakefile:
+	Bump Inversion dependency to 0.10.
+	[070425e539a0]
+
 2012-05-07  Michael Granger  <ged@FaerieMUD.org>
 
 	* data/rdoc-generator-fivefish/templates/class.tmpl, data/rdoc-
 	generator-fivefish/templates/index.tmpl,
 	lib/rdoc/generator/fivefish.rb:
 	Uniqueify classes and methods in the index lists.
-	[b1409e3dd6d0] [tip]
+	[b1409e3dd6d0]
 
 2012-05-06  Michael Granger  <ged@FaerieMUD.org>
 
 	* assets/css/fivefish.css:
 	Color section headers
-	[58ecea31b86f] [github/master]
+	[58ecea31b86f]
 
 2012-05-05  Michael Granger  <ged@FaerieMUD.org>
 
@@ -198,7 +218,7 @@
 
 	* .rvm.gems, Rakefile:
 	Updating to Inversion 0.8
-	[0974c250f677] [github/master@default]
+	[0974c250f677]
 
 2012-03-31  Michael Granger  <ged@FaerieMUD.org>
 

data/README.rdoc

@@ -7,13 +7,9 @@
 
 A(nother) HTML(5) generator for RDoc.
 
-The goals for this one:
-
-* Update Darkfish's semantic structure for HTML5
-* Clean up the layout with a 960 grid
-* Devote more real estate to docs rather than the index
-* Demonstrate themability of RDoc in general via the --stylesheet option
-* Make the output validate again.
+It uses Twitter Bootstrap for the pretty, doesn't take up valuable horizontal real
+estate space with indexes and stuff, and has Quicksilver[http://qsapp.com/]-like
+search built in.
 
 
 == Installation

data/data/rdoc-generator-fivefish/css/fivefish.min.css

@@ -92,6 +92,14 @@ div.container > header.hero-unit h1 {
 	text-shadow: 1px 1px 3px rgba( 25,25,25, 0.2 );
 }
 
+h3 {
+	font-size: 1.75em;
+	padding: 0.5em;
+	background-color: #c9c9c9;
+	border-radius: 5px;
+}
+
+
 /* Indexes */
 section#indexes {
 	max-height: 460px;
@@ -178,8 +186,8 @@ section.protected-methods div.method header i {
 
 section.methods a[name] {
 	position: relative;
-	top: -35px;
-	display: none;
+	top: -135px;
+	visibility: hidden;
 }
 
 
@@ -209,8 +217,10 @@ section.attributes-list dt {
 div.method header span.method-args {
 	color: #666;
 }
-div.method div.method-description p {
+div.method div.method-description p,
+div.aliases {
 	color: #666;
+	margin-bottom: 0.75em;
 }
 
 

data/data/rdoc-generator-fivefish/js/fivefish.min.js

@@ -62,4 +62,4 @@ String.prototype.score=function(a,b){if(this==a)return 1;if(a=="")return 0;var c
  * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  *
 */
-function initFivefish(){console.debug("Loaded. Waiting for DOM to be ready."),$(document).ready(onReady)}function hookTooltips(){$("header.hero-unit h1").popover({placement:"right"})}function hookSourceToggles(){$("div.method header i").click(function(a){var b=a.target,c=$(b).parents("div").get(0),d=$(c).find("div.method-source-code");console.debug("Toggling: %o",d),d.fadeToggle()})}function makeRankingTerm(a){return a.name.replace(/.*::/,"").toLowerCase()}function matchIndexItem(a){var b=this.query,c=makeRankingTerm(a),d=c.score(b,RankFuzziness);return d>=MatchThreshold?!0:!1}function sortIndexItems(a){var b=this.query;return a.sort(function(a,c){var d=makeRankingTerm(a),e=makeRankingTerm(c),f=d.score(b,RankFuzziness),g=e.score(b,RankFuzziness);return f>g?-1:f<g?1:0})}function pickItemIcon(a){var b;switch(a.type){case"anymethod":case"metamethod":b="plus-sign";break;case"normalmodule":b="gift";break;case"normalclass":b="briefcase";break;case"toplevel":b="file";break;default:b="question-sign"}return b}function highlightMatchingItem(a){var b=a.snippet.replace(/<\/?p>/g,"").replace(/\.(.|\n)*/,"."),c=pickItemIcon(a),d=makeRankingTerm(a),e=d.score(this.query,RankFuzziness),f='<span class="search-item"><i class="icon-'+c+'"></i>'+'<span class="search-item-name">'+a.name+"</span>"+'<span class="search-item-rank">'+(e*10).toFixed()+"</span>"+"<br />"+'<span class="search-item-snippet">'+b+"</span>"+"</span>",g=$(f);return g.data("searchitem",a),g}function updateSearchInput(a){var b=this.$menu.find(".active .search-item").data("searchitem");return $("#navbar-search-target").val(b.link),b.name}function hookSearchForm(){$(".navbar-search .search-query").typeahead({source:SearchIndex,matcher:matchIndexItem,sorter:sortIndexItems,updater:updateSearchInput,highlighter:highlightMatchingItem}).change(function(){var a=$("link[rel=prefix]").attr("href"),b=$("#navbar-search-target").val();window.location.assign(a+"/"+b)})}function onReady(){console.debug("Ready!"),hookTooltips(),hookSourceToggles(),hookSearchForm()}const MatchThreshold=.5,RankFuzziness=.5;
+function initFivefish(){console.debug("Loaded. Waiting for DOM to be ready."),$(document).ready(onReady)}function hookTooltips(){$("header.hero-unit h1").popover({placement:"right"})}function hookSourceToggles(){$("div.method header i").click(function(a){var b=a.target,c=$(b).parents("div").get(0),d=$(c).find("div.method-source-code");console.debug("Toggling: %o",d),d.fadeToggle()})}function makeRankingTerm(a){return a.name.replace(/.*::/,"").toLowerCase()}function matchIndexItem(a){var b=this.query,c=makeRankingTerm(a),d=c.score(b,RankFuzziness);return d>=MatchThreshold?!0:!1}function sortIndexItems(a){var b=this.query;return a.sort(function(a,c){var d=makeRankingTerm(a),e=makeRankingTerm(c),f=d.score(b,RankFuzziness),g=e.score(b,RankFuzziness);return f>g?-1:f<g?1:0})}function pickItemIcon(a){var b;switch(a.type){case"anymethod":case"metamethod":b="plus-sign";break;case"normalmodule":b="gift";break;case"normalclass":b="briefcase";break;case"toplevel":b="file";break;default:b="question-sign"}return b}function highlightMatchingItem(a){var b=a.snippet.replace(/<\/?p>/g,"").replace(/\.(.|\n)*/,"."),c=pickItemIcon(a),d=makeRankingTerm(a),e=d.score(this.query,RankFuzziness),f='<span class="search-item"><i class="icon-'+c+'"></i>'+'<span class="search-item-name">'+a.name+"</span>"+'<span class="search-item-rank">'+(e*10).toFixed()+"</span>"+"<br />"+'<span class="search-item-snippet">'+b+"</span>"+"</span>",g=$(f);return g.data("searchitem",a),g}function updateSearchInput(a){var b=this.$menu.find(".active .search-item").data("searchitem");return $("#navbar-search-target").val(b.link),b.name}function hookSearchForm(){$(".navbar-search .search-query").typeahead({source:SearchIndex,matcher:matchIndexItem,sorter:sortIndexItems,updater:updateSearchInput,highlighter:highlightMatchingItem}).change(function(){var a=$("link[rel=prefix]").attr("href"),b=$("#navbar-search-target").val();window.location.assign(a+"/"+b)})}function onSearchKey(a){$("input.search-query").focus()}function onReady(){console.debug("Ready!"),hookTooltips(),hookSourceToggles(),hookSearchForm(),$(document).bind("keydown","ctrl+/",onSearchKey)}const MatchThreshold=.5,RankFuzziness=.5;

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: rdoc-generator-fivefish
 version: !ruby/object:Gem::Version
-  version: 0.0.1.pre.52
+  version: 0.0.1.pre.56
   prerelease: 
 platform: ruby
 authors:
@@ -36,7 +36,7 @@ cert_chain:
   YUhDS0xaZFNLai9SSHVUT3QrZ2JsUmV4OEZBaDhOZUEKY21saFhlNDZwWk5K
   Z1dLYnhaYWg4NWpJang5NWhSOHZPSStOQU01aUg5a09xSzEzRHJ4YWNUS1Bo
   cWo1UGp3RgotLS0tLUVORCBDRVJUSUZJQ0FURS0tLS0tCg==
-date: 2012-05-11 00:00:00.000000000 Z
+date: 2012-05-30 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: inversion
@@ -169,18 +169,11 @@ dependencies:
 description: ! 'A(nother) HTML(5) generator for RDoc.
 
 
-  The goals for this one:
+  It uses Twitter Bootstrap for the pretty, doesn''t take up valuable horizontal real
 
+  estate space with indexes and stuff, and has Quicksilver[http://qsapp.com/]-like
 
-  * Update Darkfish''s semantic structure for HTML5
-
-  * Clean up the layout with a 960 grid
-
-  * Devote more real estate to docs rather than the index
-
-  * Demonstrate themability of RDoc in general via the --stylesheet option
-
-  * Make the output validate again.'
+  search built in.'
 email:
 - ged@FaerieMUD.org
 executables: []