hoe-manualgen 0.0.1 → 0.1.0

data/Rakefile

@@ -23,12 +23,13 @@ hoespec = Hoe.spec 'hoe-manualgen' do
 	self.developer 'Michael Granger', 'ged@FaerieMUD.org'
 
 	self.extra_deps.push *{
-		'RedCloth'   => '~> 4.2.3',
-		'rcodetools' => '~> 0.8.5.0',
+		'hoe'        => "~> #{Hoe::VERSION[/^\d+\.\d+/]}",
+		'RedCloth'   => '~> 4.2',
+		'rcodetools' => '~> 0.8',
 	}
 	self.extra_dev_deps.push *{
-		'rspec'    => '~> 2.4.0',
-		'tidy-ext' => '~> 0.1.10',
+		'rspec'    => '~> 2.4',
+		'tidy-ext' => '~> 0.1',
 	}
 
 	self.spec_extras[:licenses] = ["BSD"]
@@ -38,6 +39,7 @@ hoespec = Hoe.spec 'hoe-manualgen' do
 
 	self.hg_sign_tags = true if self.respond_to?( :hg_sign_tags= )
 
+	self.extra_rdoc_files += Dir.glob( 'data/hoe-manualgen/lib/*.rb' )
 	self.rdoc_locations << "deveiate:/usr/local/www/public/code/#{remote_rdoc_dir}"
 end
 

data/data/hoe-manualgen/lib/api-filter.rb

@@ -16,7 +16,7 @@
 ###   <?api Class::Name ?>
 ###   <?api "click here":Class::Name ?>
 ### 
