docubot 0.0.1 → 0.2

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

@@ -1,3 +1,4 @@
+# encoding: UTF-8
 module DocuBot
 	@snippets = {}
 	
@@ -5,11 +6,11 @@ module DocuBot
 		@snippets[ regexp ] = handler
 	end
 	
-	def self.process_snippets( html )
-		@snippets.inject(html){ |html,regexp,handler| html.gsub( regexp, &handler ) }
+	def self.process_snippets( page, html )
+		@snippets.inject(html){ |h,(regexp,handler)| h.gsub( regexp ){ |str| handler[ str, page ] } }
 	end
 	
-	Dir[ File.join( DocuBot::DIR, 'docubot/snippets/*.rb' ) ].each do |snippet|
+	Dir[ DocuBot::DIR/'docubot/snippets/*.rb' ].each do |snippet|
 		require snippet
 	end
 	

data/lib/docubot/snippets/glossary.rb

@@ -1,4 +1,7 @@
-DocuBot.handle_snippet /\$\$(\w[\w ]*\w)\$\$/ do
-	# TODO: look up glossary terms
-	"<span class='glossary'>#{$1}</span>"
+# encoding: UTF-8
+pattern = /\$\$(\w[\w: ]*\w)\$\$/
+DocuBot.handle_snippet pattern do |match, page|
+  parts = match[ 2..-3 ].split(':',2)
+  text, term = parts.first, parts.last
+	"<span class='glossary' term='#{term}'>#{text}</span>"
 end

data/lib/docubot/snippets/index_entries.rb

@@ -0,0 +1,7 @@
+# encoding: UTF-8
+pattern = /@@(\w[\w ]*?)@@/
+DocuBot.handle_snippet pattern do |match, page|
+	keyword = match[ 2..-3 ]
+	page.bundle.index.add( keyword, page )
+	keyword
+end

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

