docubot 0.3.3 → 0.4

data/lib/docubot/page.rb

@@ -3,18 +3,14 @@ require 'yaml'
 require 'nokogiri'
 
 class DocuBot::Page
-	META_SEPARATOR = /^\+\+\+\s*$/ # Sort of like +++ATH0
 	AUTO_ID_ELEMENTS = %w[ h1 h2 h3 h4 h5 h6 legend caption dt ].join(',')
 
-	attr_reader :pages, :type, :folder, :file, :meta, :nokodoc, :bundle
-	attr_accessor :parent
+	attr_reader :type, :folder, :file, :meta, :nokodoc, :bundle
 
 	def initialize( bundle, source_path, title=nil )
 		puts "#{self.class}.new( #{source_path.inspect}, #{title.inspect}, #{type.inspect} )" if $DEBUG
 		title ||= File.basename( source_path ).sub( /\.[^.]+$/, '' ).gsub( '_', ' ' ).sub( /^\d+\s/, '' )
 		@bundle = bundle
-		@meta  = { 'title'=>title }
-		@pages = []
 		@file  = source_path
 		if File.directory?( @file )
 			@folder = @file
@@ -23,26 +19,14 @@ class DocuBot::Page
 		else
 			@folder = File.dirname( @file )
 		end
-		slurp_file_contents if @file
+		@type = File.extname( @file )[ 1..-1 ] if @file
+		@meta = DocuBot::MetaSection.new( {'title'=>title}, @file )
+		@raw  = @meta.__contents__
+		@raw = nil if @raw && @raw.empty?
+
 		create_nokodoc
 	end
 	
-	def slurp_file_contents
-		@type = File.extname( @file )[ 1..-1 ]
-		parts = IO.read( @file ).split( META_SEPARATOR, 2 )
-		
-		if parts.length > 1
-			# Make YAML friendler to n00bs
-			yaml = YAML.load( parts.first.gsub( /^\t/, '  ' ) )
-			@meta.merge!( yaml )
-		end
-		
-		# Raw markup, untransformed, needs content
-		if @raw = parts.last && parts.last.strip
-			@raw = nil if @raw.empty?
-		end
-	end
-	
 	def create_nokodoc
 		# Directories with no index.* file will not have any @raw
 		# Pages with metasection only will also not have any @raw
@@ -50,7 +34,7 @@ class DocuBot::Page
 			html = DocuBot::process_snippets( self, @raw )
 			html = DocuBot::convert_to_html( self, html, @type )
 		end
-		@nokodoc = Nokogiri::HTML(html || "")
+		@nokodoc = Nokogiri::HTML::DocumentFragment.parse(html || "")
 		auto_id
 		auto_section
 		@nokodoc
@@ -63,10 +47,11 @@ class DocuBot::Page
 	# Add IDs to elements that don't have them
 	def auto_id
 		# ...but only if a toc entry might reference one, or requested.
-		if (@meta['auto-id']==true) || (@meta['toc'] && @meta['toc'][','])
+		if @meta['auto-id'].as_boolean || @meta.toc.as_list.any?{ |toc| !toc['#'] }
 			@nokodoc.css( AUTO_ID_ELEMENTS ).each do |node|
 				next if node.has_attribute?('id')
-				node['id'] = DocuBot.id_from_text(node.inner_text)
+				# Strip off the unwanted leading '#'
+				node['id'] = DocuBot.id_from_text(node.inner_text)[1..-1]
 			end
 			dirty_doc
 		end
@@ -75,11 +60,10 @@ class DocuBot::Page
 	# Wrap siblings of headers in <div class='section'>
 	def auto_section
 		return if @meta['auto-section']==false
-		return unless body = @nokodoc.at_css('body')
 		
 		#TODO: Make this a generic nokogiri call on any node (like body) where you can pass in a hierarchy of elements and a wrapper
 		stack = []
-		body.children.each do |node|
+		@nokodoc.children.each do |node|
 			# non-matching nodes will get level of 0
 			level = node.name[ /h([1-6])/i, 1 ].to_i
 			level = 99 if level == 0
@@ -105,53 +89,14 @@ class DocuBot::Page
 		case key[-1..-1] # the last character of the method name
 			when '?' then @meta.has_key?( key[0..-2] )
 			when '!','=' then super
-			else @meta[ key ]
+			else
+				# warn "Unknown attribute #{key.inspect} asked for on #{@file || @folder}" unless @meta.has_key?( key )
+				@meta[ key ]
 		end
 	end