-class Hoe::ManualGen::APIFilter < Hoe::ManualGen::Page::Filter
+class Hoe::ManualGen::APIFilter < Hoe::ManualGen::PageFilter
 
 	# PI	   ::= '<?' PITarget (S (Char* - (Char* '?>' Char*)))? '?>'
 	ApiPI = %r{

data/data/hoe-manualgen/lib/editorial-filter.rb

@@ -17,7 +17,7 @@
 ###   <?ed "This is an editor's note." ?>
 ###   <?ed verify:"this content needs checking or verification" ?>
 ### 
-class Hoe::ManualGen::EditorialFilter < Hoe::ManualGen::Page::Filter
+class Hoe::ManualGen::EditorialFilter < Hoe::ManualGen::PageFilter
 	
 	# PI	   ::= '<?' PITarget (S (Char* - (Char* '?>' Char*)))? '?>'
 	LinkPI = %r{

data/data/hoe-manualgen/lib/examples-filter.rb

@@ -32,7 +32,7 @@
 ###	  any errors to the output.
 ### caption::
 ###   A small blurb to put below the pulled-out example in the HTML.
-class Hoe::ManualGen::ExamplesFilter < Hoe::ManualGen::Page::Filter
+class Hoe::ManualGen::ExamplesFilter < Hoe::ManualGen::PageFilter
 	
 	DEFAULTS = {
 		:language     => :ruby,

data/data/hoe-manualgen/lib/links-filter.rb

@@ -31,7 +31,7 @@
 ### The second form links to a page by its path relative to the base manual source directory.
 ### Again, the link text defaults to the page title, or can be overriden via a prepended string,
 ### and you can link into a page with an appended ID.
-class Hoe::ManualGen::LinksFilter < Hoe::ManualGen::Page::Filter
+class Hoe::ManualGen::LinksFilter < Hoe::ManualGen::PageFilter
 	
 	# PI	   ::= '<?' PITarget (S (Char* - (Char* '?>' Char*)))? '?>'
 	LinkPI = %r{

data/data/hoe-manualgen/resources/css/manual.css.erb

@@ -69,14 +69,22 @@ h1 {
 }
 
 h2 {
+	margin-top: 1em;
 	font-size: 2em;
 	font-weight: bold;
 }
 
 h3 {
+	margin-top: 1em;
 	font-size: 1.5em;
+	font-weight: bold;
+}
+h4 {
+	margin-top: 1em;
+	font-size: 1.25em;
 }
 
+
 p {
 	margin: 0;
 }
@@ -86,30 +94,26 @@ p + ol {
 	margin-top: 1em;
 }
 
-p + h2,
-p + h3 {
-	margin-top: 1em;
-}
-
 li {
 	list-style: disc;
 	margin: 0.5em 1.2em
 }
 
+pre {
+	margin: 1em 0;
+}
 code, pre {
+	background-color: rgba(179,179,179,0.4);
 	font-family: Inconsolata, monospace;
 }
 
-code {
-	background-color: rgba(179,179,179,0.4);
-}
 
 dl {
 	margin: 0.5em 0;
-	padding: 0 0.5em;
+	padding: 0;
 }
 dt {
-	padding: 0 0.25em;
+	padding: 0 0.75em;
 	border-top-left-radius: 0.5em;
 	border-top-right-radius: 0.5em;
 	background: -webkit-gradient(radial, 
@@ -124,7 +128,7 @@ dt {
 		#cecece);
 }
 dd {
-	padding: 0 0.25em;
+	padding: 0 0.75em;
 	border-bottom-left-radius: 0.5em;
 	border-bottom-right-radius: 0.5em;
 	margin-left: 0;
@@ -230,6 +234,11 @@ aside#sidebar nav {
 section#content {
 	padding: 0;
 }
+section#content > h2 {
+	margin-top: 0;
+}
+section#content h4 {
+}
 
 #page > footer {
 	color: #444;
@@ -461,7 +470,7 @@ div.callout.caution-callout {
 
 .syntaxhighlighter {
   width: 100%;
-  margin: 1em 0 1em 0;
+  margin: 1em 0 0 0;
   position: relative;
   overflow: auto;
   font-size: 1em;

data/lib/hoe/manualgen.rb

@@ -31,10 +31,10 @@ module Hoe::ManualGen
 	include FileUtils::DryRun if Rake.application.options.dryrun
 
 	# Library version constant
-	VERSION = '0.0.1'
+	VERSION = '0.1.0'
 
 	# Version-control revision constant
-	REVISION = %q$Revision: 63a03e1c872c $
+	REVISION = %q$Revision: 0d6137980766 $
 
 	# Configuration defaults
 	DEFAULT_BASE_DIR     = Pathname( 'manual' )
@@ -63,47 +63,9 @@ module Hoe::ManualGen
 	### Manual page-generation class
 	class Page
 
-		### An abstract filter class for manual content transformation.
-		class Filter
-			include Singleton
-
-			# A list of inheriting classes, keyed by normalized name
-			@derivatives = {}
-			class << self; attr_reader :derivatives; end
-
-			### Inheritance callback -- keep track of all inheriting classes for
-			### later.
-			def self::inherited( subclass )
-				key = subclass.name.
-					sub( /^.*::/, '' ).
-					gsub( /[^[:alpha:]]+/, '_' ).
-					downcase.
-					sub( /filter$/, '' )
-
-				self.derivatives[ key ] = subclass
-				self.derivatives[ key.to_sym ] = subclass
-
-				super
-			end
-
-
-			### Export any static resources required by this filter to the given +output_dir+.
-			def export_resources( output_dir )
-				# No-op by default
-			end
-
-
-			### Process the +page+'s source with the filter and return the altered content.
-			def process( source, page, metadata )
-				raise NotImplementedError,
-					"%s does not implement the #process method" % [ self.class.name ]
-			end
-		end # class Filter
-
-
 		### The default page configuration if none is specified.
 		DEFAULT_CONFIG = {
-			'filters' => [ 'erb', 'links', 'textile' ],
+			'filters' => [ 'erb', 'textile' ],
 			'layout'  => 'default.erb',
 			'cleanup' => false,
 		  }.freeze
@@ -260,8 +222,8 @@ module Hoe::ManualGen
 		def load_filters( filterlist )
 			filterlist.flatten.collect do |key|
 				raise ArgumentError, "filter '#{key}' could not be loaded" unless
-					Page::Filter.derivatives.key?( key )
-				Page::Filter.derivatives[ key ].instance
+					Hoe::ManualGen::PageFilter.derivatives.key?( key )
+				Hoe::ManualGen::PageFilter.derivatives[ key ].instance
 			end
 		end
 
@@ -499,8 +461,47 @@ module Hoe::ManualGen
 	end
 
 
+	### An abstract filter class for manual content transformation.
+	class PageFilter
+		include Singleton
+
+		# A list of inheriting classes, keyed by normalized name
+		@derivatives = {}
+		class << self; attr_reader :derivatives; end
+
+		### Inheritance callback -- keep track of all inheriting classes for
+		### later.
+		def self::inherited( subclass )
+			key = subclass.name.
+				sub( /^.*::/, '' ).
+				gsub( /[^[:alpha:]]+/, '_' ).
+				downcase.
+				sub( /filter$/, '' )
+
+			self.derivatives[ key ] = subclass
+			self.derivatives[ key.to_sym ] = subclass
+
+			super
+		end
+
+
+		### Export any static resources required by this filter to the given +output_dir+.
+		def export_resources( output_dir )
+			# No-op by default
+		end
+
+
+		### Process the +page+'s source with the filter and return the altered content.
+		def process( source, page, metadata )
+			raise NotImplementedError,
+				"%s does not implement the #process method" % [ self.class.name ]
+		end
+
+	end # class Hoe::ManualGen::PageFilter
+
+
 	### A Textile filter for the manual generation tasklib.
-	class TextileFilter < Page::Filter
+	class TextileFilter < Hoe::ManualGen::PageFilter
 
 		### Load RedCloth when the filter is first created
 		def initialize( *args )
@@ -518,11 +519,11 @@ module Hoe::ManualGen
 			return formatter.to_html
 		end
 
-	end
+	end # class Hoe::ManualGen::TextileFilter
 
 
 	### An ERB filter.
-	class ErbFilter < Page::Filter
+	class ErbFilter < Hoe::ManualGen::PageFilter
 
 		### Process the given +source+ as ERB and return the resulting HTML
 		### fragment.
@@ -532,7 +533,7 @@ module Hoe::ManualGen
 			return template.result( binding() )
 		end
 
-	end
+	end # class Hoe::ManualGen::ErbFilter
 
 
 	attr_accessor :manual_template_dir,

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: hoe-manualgen
 version: !ruby/object:Gem::Version 
-  hash: 29
+  hash: 27
   prerelease: 
   segments: 
   - 0
-  - 0
   - 1
-  version: 0.0.1
+  - 0
+  version: 0.1.0
 platform: ruby
 authors: 
 - Michael Granger
@@ -35,29 +35,43 @@ cert_chain:
   cmlhXe46pZNJgWKbxZah85jIjx95hR8vOI+NAM5iH9kOqK13DrxacTKPhqj5PjwF
   -----END CERTIFICATE-----
 
-date: 2011-01-31 00:00:00 -08:00
+date: 2011-03-16 00:00:00 -07:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
-  name: RedCloth
+  name: hoe
   prerelease: false
   requirement: &id001 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ~>
       - !ruby/object:Gem::Version 
-        hash: 49
+        hash: 17
         segments: 
-        - 4
         - 2
-        - 3
-        version: 4.2.3
+        - 9
+        version: "2.9"
   type: :runtime
   version_requirements: *id001
 - !ruby/object:Gem::Dependency 
-  name: rcodetools
+  name: RedCloth
   prerelease: false
   requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 31
+        segments: 
+        - 4
+        - 2
+        version: "4.2"
+  type: :runtime
+  version_requirements: *id002
+- !ruby/object:Gem::Dependency 
+  name: rcodetools
+  prerelease: false
+  requirement: &id003 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ~>
@@ -66,75 +80,71 @@ dependencies:
         segments: 
         - 0
         - 8
-        - 5
-        - 0
-        version: 0.8.5.0
+        version: "0.8"
   type: :runtime
-  version_requirements: *id002
+  version_requirements: *id003
 - !ruby/object:Gem::Dependency 
   name: hoe-mercurial
   prerelease: false
-  requirement: &id003 !ruby/object:Gem::Requirement 
+  requirement: &id004 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ~>
       - !ruby/object:Gem::Version 
-        hash: 31
+        hash: 29
         segments: 
         - 1
         - 2
-        - 0
-        version: 1.2.0
+        - 1
+        version: 1.2.1
   type: :development
-  version_requirements: *id003
+  version_requirements: *id004
 - !ruby/object:Gem::Dependency 
   name: tidy-ext
   prerelease: false
-  requirement: &id004 !ruby/object:Gem::Requirement 
+  requirement: &id005 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ~>
       - !ruby/object:Gem::Version 
-        hash: 15
+        hash: 9
         segments: 
         - 0
         - 1
-        - 10
-        version: 0.1.10
+        version: "0.1"
   type: :development
-  version_requirements: *id004
+  version_requirements: *id005
 - !ruby/object:Gem::Dependency 
   name: rspec
   prerelease: false
-  requirement: &id005 !ruby/object:Gem::Requirement 
+  requirement: &id006 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ~>
       - !ruby/object:Gem::Version 
-        hash: 31
+        hash: 11
         segments: 
         - 2
         - 4
-        - 0
-        version: 2.4.0
+        version: "2.4"
   type: :development
-  version_requirements: *id005
+  version_requirements: *id006
 - !ruby/object:Gem::Dependency 
   name: hoe
   prerelease: false
-  requirement: &id006 !ruby/object:Gem::Requirement 
+  requirement: &id007 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
-        hash: 47
+        hash: 41
         segments: 
         - 2
-        - 8
-        - 0
-        version: 2.8.0
+        - 9
+        - 1
+        version: 2.9.1
   type: :development
-  version_requirements: *id006
+  version_requirements: *id007
 description: |-
   A manual-generation plugin for Hoe.
   
@@ -148,8 +158,11 @@ executables: []
 
 extensions: []
 
-extra_rdoc_files: []
-
+extra_rdoc_files: 
+- data/hoe-manualgen/lib/api-filter.rb
+- data/hoe-manualgen/lib/editorial-filter.rb
+- data/hoe-manualgen/lib/examples-filter.rb
+- data/hoe-manualgen/lib/links-filter.rb
 files: 
 - .autotest
 - History.md
@@ -222,7 +235,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
 requirements: []
 
 rubyforge_project: hoe-manualgen
-rubygems_version: 1.4.2
+rubygems_version: 1.6.2
 signing_key: 
 specification_version: 3
 summary: A manual-generation plugin for Hoe