@@ -0,0 +1,107 @@
+html, body
+{
+    margin:0;
+    padding:0;
+    background:white;
+}
+
+#breadcrumb
+{
+	margin:0;
+	background:black;
+	padding-left:1em;
+	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
+{
+	padding-right:0 ! important; padding-bottom:2em;
+}
+
+div.section
+{
+	margin-left:2em
+}
+
+a:link, a:visited { white-space:nowrap; color:#6e8e34 }
+a:hover { color:#74b71b }
+
+h1 {
+	margin:0;
+	padding-left:14px;
+	padding-right:50px;
+	font-family: 'Arial', sans-serif;
+	white-space:nowrap;
+	font-size:18px;
+	background:#6eb103 url(images/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%
+}
+h2.first-child, h3.first-child, h4.first-child
+{
+	margin-top:0
+}
+h3, h4
+{
+	margin-top:2em;
+	font-style:italic
+}
+
+.moreinfo
+{ 
+	font-style:italic;
+	color:#666;
+}
+
+.moreinfo a
+{
+    color: #6e8e34
+}
+.moreinfo a:hover
+{
+    color: #76b900
+}
+
+sup
+{
+	font-size:85%
+}
+#pagebody { margin:1em 2em }
+#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
+}
+
+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
+}

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

@@ -0,0 +1,5 @@
+/*
+This file is only used for the HTML version of the TOC.
+If you are generating CHMs only, you may delete it.
+*/
+  

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

@@ -0,0 +1,4 @@
+/*
+This file is only used for the HTML version of the TOC.
+If you are generating CHMs only, you may delete it.
+*/

data/lib/docubot/templates/glossary.haml

@@ -0,0 +1,5 @@
+-# TODO: Breakdown by letter.
+%dl#glossary
+	- global.glossary.each do |term,defn|
+		%dt= term
+		%dd= defn

data/lib/docubot/templates/index.haml

@@ -0,0 +1,14 @@
+-# TODO: Breakdown by letter.
+%ul#index
+	- global.index.entries.sort_by{ |k,p| k.downcase }.each do |keyword,pages|
+		- if pages.length == 1
+			%li
+				%a{ :href => pages.first.html_path }= keyword
+		- else
+			%li
+				= keyword
+				%ul
+					- pages.each do |page|
+						%li
+							%a{ :href => page.html_path }= page.title
+

data/lib/docubot/templates/page.haml

@@ -0,0 +1 @@
+= contents

data/lib/docubot/templates/section.haml

@@ -0,0 +1,10 @@
+%p The following pages are part of <em>#{page.title}</em>:
+%ul#children
+	- page.pages.each do |child_page|
+		%li #{child_page.title}#{": #{child_page.summary}" if child_page.summary?}			
+- if contents
+	%p
+		%strong
+			Before you go in, you should probably know the following:
+	#good-info= contents
+	

data/lib/docubot/templates/toc.haml

@@ -0,0 +1,10 @@
+!!! Strict
+%html
+	%head
+		%title= global.title
+		%link{:rel=>'stylesheet', :type=>'text/css', :href=>"#{root}toc.css", :media=>'all'}
+		%script{:type=>'text/javascript', :src=>"#{root}toc.js"}
+	%body
+		%ul#toc
+			- li_pages_for global
+			

data/lib/docubot/templates/top.haml

@@ -0,0 +1,25 @@
+!!! 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'}
+		%title= page.title
+	%body{ :class=>page.style }
+		#content
+			#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
+				- if page.author?
+					#author= page.author
+			#pagebody
+				#mainbody= contents
+				#pagefooter
+					Copyright ©#{Time.now.year}#{ " #{global.company}" if global.company? }.
+					All Rights Reserved.

data/lib/docubot/writer.rb

@@ -0,0 +1,24 @@
+# encoding: UTF-8
+class DocuBot::Writer
+	HAML_OPTIONS = { :format=>:html4, :ugly=>true }
+	HAML_OPTIONS.merge!( :encoding=>'utf-8' ) if Object.const_defined? "Encoding"
+
+	@@by_type = {}
+	def self.handles_type( type )
+		@@by_type[type.to_s.downcase] = self
+	end
+	def self.by_type
+		@@by_type
+	end
+	DIR = File.expand_path( DocuBot::DIR / 'docubot/writers' )
+
+	def initialize( bundle )
+		@bundle = bundle
+	end	
+end
+
+Dir[ DocuBot::Writer::DIR/'*.rb' ].each do |writer|
+	require writer
+end
+
+DocuBot::Writer::INSTALLED_WRITERS = DocuBot::Writer.by_type.keys

data/lib/docubot/writers/chm.rb

@@ -0,0 +1,73 @@
+require DocuBot::Writer::DIR / 'html'
+require 'cgi'
+require 'erb'
+class DocuBot::CHMWriter < DocuBot::HTMLWriter
+	handles_type :chm
+	
+	SUPPORT = DocuBot::Writer::DIR / 'chm'
+	
+	def write( destination=nil )
+		super( nil )
+		@chm_path = destination || "#{@bundle.source}.chm"
+		@toc = @bundle.toc
+		write_hhc
+		write_hhk
+		write_hhp
+		# This will fail if a handle is open to it on Windows
+		begin
+			FileUtils.rm( @chm_path ) if File.exists?( @chm_path )
+		rescue Errno::EACCES
+			require 'win32ole'
+			for process in WIN32OLE.connect("winmgmts://").ExecQuery("select Name,CommandLine from win32_process where Name='hh.exe'") do
+				process.Terminate if process.CommandLine.include? @chm_path.gsub('/','\\')
+			end
+		end
+		# TODO: output timing and progress results
+		`hhc.exe "#{FileUtils.win_path @hhp}"`.gsub( /[\r\n]+/, "\n" )
+		
+		# Clean out the intermediary files
+		FileUtils.rm( [ @hhc, @hhp, @hhk ] )
+		FileUtils.rm_r( @html_path )
+		
+		# Spin a new thread so it doesn't hold up the Ruby process, but sleep long enough for it to get going.
+		Thread.new{ `hh.exe "#{FileUtils.win_path @chm_path}"` }
+		sleep 0.1
+	end
+
+	def write_hhc
+		@hhc = @chm_path.sub( /[^.]+$/, 'hhc' )
+		File.open( @hhc, 'w' ) do |f|
+			f << ERB.new( IO.read( SUPPORT / 'hhc.erb' ) ).result( binding )
+		end
+	end
+
+	def write_hhp
+		@hhp = @chm_path.sub( /[^.]+$/, 'hhp' )
+
+		if @toc.default?
+			# User tried to specify the default page
+			@default_topic = @toc.descendants.find{ |page| page.title==@toc.default }
+			if @default_topic
+				if @default_topic.file =~ /\s/
+					warn "'#{@toc.default}' cannot be the default CHM page; it has a space in the file name."
+					@default_topic = nil
+				end
+			else
+				warn "The requested default page '#{@toc.default}' could not be found. (Did the title change?)"
+			end
+		end
+		@default_topic ||= @toc.descendants.find{ |page| page.file =~ /^\S+$/ }
+		warn "No default page is set, because no page has a file name without spaces." unless @default_topic
+
+		File.open( @hhp, 'w' ) do |f|
+			f << ERB.new( IO.read( SUPPORT / 'hhp.erb' ) ).result( binding )
+		end
+	end
+
+	def write_hhk
+		@hhk = @chm_path.sub( /[^.]+$/, 'hhk' )
+		File.open( @hhk, 'w' ) do |f|
+			f << ERB.new( IO.read( SUPPORT / 'hhk.erb' ) ).result( binding )
+		end
+	end
+end

data/lib/docubot/writers/chm/hhc.erb

@@ -0,0 +1,27 @@
+<!DOCTYPE HTML PUBLIC "-//IETF//DTD HTML//EN">
+<HTML>
+<HEAD>
+<meta name="GENERATOR" content="Microsoft&reg; HTML Help Workshop 4.1">
+<!-- Sitemap 1.0 -->
+<%@write_section = lambda do |page| %>
+<UL>
+	<%page.pages.each do |child|%>
+		<%next if child.hide%>
+		<LI> <OBJECT type="text/sitemap">
+			<param name="Name" value="<%=CGI.escapeHTML child.title%>">
+			<param name="Local" value="<%=FileUtils.win_path( @html_path / child.html_path ).gsub('&','%26')%>">
+			<%if child.sublink?
+				%><param name="ImageNumber" value="17"><%
+			elsif child.leaf?
+				%><param name="ImageNumber" value="11"><%
+			end%>
+			</OBJECT>
+		<%@write_section[child] unless child.pages.empty?%>
+	<%end%>
+</UL>
+<%end%>
+</HEAD><BODY>
+
+<%@write_section[@bundle.toc]%>
+
+</BODY></HTML>