-	def ancestors
-		page = self
-		anc = []
-		anc.unshift( page ) while page = page.parent
-		anc
-	end	
-	def sections
-		@pages.reject{ |e| e.pages.empty? }
-	end
-	def leafs
-		@pages.select{ |e| e.pages.empty? }
-	end
-	def every_leaf
-		(leafs + sub_sections.map{ |sub| sub.every_leaf }).flatten
-	end
-	
-	def every_section
-		(sub_sections + sub_sections.map{ |sub| sub.every_section }).flatten
-	end
-	
-	def descendants
-		(@pages + @pages.map{ |page| page.descendants }).flatten
-	end
-	alias_method :every_page, :descendants
-	
-	def <<( entry )
-		@pages << entry
-		entry.parent = self
-	end
-	
-	def leaf?
-		@pages.empty? || @pages.all?{ |x| x.is_a?(DocuBot::SubLink) }
-	end
-	
-	def depth
-		@_depth ||= self==@bundle.toc ? 0 : @file ? @file.count('/') : @folder.count('/') + 1
-	end
-	
-	def root
-		@_root ||= "../" * depth
-	end
 	
 	def html_path
-		@file ? @file.sub( /[^.]+$/, 'html' ) : ( @folder / 'index.html' )
+		@html_path ||= @file ? @file.sub( /[^.]+$/, 'html' ) : ( @folder / 'index.html' )
 	end
 	
 	# Call this if the source generated by the converter would change
@@ -173,64 +118,41 @@ class DocuBot::Page
 	end
 	
 	def content_html
-		# Nokogiri 'helpfully' wraps our content in a full HTML page
-		# but apparently doesn't create a body for no content.
-		@content_html ||= (body=nokodoc.at_css('body')) && body.children.to_html
+		@content_html ||= nokodoc.to_html
+	end
+	
+	def children
+		@bundle.toc.children(html_path).map{ |node| node.page }.uniq.compact
+	end
+	
+	def leaf?
+		@leaf ||= !children.any?{ |page| page != self }
+	end
+	
+	def depth
+		@depth ||= html_path.scan('/').length
+	end
+	
+	def root
+		@root ||= "../" * depth
 	end
 
+	#TODO: cache this is people keep calling to_html and it's a problem
 	def to_html
-		#TODO: cache this is people keep calling to_html and it's a problem
-		@meta['template'] ||= leaf? ? 'page' : 'section'
+		@meta.template ||= leaf? ? 'page' : 'section'
 
 		master_templates = DocuBot::TEMPLATE_DIR
 		source_templates = @bundle.source / '_templates'
-		
 		tmpl = source_templates / "#{template}.haml"
 		tmpl = master_templates / "#{template}.haml" unless File.exists?( tmpl )
 		tmpl = master_templates / "page.haml"        unless File.exists?( tmpl )
-		haml = Haml::Engine.new( IO.read( tmpl ), DocuBot::Writer::HAML_OPTIONS )
-		haml.render( Object.new, :contents=>content_html, :page=>self, :global=>@bundle.toc, :root=>root )
+		tmpl = IO.read( tmpl )
+		haml = Haml::Engine.new( tmpl, DocuBot::Writer::HAML_OPTIONS )
+		haml.render( Object.new, :contents=>content_html, :page=>self, :global=>@bundle.global, :root=>root )
 	end
 	
-end
-
-class DocuBot::SubLink
-	attr_reader :page, :title, :id
-	def initialize( page, title, id )
-		@page, @title, @id = page, title, id
-	end
-	def html_path
-		"#{@page.html_path}##{@id}"
-	end
-	def leaf?
-		true
-	end
-	def pages
-		[]
-	end
-	alias_method :descendants, :pages
-	def depth
-		@page.depth
-	end
-	def parent
-		@page
-	end
-	def parent=( page )
-		@page = page
-	end
-	def to_html
-		""
-	end
-	def ancestors
-		@page.ancestors
-	end
-	def method_missing(*args)
-		nil
-	end
-	def hide
-		false
-	end
-	def sublink?
-		true
+	def inspect
+		"<#{self.class} '#{self.title}' #{@file ? "@file=#{@file.inspect}" : "@folder=#{@folder.inspect}"}>"
 	end
+	
 end

data/lib/docubot/shells/docubot-help/3_Advanced_Topics/Controlling the Table of Contents.md

@@ -1,7 +1,5 @@
-toc: #bones-and-groups #rigid-body-type #physical-mesh
+toc: #bones-and-groups, #rigid-body-type, #physical-mesh
 +++
-* Use `toc: hide` to remove a page from the table of contents.
-* Use `toc: #list #of-html #identifiers` to add specific elements on the page,
+* Use `toc: #list, #of-html, #identifiers` to add specific elements on the page,
   referenced by HTML id, as sub-section links in the table of contents.
   The contents of the HTML tag with that id will be used as the index header.
-* TODO: Use `icon: <somename>` to specify a specific CHM icon in the TOC.

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

