docubot 0.3 → 0.3.2

data/lib/docubot/shells/nvphysx/Appendix/Glossary.md

@@ -0,0 +1,7 @@
+template: glossary
++++
+This page uses the glossary template, which has the smarts to generate HTML
+from the glossary terms defined in the `_glossary` directory.
+
+The Glossary template doesn't actually use the `contents` of this page, so
+it doesn't matter what I put here.

data/lib/docubot/shells/nvphysx/_glossary/APEX.md

@@ -0,0 +1 @@
+A multi-platform, scalable dynamics framework.

data/lib/docubot/shells/nvphysx/_glossary/NVIDIA.md

@@ -0,0 +1 @@
+NVIDIA (Nasdaq: NVDA) is the world leader in visual computing technologies and the inventor of the GPU, a high-performance processor which generates breathtaking, interactive graphics on workstations, personal computers, game consoles, and mobile devices.

data/lib/docubot/shells/nvphysx/_glossary/PhysX.textile

@@ -0,0 +1,3 @@
+note: Due to a bug in the Markdown converter with unicode characters, textile must be used for pages with unicode.
++++
+NVIDIA® PhysX® is a powerful physics engine enabling real-time physics in leading edge PC games. PhysX software is widely adopted by over 150 games and is used by more than 10,000 developers. PhysX is optimized for hardware acceleration by massively parallel processors. GeForce GPUs with PhysX provide an exponential increase in physics processing power taking gaming physics to the next level.

data/lib/docubot/shells/nvphysx/_templates/_root/common.css

