docubot 0.6.1 → 0.6.2

data/lib/docubot/snippets/glossary.rb

@@ -1,8 +1,8 @@
-# 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
-	page.bundle.glossary.term_used( term, page )
-	"<span class='glossary' term='#{term}'>#{text}</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
+	page.bundle.glossary.term_used( term, page )
+	"<span class='glossary' term='#{term}'>#{text}</span>"
 end

data/lib/docubot/snippets/index_entries.rb

@@ -1,7 +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
+# 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/glossary.css

@@ -1,4 +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; }
+#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

@@ -1,58 +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';
-	});
+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';
+	});
 });

data/lib/docubot/templates/index.haml

@@ -1,14 +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
-
+-# 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/toc.haml

@@ -1,3 +1,3 @@
-%ul#toc
-	- li_pages_for global.toc
+%ul#toc
+	- li_pages_for global.toc
 			

data/lib/docubot/templates/top.haml

@@ -1,32 +1,32 @@
-!!! 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'}
-		- if custom_css
-			%link{:rel=>'stylesheet', :type=>'text/css', :href=>"#{root}#{custom_css}", :media=>'all'}
-		%script{:type=>'text/javascript', :src=>"#{root}glossary-terms.js"}
-		%script{:type=>'text/javascript', :src=>"#{root}glossary.js"}
-		- if custom_js
-			%script{:type=>'text/javascript', :src=>"#{root}#{custom_js}"}
-		%title= page.title
-	%body{ :class=>page.style }
-		#content
-			#pagetop
-				#breadcrumb
-					= global.short_title || global.title
-					%span.sep >
-					- breadcrumb.each do |node|
-						%a{ :href=>root/node.link }= node.page.short_title || node.title
-						%span.sep >
-					= page.title
-				%h1#title= page.title
-				- if page.author
-					#author= page.author
-			#pagebody
-				#glossary-box
-				#mainbody= contents
-				#pagefooter
-					Copyright ©#{Time.now.year}#{ " #{global.company}" if global.company }.
-					All Rights Reserved.
+!!! 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'}
+		- if custom_css
+			%link{:rel=>'stylesheet', :type=>'text/css', :href=>"#{root}#{custom_css}", :media=>'all'}
+		%script{:type=>'text/javascript', :src=>"#{root}glossary-terms.js"}
+		%script{:type=>'text/javascript', :src=>"#{root}glossary.js"}
+		- if custom_js
+			%script{:type=>'text/javascript', :src=>"#{root}#{custom_js}"}
+		%title= page.title
+	%body{ :class=>page.style }
+		#content
+			#pagetop
+				#breadcrumb
+					= global.short_title || global.title
+					%span.sep >
+					- breadcrumb.each do |node|
+						%a{ :href=>root/node.link }= node.page.short_title || node.title
+						%span.sep >
+					= page.title
+				%h1#title= page.title
+				- if page.author
+					#author= page.author
+			#pagebody
+				#glossary-box
+				#mainbody= contents
+				#pagefooter
+					Copyright ©#{Time.now.year}#{ " #{global.company}" if global.company }.
+					All Rights Reserved.

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