@@ -44,9 +44,10 @@ body.nosidebar{
 
 div#mainbody
 {
-    font-size:90%;
+    font-size:8pt;
     margin:   0 350px 0 10px;
     padding:  0;
+  	padding-bottom:30em;
 }
 
 body.nosidebar div#mainbody
@@ -61,7 +62,7 @@ div#mainbody
 
 div.section
 {
-	margin-left:2em
+	margin-left:1em
 }
 
 a:link, a:visited { white-space:nowrap; color:#6e8e34 }
@@ -238,6 +239,7 @@ sup
     font-size:      70%;
     margin-bottom:  0;
     margin-top: 1em;
+    padding-bottom:10em;
 }
 
 #pagebody h1 {
@@ -247,11 +249,14 @@ sup
 
 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 dl { margin:0 1em }
 fieldset p { margin:1em 2em }
-dl.section { margin-left:2em }
+dl.section { margin-left:1em }
 dt { font-weight:bold; font-style:normal; margin-top:0.8em }
-dd { margin-bottom:0.8em }
+dd { margin-bottom:0.8em; margin-left:0; }
+dd p { margin-bottom:0.4em }
+dd ul { margin-left:3em; margin-top:0.4em; }
+dd ul li { margin-bottom:0 }
 
 div#pagefooter {
 	margin-top:10em ! important; margin-bottom:1em ! important; width:25em; overflow:hidden; white-space:nowrap;

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

@@ -2,3 +2,4 @@
 #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; }
+span.glossary-missing { border-bottom:1px dotted #900 }

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

@@ -14,7 +14,17 @@ function glossaryClick(evt){
 
 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 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');
 	var close = document.getElementById('glossary-close');

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

@@ -0,0 +1,9 @@
+%p The following pages are part of <em>#{page.title}</em>:
+%ul#children
+	- page.pages.each do |child_page|
+		%li
+			%a{ :href=>root/child_page.html_path }= child_page.title
+			- if child_page.summary?
+				= ": #{child_page.summary}"
+- unless contents.nil? or contents.empty?
+	#good-info= contents

data/lib/docubot/templates/index.haml

@@ -1,21 +1,14 @@
-!!! Strict
-%html
-	%head
-		%meta(http-equiv='Content-Type' content='text/html; charset=utf-8')
-		%title= global.title + " Index"
-		%link{:rel=>'stylesheet', :type=>'text/css', :href=>"#{root}common.css", :media=>'all'}
-	%body
-		-# 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/section.haml

@@ -1,10 +1,7 @@
 %p The following pages are part of <em>#{page.title}</em>:
 %ul#children
-	- page.pages.each do |child_page|
+	- page.children.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

@@ -1,12 +1,3 @@
-!!! Strict
-%html
-	%head
-		%meta(http-equiv='Content-Type' content='text/html; charset=utf-8')
-		%title= global.title
-		%link{:rel=>'stylesheet', :type=>'text/css', :href=>"#{root}common.css", :media=>'all'}
-		%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
+%ul#toc
+	- li_pages_for global.toc
 			

data/lib/docubot/templates/top.haml

@@ -4,18 +4,21 @@
 		%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
-					- toc = page.ancestors.first # The TOC has no page to link to
-					= toc.short_title || toc.title
+					= global.short_title || global.title
 					%span.sep >
-					- page.ancestors[1..-1].each do |dad|
-						%a{ :href=>root/dad.html_path }= dad.short_title || dad.title
+					- breadcrumb.each do |node|
+						%a{ :href=>root/node.link }= node.page.short_title || node.title
 						%span.sep >
 					= page.title
 				%h1#title= page.title

data/lib/docubot/writers/chm.rb

@@ -11,6 +11,7 @@ class DocuBot::CHMWriter < DocuBot::HTMLWriter
 		lap = Time.now
 		@chm_path = destination || "#{@bundle.source}.chm"
 		@toc = @bundle.toc
+		@global = @bundle.global
 		write_hhc
 		write_hhk
 		write_hhp
@@ -63,20 +64,20 @@ class DocuBot::CHMWriter < DocuBot::HTMLWriter
 	def write_hhp
 		@hhp = @chm_path.sub( /[^.]+$/, 'hhp' )
 
-		if @toc.default?
+		if @global.default
 			# User tried to specify the default page
-			@default_topic = @toc.descendants.find{ |page| page.title==@toc.default }
+			@default_topic = @bundle.pages_by_title[ @global.default ].first
 			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?)"
+				warn "The requested default page '#{@global.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
+		@default_topic ||= @toc.descendants.find{ |node| node.link =~ /^\S+$/ }
+		warn "No default page is set, because no page has a path without spaces." unless @default_topic
 
 		File.open( @hhp, 'w' ) do |f|
 			f << ERB.new( IO.read( SUPPORT / 'hhp.erb' ) ).result( binding )