@@ -0,0 +1,264 @@
+html, body
+{
+    margin:0;
+    padding:0;
+    font-family:    Verdana, Arial, Helvetica, sans-serif;
+    font-size:      1.1em;
+    font-style:     normal;
+    font-weight:    normal;
+    color:          black;
+}
+body{
+	background:white url(right-sidebar.png) repeat-y top right;
+}
+
+body.nosidebar{
+	background-image:none;
+}
+
+#breadcrumb
+{
+	margin:0;
+	background:black url(nvidia-logo.gif) no-repeat left center;
+	padding-left:56px;
+	font-family: 'Arial', sans-serif;
+	font-size:14px; font-weight:bold;
+	white-space:nowrap;
+	height:40px; line-height:40px; color:white; overflow:hidden;
+	color:#fff;
+}
+
+#breadcrumb a
+{
+	color:#fff; text-decoration:none
+}
+
+#breadcrumb a:hover
+{
+	color:#74b71b
+}
+#breadcrumb .sep
+{
+	color:#999; font-weight:normal; padding:0 0.2em
+}
+
+div#mainbody
+{
+    font-size:90%;
+    margin:   0 350px 0 10px;
+    padding:  0;
+}
+
+body.nosidebar div#mainbody
+{
+	margin-right:0px;
+}
+
+div#mainbody
+{
+	padding-bottom:2em;
+}
+
+div.section
+{
+	margin-left:2em
+}
+
+a:link, a:visited { white-space:nowrap; color:#6e8e34 }
+a:hover { color:#74b71b }
+
+a.hsglossaryreference {
+	color:#000; cursor:help; border-color:#666 ! important
+}
+a.hsglossaryreference:hover { border-color:#74b71b ! important }
+
+ul { margin-left:2em; clear:left }
+
+strong { white-space:nowrap }
+
+h1 {
+	margin:0;
+	padding-left:14px;
+	padding-right:50px;
+	font-family: 'Arial', sans-serif;
+	white-space:nowrap;
+	font-size:18px;
+	background:#6eb103 url(bg_green_bar_revised.gif) repeat-x;
+	height:30px; line-height:30px; color:white; overflow:hidden;
+	border-bottom:1px solid #999
+}
+
+h2
+{
+	clear:both;
+	margin-top:4em;
+}
+h2, h3, h4
+{
+	border-bottom:1px solid #dddddd;
+	font-size:100%;
+	margin-bottom:0.5em;
+}
+h2.first-child, h3.first-child, h4.first-child
+{
+	margin-top:0
+}
+h3, h4
+{
+	margin-top:2em;
+	color:#666;
+}
+
+p, li, fieldset, dl
+{
+	margin:0;
+	padding:0;
+	padding-right:1em;
+	margin-bottom:1em
+}
+
+.TODO
+{
+    font-family: courier new;
+    color: #ff80ff;
+    font-size: 9pt;
+    font-weight: bold
+}
+
+.sidebar
+{
+    text-align: center;
+    width: 350px;
+    font-family: tahoma,sans-serif;
+    float: right;
+    clear: right;
+    color: #665555;
+    margin:0;
+    padding:0;
+    margin-right: -350px;
+    margin-left: 1em;
+    font-size: 7pt;
+    font-weight: bold;
+}
+.sidebar img
+{
+	display:block;
+	margin:0 auto;
+	margin-bottom:0.5em;
+}
+
+img.floatcap
+{
+	float:left;
+	margin-right:1em;
+	margin-bottom:1em;
+	margin-top:2px;
+}
+
+.moreinfo
+{ 
+	font-style:italic;
+	color:#666;
+}
+
+.moreinfo a
+{
+    color: #6e8e34
+}
+.moreinfo a:hover
+{
+    color: #76b900
+}
+
+p.aside
+{
+	margin-left:4em
+}
+
+div#nonscrollingpagefooter
+{
+	background:white;
+	margin-bottom:0;
+	margin-top:4em;
+	clear:both;
+}
+
+div.tryit
+{
+	border:1px solid #76b900;
+	background:#eef6df;
+	margin:2em 50px;
+	padding:0;
+}
+div.tryit h3
+{
+	background:#76b900;
+	color:white;
+	font-style:normal;
+	padding:2px 0.5em;
+	margin:0;
+	margin-bottom:1em
+}
+div.tryit img.preview
+{
+	float:right;
+	width:180px;
+	margin:-1em 0 1em 1em;
+}
+div.tryit ol
+{
+	margin:1em;
+	padding:0;
+}
+div.tryit li
+{
+	margin:0;
+ 	margin-left:3em;
+ 	margin-bottom:1em	
+}
+div.tryit .results
+{
+	font-style:italic;
+	color:#666
+}
+
+sup
+{
+	font-size:85%
+}
+
+#known-issues h3 { font-style:normal; margin-bottom:0.2em; margin-top:3em; margin-right:1em }
+#known-issues h3 span.issue_num { margin-left:1.5em; font-weight:normal; font-size:85%; color:#666; line-height:1.2em; float:right; margin-top:-1.2em; margin-right:1em }
+#known-issues div.description { margin-bottom:2em }
+#known-issues p.workaround { margin-left:2em }
+#known-issues p.workaround strong { color:#666 }
+
+#pagebody
+{
+    font-size:      70%;
+    margin-bottom:  0;
+    margin-top: 1em;
+}
+
+#pagebody h1 {
+	background:#666; color:#ccc; border:1px solid #333; font-size:100%; padding:0.2em 1em; line-height:1em ! important;
+	height:auto ! important; margin-top:1.5em
+}
+
+fieldset { margin-bottom:1.5em; margin-left:1em; padding:0.5em; border-right:none; }
+legend { font-weight:bold; color:#666 }
+fieldset dl { margin:0 2em }
+fieldset p { margin:1em 2em }
+dl.section { margin-left:2em }
+dt { font-weight:bold; font-style:normal; margin-top:0.8em }
+dd { margin-bottom:0.8em }
+
+div#pagefooter {
+	margin-top:10em ! important; margin-bottom:1em ! important; width:25em; overflow:hidden; white-space:nowrap;
+	background:#eee; border:1px solid #ccc; border-left:none; color:#999; font-size:7pt ! important; padding:0.1em 1em
+}
+
+ul.compact li { margin-bottom:0 }
+body.release-notes h3 { margin-left:2em }
+body.release-notes ul { margin-left:4em; margin-top:0; }
+body.release-notes li { margin-bottom:0; margin-top:0; padding:0 ! important; margin-left:1em; line-height:105%; }

data/lib/docubot/shells/nvphysx/_templates/_root/glossary.css

@@ -0,0 +1,4 @@
+#glossary-box   { display:none; position:absolute; width:30%; background:#e0efcc; border:1px solid #82a851; padding:0.5em 0.9em; font-size:9pt; font-family:Calibri, Tahoma; }
+#glossary-close { width:24px; height:24px; background:url(close.png) no-repeat; position:absolute; right:-12px; top:-12px; cursor:pointer; }
+#glossary-box * { margin:0 }
+span.glossary { color:#36401C; border-bottom:1px dashed #6e8e34; cursor:help; }

data/lib/docubot/shells/nvphysx/_templates/_root/glossary.js

@@ -0,0 +1,24 @@
+function glossaryClick(evt){
+	if (!evt) evt=event;
+	var target = evt.target || evt.srcElement;
+	var term = target.getAttribute('term') || target.innerHTML;
+	var box = document.getElementById('glossary-box');
+	box.style.display = 'block';
+	var scroll = (document.documentElement.scrollTop || document.body.scrollTop )*1;
+	box.style.left    = (evt.clientX+5) + 'px';
+	box.style.top     = (evt.clientY+5) + scroll + 'px';
+
+	var html = $glossaryTerms[term.toLowerCase()];
+	document.getElementById('glossary-defn').innerHTML = html;
+}
+
+handleEvent(window,'load',function(){
+	for ( var spans=document.getElementsByTagName('span'),i=spans.length-1; i>=0; --i ){
+		if (cssClass.has(spans[i],'glossary')) handleEvent(spans[i],'click',glossaryClick);
+	}
+	var box = document.getElementById('glossary-box');
+	var close = document.getElementById('glossary-close');
+	handleEvent( close, 'click', function(){
+		box.style.display = 'none';
+	});
+});

data/lib/docubot/shells/nvphysx/_templates/_root/nvdevtools.js

@@ -0,0 +1,31 @@
+function handleEvent(obj,eventName,callback,useCapture){
+	return obj.addEventListener ? obj.addEventListener(eventName,callback,useCapture||false) : obj.attachEvent("on"+eventName,callback);
+}
+
+cssClass = {
+	_killCache : {},
+	_findCache : {},
+	add : function cssClassAdd(obj,className){
+		this.kill(obj,className);
+		obj.className+=(obj.className.length?' ':'')+className;
+	},
+	kill : function cssClassKill(obj,className){
+		var re = this._killCache[className] || (this._killCache[className]=new RegExp('(?:^|\\s+)'+className+'(?:\\s+|$)','g') );
+		obj.className = obj.className.replace(re,'');
+	},
+	has : function cssClassHas(obj,className){
+		var re = this._findCache[className] || (this._findCache[className]=new RegExp('(?:^|\\s+)'+className+'(?:\\s+|$)') );
+		return re.test( obj.className );
+	}
+};
+function isFirstChild(node){
+	return node.parentNode.firstChild==node;
+}
+handleEvent(window,'load',function(){
+	// Add first-child CSS class since :first-child pseudo-class doesn't work for old IE
+	for ( var tags=['h2','h3','p','ul','dl','ol'],i=tags.length-1; i>=0; --i ){
+		for ( var all=document.getElementsByTagName(tags[i]),j=all.length-1; j>=0; --j ){
+			if (isFirstChild(all[j])) cssClass.add(all[j],'first-child');
+		} 
+	}
+});

data/lib/docubot/shells/nvphysx/_templates/top.haml

@@ -0,0 +1,28 @@
+!!! Strict
+%html
+	%head
+		%meta(http-equiv='Content-Type' content='text/html; charset=utf-8')
+		%link{:rel=>'stylesheet', :type=>'text/css', :href=>"#{root}common.css", :media=>'all'}
+		%link{:rel=>'stylesheet', :type=>'text/css', :href=>"#{root}glossary.css", :media=>'all'}
+		%script{:type=>'text/javascript', :src=>"#{root}nvdevtools.js"}
+		%script{:type=>'text/javascript', :src=>"#{root}glossary-terms.js"}
+		%script{:type=>'text/javascript', :src=>"#{root}glossary.js"}
+		%title= page.title
+	%body{ :class=>page.style }
+		#pagetop
+			#breadcrumb
+				- toc = page.ancestors.first # The TOC has no page to link to
+				= toc.short_title || toc.title
+				%span.sep >
+				- page.ancestors[1..-1].each do |dad|
+					%a{ :href=>root/dad.html_path }= dad.short_title || dad.title
+					%span.sep >
+				= page.title
+			%h1#title= page.title
+		#pagebody
+			#glossary-box
+				#glossary-close
+				#glossary-defn
+			#mainbody= contents
+			#pagefooter
+				Copyright ©#{Time.now.year}#{ " #{global.company}" if global.company? }.

data/lib/docubot/shells/nvphysx/index.txt

@@ -0,0 +1,5 @@
+company    : NVIDIA Corporation
+title      : NVIDIA Reference Manual
+short_title: NVIDIA Reference
+default    : Getting Started
++++

data/lib/docubot/snippet.rb

@@ -7,6 +7,7 @@ module DocuBot
 	end
 	
 	def self.process_snippets( page, html )
+		# TODO: Don't process snippets on the 'raw' file types
 		@snippets.inject(html){ |h,(regexp,handler)| h.gsub( regexp ){ |str| handler[ str, page ] } }
 	end
 	

data/lib/docubot/snippets/glossary.rb

@@ -3,5 +3,6 @@ pattern = /\$\$(\w[\w: ]*\w)\$\$/
 DocuBot.handle_snippet pattern do |match, page|
   parts = match[ 2..-3 ].split(':',2)
   text, term = parts.first, parts.last
+	page.bundle.glossary.term_used( term, page )
 	"<span class='glossary' term='#{term}'>#{text}</span>"
 end

data/lib/docubot/templates/_root/glossary.css

@@ -0,0 +1,4 @@
+#glossary-box   { display:none; position:absolute; width:30%; background:#e0efcc; border:1px solid #82a851; padding:0.5em 0.9em; font-size:9pt; font-family:Calibri, Tahoma; }
+#glossary-box * { margin:0 }
+span.glossary { color:#36401C; border-bottom:1px dotted #6e8e34; cursor:help; }
+span.glossary-missing { border-bottom:1px dotted #c00 }

data/lib/docubot/templates/_root/glossary.js

@@ -0,0 +1,58 @@
+function handleEvent(obj,eventName,callback,useCapture){
+	return obj.addEventListener ? obj.addEventListener(eventName,callback,useCapture||false) : obj.attachEvent("on"+eventName,callback);
+}
+
+cssClass = {
+	_killCache : {},
+	_findCache : {},
+	add : function cssClassAdd(obj,className){
+		this.kill(obj,className);
+		obj.className+=(obj.className.length?' ':'')+className;
+	},
+	kill : function cssClassKill(obj,className){
+		var re = this._killCache[className] || (this._killCache[className]=new RegExp('(?:^|\\s+)'+className+'(?:\\s+|$)','g') );
+		obj.className = obj.className.replace(re,'');
+	},
+	has : function cssClassHas(obj,className){
+		var re = this._findCache[className] || (this._findCache[className]=new RegExp('(?:^|\\s+)'+className+'(?:\\s+|$)') );
+		return re.test( obj.className );
+	}
+};
+
+function glossaryClick(evt){
+	if (!evt) evt=event;
+	var target = evt.target || evt.srcElement;
+	var term = target.getAttribute('term') || target.innerHTML;
+	var box = document.getElementById('glossary-box');
+	box.style.display = 'block';
+	var scroll = (document.documentElement.scrollTop || document.body.scrollTop )*1;
+	box.style.left    = (evt.clientX+5) + 'px';
+	box.style.top     = (evt.clientY+5) + scroll + 'px';
+
+	var html = $glossaryTerms[term.toLowerCase()];
+	box.innerHTML = html;
+	
+	evt.cancelBubble = true;
+	if (evt.stopPropogation) evt.stopPropogation();
+	return false;
+}
+
+handleEvent(window,'load',function(){
+	for ( var spans=document.getElementsByTagName('span'),i=spans.length-1; i>=0; --i ){
+		var span = spans[i];
+		if (cssClass.has(span,'glossary')){
+			var term = span.getAttribute('term') || span.innerHTML;
+			if ($glossaryTerms[term.toLowerCase()]){
+				handleEvent(span,'click',glossaryClick);
+			}else{
+				cssClass.kill(span,'glossary');
+				cssClass.add(span,'glossary-missing');
+			}
+			
+		}
+	}
+	var box = document.getElementById('glossary-box');
+	handleEvent( document.body, 'click', function(){
+		box.style.display = 'none';
+	});
+});