docubot 0.6 → 0.6.1

data/bin/docubot

@@ -9,7 +9,7 @@ require 'docubot'
 
 USAGE = <<ENDUSAGE
 Usage:
-   docubot [-h] [create [-s shell] [-f]] directory [-w writer] [-o output_file] [-n]
+   docubot [-h] [create [-s shell] [-f]] directory [-w writer] [-o output_file] [-n] [-l log_file]
 ENDUSAGE
 
 HELP = <<ENDHELP
@@ -25,6 +25,7 @@ HELP = <<ENDHELP
    -o, --output     The file or folder (depending on the writer) to create.
                     [Default value depends on the writer chosen.]
    -n, --nopreview  Disable automatic preview of .chm.
+   -l, --logfile    Specify the filename to log to.
 
 ENDHELP
 
@@ -47,6 +48,8 @@ ARGV.each{ |arg|
 			next_arg = :output
 		when '-n','--nopreview'
 			ARGS[:nopreview] = true
+		when '-l','--logfile'
+			next_arg = :logfile
 		else
 			if next_arg
 				ARGS[next_arg] = arg
@@ -62,6 +65,12 @@ if ARGS[:help] or !ARGS[:directory]
 	exit
 end
 
+if ARGS[:logfile]
+	$stdout.reopen( ARGS[:logfile], "w" )
+	$stdout.sync = true
+	$stderr.reopen( $stdout )
+end
+
 if ARGS[:create]
 	require 'fileutils'
 

data/bin/docubot.bat

@@ -0,0 +1 @@
+@"ruby.exe" "%~dpn0" %*

data/lib/docubot.rb

@@ -20,7 +20,7 @@ module FileUtils
 end
 
 module DocuBot
-	VERSION = '0.6'
+	VERSION = '0.6.1'
 	DIR     = File.expand_path( File.dirname( __FILE__ ) )
 	
 	TEMPLATE_DIR = DIR / 'docubot/templates'

data/lib/docubot/writers/chm.rb

@@ -72,7 +72,7 @@ class DocuBot::CHMWriter < DocuBot::HTMLWriter
 		lap = Time.now
 		
 		# Clean out the intermediary files
-		FileUtils.rm( [ @hhc, @hhp, @hhk ] )
+		FileUtils.rm( [ @hhc, @hhp, @hhk ] ) unless ARGS[:logfile] 
 		FileUtils.rm_r( @html_path )
 		puts "...%.2fs to clean up temporary files" % (Time.now-lap)
 		lap = Time.now

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: docubot
 version: !ruby/object:Gem::Version 
-  version: "0.6"
+  version: 0.6.1
 platform: ruby
 authors: 
 - Gavin Kistner
@@ -73,6 +73,7 @@ extra_rdoc_files: []
 
 files: 
 - bin/docubot
+- bin/docubot.bat
 - lib/docubot/bundle.rb
 - lib/docubot/converter.rb
 - lib/docubot/converters/haml.rb
@@ -109,25 +110,6 @@ files:
 - lib/docubot/shells/docubot-help/index.txt
 - lib/docubot/shells/docubot-help/_glossary/Template.md
 - lib/docubot/shells/docubot-help/_static/glider.png
-- lib/docubot/shells/nvphysx/0_License.md
-- lib/docubot/shells/nvphysx/1_Getting_Started.haml
-- lib/docubot/shells/nvphysx/Appendix/Glossary.md
-- lib/docubot/shells/nvphysx/index.txt
-- lib/docubot/shells/nvphysx/_glossary/APEX.md
-- lib/docubot/shells/nvphysx/_glossary/NVIDIA.md
-- lib/docubot/shells/nvphysx/_glossary/PhysX.textile
-- lib/docubot/shells/nvphysx/_static/NVBadge_3D.png
-- lib/docubot/shells/nvphysx/_static/PhysXbyNV_Black.png
-- lib/docubot/shells/nvphysx/_templates/section.haml
-- lib/docubot/shells/nvphysx/_templates/top.haml
-- lib/docubot/shells/nvphysx/_templates/_root/bg_green_bar_revised.gif
-- lib/docubot/shells/nvphysx/_templates/_root/close.png
-- lib/docubot/shells/nvphysx/_templates/_root/common.css
-- lib/docubot/shells/nvphysx/_templates/_root/glossary.css
-- lib/docubot/shells/nvphysx/_templates/_root/glossary.js
-- lib/docubot/shells/nvphysx/_templates/_root/nvdevtools.js
-- lib/docubot/shells/nvphysx/_templates/_root/nvidia-logo.gif
-- lib/docubot/shells/nvphysx/_templates/_root/right-sidebar.png
 - lib/docubot/snippet.rb
 - lib/docubot/snippets/glossary.rb
 - lib/docubot/snippets/index_entries.rb

data/lib/docubot/shells/nvphysx/0_License.md

@@ -1,3 +0,0 @@
-style: license nosidebar
-+++
-![NVIDIA 3D Badge](_static/NVBadge_3D.png)

data/lib/docubot/shells/nvphysx/1_Getting_Started.haml

@@ -1,51 +0,0 @@
-keywords: Basics
-toc     : welcome authoring glossary index
-+++
-%h2#welcome Welcome to DocuBot for NVIDIA PhysX
-%p.sidebar
-	%img(width='150' src='_static/NVBadge_3D.png')
-	NVIDIA 3D Badge
-	%span#out
-:textile
-	This template shows the standard page style, which has a 350px sidebar on the right for including
-	images related to the text.
-	
-	To put images (with an optional description) in the sidebar, place them inside a paragraph with
-	the CSS class @sidebar@. They will float to the right next to your content.
-	
-	Each header will--by default--wait to begin until all images on the right have finished.
-
-%h2#authoring Authoring Content	
-<p class="sidebar"><img src="_static/PhysXbyNV_Black.png" width="180"></p>
-:markdown
-	The headers on each page should start at `h2` (not `h1`); `h1` is used for the title at the top of the page.
-	 
-	As shown in this template, if you apply HTML `id` attributes to the headers (or any other HTML element), and list those
-	identifiers under a toc entry at the top of the page, the Table of Contents will include sub-links to the headings.
-	
-%h2#glossary Glossary Entries
-%p
-	To create a reference to a glossary term, surround it in double dollar signs.
-	For example, $$NVIDIA$$ makes $$PhysX$$ and $$APEX Libraries:APEX$$.
-%p
-	As shown in the APEX link above, you can have the glossary text be different from the term it links to
-	by putting the words you want first, followed by a colon, followed by the actual glossary term to link to.
-%p
-	This works in all markups. (The processing happens after the markup is converted to HTML.)
-	
-%h2#index Managing the Index
-%p The index is automatically populated with the text from headings and defintions on the pages.
-%p To add additional terms, you can:
-%ul
-	%li
-		Use a <code>keywords</code> section at the top of the page with comma-delimited keywords or
-		phrases that you want the index to associate with the current page.
-	%li
-		:markdown
-			Put two `@` signs around any word or phrase in your text that you wanted added to the index.
-			
-			For example, imagine that this page talked about @@sexy code@@; the index now knows about that.
-			
-			Note that this syntax doesn't currently work with textile, because it uses single @ characters to
-			denote code. This will be fixed in the future (by processing glossary and index snippets before markup).
-	

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

@@ -1,7 +0,0 @@
-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

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

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

@@ -1 +0,0 @@
-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

@@ -1,3 +0,0 @@
-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

@@ -1,269 +0,0 @@
-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:8pt;
-    margin:   0 350px 0 10px;
-    padding:  0;
-  	padding-bottom:30em;
-}
-
-body.nosidebar div#mainbody
-{
-	margin-right:0px;
-}
-
-div#mainbody
-{
-	padding-bottom:2em;
-}
-
-div.section
-{
-	margin-left:1em
-}
-
-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;
-    padding-bottom:10em;
-}
-
-#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 1em }
-fieldset p { margin:1em 2em }
-dl.section { margin-left:1em }
-dt { font-weight:bold; font-style:normal; margin-top: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;
-	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

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

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

@@ -1,34 +0,0 @@
-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 ){
-		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');
-	handleEvent( close, 'click', function(){
-		box.style.display = 'none';
-	});
-});

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

@@ -1,31 +0,0 @@
-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/section.haml

@@ -1,9 +0,0 @@
-%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/shells/nvphysx/_templates/top.haml

@@ -1,28 +0,0 @@
-!!! 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

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