@@ -38,7 +38,7 @@ ICON = {
 		%>
 		<LI> <OBJECT type="text/sitemap">
 			<param name="Name" value="<%=CGI.escapeHTML child.title%>">
-			<param name="Local" value="<%=FileUtils.win_path( @html_path / child.link ).gsub('&','%26')%>">
+			<param name="Local" value="<%=FileUtils.win_path( @html_path / child.link ).gsub('&','&amp;')%>">
 			<param name="ImageNumber" value="<%=icon%>">
 			</OBJECT>
 		<%@write_section[child] unless child.children.empty?%>

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

@@ -11,14 +11,14 @@
 <%@global.index.each do |entry,pages|%>
    <LI> <OBJECT type="text/sitemap">
 	   <param name="Name" value="<%=entry%>">
-	   <param name="Local" value="<%=FileUtils.win_path( @html_path/pages.first.html_path )%>">
+	   <param name="Local" value="<%=FileUtils.win_path( @html_path/pages.first.html_path.gsub('&','&amp;') )%>">
 	   </OBJECT>
 	<%unless pages.length==1%>
 	<UL>
 		<%pages.each do |page|%>
    <LI> <OBJECT type="text/sitemap">
 	   <param name="Name" value="<%=page.title%>">
-	   <param name="Local" value="<%=FileUtils.win_path( @html_path/page.html_path )%>">
+	   <param name="Local" value="<%=FileUtils.win_path( @html_path/page.html_path.gsub('&','&amp;') )%>">
 	   </OBJECT>
 		<%end%>	   
 	</UL>

data/lib/docubot/writers/html.rb

@@ -1,88 +1,88 @@
-class DocuBot::HTMLWriter < DocuBot::Writer
-	handles_type :html
-	
-	# Specify nil for destination to place "<source>_html" next to the source.
-	def write( destination=nil )
-		start = Time.now
-		
-		source = @bundle.source
-		@html_path = destination || File.dirname(source)/"#{File.basename source}_html"
-		FileUtils.rm_rf(@html_path) if File.exists?(@html_path)
-		FileUtils.mkdir(@html_path)
-		
-		master_templates = DocuBot::TEMPLATE_DIR
-		source_templates = source/'_templates'
-		master_root = master_templates/'_root'
-		source_root = source_templates/'_root'
-		
-		# Copy any files found in the source directory that weren't made into pages
-		@bundle.extras.each do |file|
-			FileUtils.mkdir_p( @html_path / File.dirname( file ) )
-			FileUtils.cp( source / file, @html_path / file )
-		end
-		
-		# Copy files from template to root of destination
-		# Record these as extras so that the CHMWriter can access them
-		Dir.chdir @html_path do
-			existing_files = Dir[ '*' ]
-			FileUtils.copy( Dir[ master_templates/'_root'/'*' ], '.' )
-			FileUtils.copy( Dir[ source_templates/'_root'/'*' ], '.' )
-			new_files = Dir[ '*' ] - existing_files
-			@bundle.extras.concat( new_files )
-		end
-		
-		Dir.chdir @html_path do
-			o = Object.new
-			
-			# Write out every page
-			top = File.exists?( source_templates/'top.haml' ) ? source_templates/'top.haml' : master_templates/'top.haml'
-			top = Haml::Engine.new( IO.read( top ), HAML_OPTIONS )
-			@bundle.toc.descendants.each do |node|
-				next if node.anchor
-				
-				contents = node.page.to_html
-				template = node.page.template # Call page.to_html first to ensure page.template is set
-
-				custom_js = "#{template}.js"
-				custom_js = nil unless File.exists?( source_root/custom_js ) || File.exists?( master_root/custom_js )
-				
-				custom_css = "#{template}.css"
-				custom_css = nil unless File.exists?( source_root/custom_css ) || File.exists?( master_root/custom_css )
-				
-				variables = {
-					:page       => node.page,
-					:contents   => contents,
-					:global     => @bundle.global,
-					:root       => node.page.root,
-					:breadcrumb => node.ancestors,
-					:custom_js  => custom_js,
-					:custom_css => custom_css
-				}				
-				html = top.render( o, variables )
-				FileUtils.mkdir_p( File.dirname( node.file ) )
-				File.open( node.file, 'w' ){ |f| f << html }
-			end
-
-			File.open( 'glossary-terms.js', 'w' ){ |f| f << @bundle.glossary.to_js }
-		end
-		
-		puts "...%.2fs to write the HTML" % (Time.now - start)
-	end
-end
-
-module Haml::Helpers
-	def li_pages_for( node )
-		node.children.each do |child|
-			haml_tag :li, :class=>(child.anchor ? 'sublink' : child.children.empty? ? 'section' : 'page' ) do
-				haml_tag :a, :href=>child.link do
-					haml_concat child.title
-				end
-				unless child.children.empty?
-					haml_tag :ul do
-						li_pages_for child
-					end
-				end
-			end
-		end
-	end
+class DocuBot::HTMLWriter < DocuBot::Writer
+	handles_type :html
+	
+	# Specify nil for destination to place "<source>_html" next to the source.
+	def write( destination=nil )
+		start = Time.now
+		
+		source = @bundle.source
+		@html_path = destination || File.dirname(source)/"#{File.basename source}_html"
+		FileUtils.rm_rf(@html_path) if File.exists?(@html_path)
+		FileUtils.mkdir(@html_path)
+		
+		master_templates = DocuBot::TEMPLATE_DIR
+		source_templates = source/'_templates'
+		master_root = master_templates/'_root'
+		source_root = source_templates/'_root'
+		
+		# Copy any files found in the source directory that weren't made into pages
+		@bundle.extras.each do |file|
+			FileUtils.mkdir_p( @html_path / File.dirname( file ) )
+			FileUtils.cp( source / file, @html_path / file )
+		end
+		
+		# Copy files from template to root of destination
+		# Record these as extras so that the CHMWriter can access them
+		Dir.chdir @html_path do
+			existing_files = Dir[ '*' ]
+			FileUtils.copy( Dir[ master_templates/'_root'/'*' ], '.' )
+			FileUtils.copy( Dir[ source_templates/'_root'/'*' ], '.' )
+			new_files = Dir[ '*' ] - existing_files
+			@bundle.extras.concat( new_files )
+		end
+		
+		Dir.chdir @html_path do
+			o = Object.new
+			
+			# Write out every page
+			top = File.exists?( source_templates/'top.haml' ) ? source_templates/'top.haml' : master_templates/'top.haml'
+			top = Haml::Engine.new( IO.read( top ), HAML_OPTIONS )
+			@bundle.toc.descendants.each do |node|
+				next if node.anchor
+				
+				contents = node.page.to_html
+				template = node.page.template # Call page.to_html first to ensure page.template is set
+
+				custom_js = "#{template}.js"
+				custom_js = nil unless File.exists?( source_root/custom_js ) || File.exists?( master_root/custom_js )
+				
+				custom_css = "#{template}.css"
+				custom_css = nil unless File.exists?( source_root/custom_css ) || File.exists?( master_root/custom_css )
+				
+				variables = {
+					:page       => node.page,
+					:contents   => contents,
+					:global     => @bundle.global,
+					:root       => node.page.root,
+					:breadcrumb => node.ancestors,
+					:custom_js  => custom_js,
+					:custom_css => custom_css
+				}				
+				html = top.render( o, variables )
+				FileUtils.mkdir_p( File.dirname( node.file ) )
+				File.open( node.file, 'w' ){ |f| f << html }
+			end
+
+			File.open( 'glossary-terms.js', 'w' ){ |f| f << @bundle.glossary.to_js }
+		end
+		
+		puts "...%.2fs to write the HTML" % (Time.now - start)
+	end
+end
+
+module Haml::Helpers
+	def li_pages_for( node )
+		node.children.each do |child|
+			haml_tag :li, :class=>(child.anchor ? 'sublink' : child.children.empty? ? 'section' : 'page' ) do
+				haml_tag :a, :href=>child.link do
+					haml_concat child.title
+				end
+				unless child.children.empty?
+					haml_tag :ul do
+						li_pages_for child
+					end
+				end
+			end
+		end
+	end
 end