docgenerator 1.0.4 → 1.1.1

data/lib/docgenerator_document.rb

@@ -4,6 +4,28 @@
 #Each document contains a header and a body. Both are special Element classes.
 #
 class Document
+  #Valid meta tags, used for HTML
+  #
+  #This meta-tags are used by sitegenerator
+  VALID_META_TAGS = %w{
+    keywords
+    description
+    id
+    altlang
+    toc
+    pdf
+    odp
+    amazon
+    forum
+    feed
+  }
+  class << VALID_META_TAGS
+    # Return true if self is part of the given parameter.
+    def ===(o)
+        return self.include?(o)
+    end
+ end
+    
 	#Create a new document.
 	#There are different document templates supported. 
 	#The templates refer to the corresponding TeX-classes.
@@ -29,9 +51,12 @@ class Document
       settings = { :template => settings }
     end
     ##<<<<temporary check, old interface
+    
     @log = settings[:log]
-    @log = Log4r::Logger.new( 'Doc' ) unless @log
-
+    if ! @log
+      @log = Log4r::Logger.new( 'Doc', Log4r::WARN )
+      @log.outputters = Log4r::StdoutOutputter.new('log_xxx')
+    end
 		@meta	= {}	#some meta-Tags for HTML
 		@body	= element( :body )
 		@head	= element( :head )
@@ -44,9 +69,10 @@ class Document
 
     settings.each{|key, value|
       case key
-        when 	:title, :author, :date, :keywords, :description, :creator, :language
+        when :title, :shorttitle, :author, :date, :keywords, :description, :creator, :language
           self.send("#{key}=".to_sym, value)
-        when :shorttitle, :odp
+        #~ when :odp, :pdf, :amazon  #VALID_META_TAGS
+        when *VALID_META_TAGS.map{|mkey|mkey.to_sym}
           self.meta( key, value )
         when :template
      			[value].flatten.each{|template|
@@ -62,11 +88,25 @@ class Document
                     end
                 end 
           } #templates
+        when :css
+          if ! File.exist?(value)
+            @log.warn("CSS-Reference not found (#{value})") if @log.warn?
+          end
+          #~ @head << element(:htmlonly,{}, <<css
+#~ <meta http-equiv="Content-Style-Type" content="text/css">
+#~ css
+#~ <link rel="stylesheet" type="text/css" href="#{value}">
+                    #~ ).cr
+          @head << element( :link, { 
+                      :href		=> value,
+                      :rel		=> 'stylesheet',
+                      :type	=> "text/css" } ).cr. restrict_to(:html)
         when :maketitle
-          @body << element(:maketitle ).cr
+          #:maketitle is defined, but we have also to check, if it is true
+          @body << element(:maketitle ).cr if settings[key]
         when :log
         else
-          @log.error("Document.new: Unknown setting #{key.inspect} (=#{value.inspect})") if @log.error?
+          @log.warn("Document.new: Unknown setting #{key.inspect} (=#{value.inspect})") if @log.warn?
       end
     } #settings
 
@@ -77,7 +117,7 @@ class Document
   #Logger for the document
 	attr_reader	:log
 	#Document title
-	attr_accessor	:title
+	attr_accessor	:title, :shorttitle
 	#Set document description
 	attr_writer	:author, :date, :keywords, :description, :creator
 	attr_writer	:language
@@ -103,9 +143,15 @@ class Document
 	#Add a meta-tag-information for the HTML-Output.
 	def meta( key, content )
 		key	= key.to_s
+    
+    if ! VALID_META_TAGS.include?(key)
+      @log.warn("Unknown meta-tag #{key} (#{content})") if @log.warn?
+      @log.info("\tAllowed meta-tags: #{VALID_META_TAGS.join(', ')}") if @log.info?
+    end
 		if @meta[key]
-			puts "Double definition meta-tag #{key} (old: #{@meta[key]}, new: #{content})"
+			@log.warn("Double definition meta-tag #{key} (old: #{@meta[key]}, new: #{content})") if @log.warn? and @meta[key] != content
 		end
+    
 		@meta[key] = content
 	end
 	#Prepare the docinfo.
@@ -122,7 +168,7 @@ class Document
 		
 		#Build docinfo.
 		result = []
-		result << element( :title, {:short => @meta["shorttitle"] }, @title).CR if @title
+		result << element( :title, {:short => @shorttitle }, @title).CR if @title
 		result << element( :author, {}, @author).cr if @author
 		result << element( :date, {}, @date).cr if @date
 		result << element( :keywords, {}, @keywords).cr if @keywords
@@ -145,6 +191,9 @@ class Document
   #- tocfilename: Added as prefix to link. 
   #   can be used to make toc for in another file (cross-referencing)
   #- level: Depth of toc
+  #The document should be filled before you add the toc.
+  #You an use Element#insertbefore:
+  #  doc.body.insertbefore(start, doc.toc)
 	def toc( options = {} )
     opt = {
       :id => 'toc',
@@ -228,9 +277,44 @@ end
 	#There is a comparison between an already existing file and the new one.
 	#To write a new version, the document must change and overwrite must be true.
 	#
-	#It is possible to give pairs of RegExp (pattern) and replacements to the result.
-	def save( filename, overwrite=false, replacements = {}  )
-	
+  #Valid options:
+  #- :replacements
+	#   It is possible to give pairs of RegExp (pattern) and replacements to the result.
+  #- overwrite [true]
+  #   allows to overwrite 
+  #- :additional_options 
+  #   List of options.
+  #   If you want to give parameters to specific 'Element'-obejcts you can define the keys here.
+  #   If you don't make it, you get warnings about undefined options.
+  #
+	def save( filename, options = {} )
+    #check old interface before 1.1.0
+    case options
+      when true, false
+        @log.warn( "Old interface for Document.save, use :overwrite => true/false" ) if @log.error?
+        options = { :overwrite => options }
+      end    
+      
+    options = {
+      :overwrite      => true, 
+      :replacements => {} ,
+      :additional_options => [],
+    }.update(options)
+    
+    #Check valid options
+    options.each{|key,value|
+      case key
+        when :overwrite, :replacements
+        when :additional_options
+        else
+          if options[:additional_options].include?(key)
+            @log.warn( "unknown option #{key.inspect} for Document.save" ) if @log.warn?
+          else
+            @log.debug( "Save-Specific option #{key.inspect} in Document.save" ) if @log.debug?
+          end
+      end
+    }
+    
 		if ! @template
 			@log.error( "No template available to create #{filename}" ) if @log.error?
 			return false
@@ -254,26 +338,26 @@ end
 		extension = File.basename( filename ).split( /\./).last
 		case extension
 		when /tex/i
-			@target	= :latex
+			target	= :latex
 		when /htm[l]?/i
-			@target	= :html
+			target	= :html
 		when /txt/
-			@target	= :text
+			target	= :text
 		when /wiki/
-			@target = :wiki
+			target = :wiki
 		else
 			@log.fatal( "Unknown Extension #{extension} for #{File.basename( filename )}" ) if @log.fatal?
 			raise "Unknown Extension #{extension}"
 		end
 		
-		new = to_doc( @target, {
+		new = to_doc( target, {
                     :template=> @template[target],
                     :filename => filename,
-                    :replacements => replacements,
+                    :replacements => options[:replacements],
                     :log  => @log
                     })
 		
-		case @target
+		case target
 		when :latex
 			prefix.gsub!( /^/, '%' )
 			old.sub!(/\A.*#{PREFIX_ENDFLAG}/m, '<<prefix>>' ) if old
@@ -284,8 +368,8 @@ end
 		when :wiki
 			#~ new.squeeze!("\n")
 		else
-			@log.fatal( "Unknown target #{@target} for #{File.basename( filename )}" ) if @log.fatal?
-			raise "Unknown target #{@target}"
+			@log.fatal( "Unknown target #{target} for #{File.basename( filename )}" ) if @log.fatal?
+			raise "Unknown target #{target}"
 		end
 		#Make it a bit more compact.
 		#TeX requires at least 2 \n for paragraph changes
@@ -294,11 +378,10 @@ end
 		if ! new.kind_of?( String )
 			@log.error( "New is wrong type: #{new.inspect}" ) if @log.error?
 		end
-		@target	= nil
 
 		if new != old
 			new.sub!( '<<prefix>>',	prefix)
-			if ( File.exist?( filename ) and !overwrite )
+			if ( File.exist?( filename ) and ! options[:overwrite] )
 				puts "Datei #{filename} exist already \nContinue [yn]?"
 				answer = $stdin.gets()	if $stdin.tty? #nur bei call aus DOS-Box
 				if ! ( answer =~ /[YyjJ].*/ )
@@ -316,23 +399,23 @@ end
 			#~ f = File.new( filename.sub( extension, 'bak'), 'w' )
 			#~ f << old
 			#~ f.close
-			Document.runtex( filename, @runtex ) if @runtex
+			Document.runtex( filename, @runtex ) if @runtex and target	== :latex
 			return true
 		elsif old
       @log.info("Unchanged\t#{filename}") if @log.info?
 			puts "Unchanged\t#{filename}" if @@givemessage.include?(:nochange)
 			return false
 		end		
-	end
+	end #Document#save
 	#Build the content for the target format.
-	#Supported tagret formats are:
+	#Supported target formats are:
 	#-	:latex
 	#-	:html
 	#-	:text
 	#If the standard templates are used, there is a <<prefix>> left 
 	#(used from Document#save to include some additional information).
 	#
-	#If the method is called directly to prpare document snipplets, you can use:
+	#If the method is called directly to prepare document snipplets, you can use:
 	#	puts Document#to_doc( :latex, '<<body>>')
 	#
 	#It is possible to give pairs of RegExp (pattern) and a replacement to the result.
@@ -385,28 +468,35 @@ end
 	attr_reader :target
   
 	#Call TeX and translate the file.
-	#Experimental
+	#Experimental, unpublished feature up to now.
 	#Fixme: Chain
-	def Document.runtex( filename, format = :xelatex )
+	def Document.runtex( filename, format = :pdflualatex )
 		begin
-			#~ require 'rtex'
-			require 'c:/usr/script/rtex/rtex'
+			require 'runtex'
+			#~ require 'c:/usr/script/runtex/lib/runtex'
 		rescue LoadError
-			puts "Sorry, didn't find the experimental tex translation tool to translate #{filename}"
+			puts "Sorry, I didn't find the experimental tex translation tool to translate #{filename}"
 			return false
 		end
 		#~ puts "Unknown texfile #{filename}" if ! filename
-		tex = Chain.new()
-    tex.xelatex() #default
-		case format
-		when :xelatex;  tex.xelatex()
-		when :pdflatex;  tex.pdflatex()
-		when :latex;  			tex.latex()
-		end
-		#~ Logger.level=3
-		tex.file = filename
+		tex = RunTeX::Job_chain.new( filename,
+      :format => format )
+		#~ case format
+    #~ when true:     tex.pdflualatex() #default
+    #~ when false, nil
+		#~ when :pdflatex;  tex.pdflatex()
+		#~ when :pdflualatex;  tex.pdflualatex()
+		#~ when :xelatex;  tex.xelatex()
+		#~ when :latex;  			tex.latex()
+    #~ else
+      #~ puts "Undefined chain #{format.inspect} for runtex, use pdflualatex"
+      #~ tex.pdflualatex() #default
+		#~ end
+		#~ tex.file = filename
 		begin
-			tex.execute()
+      puts "Start TeX-job #{tex.basename}"
+      tex.log.level = Log4r::WARN
+      tex.start(format)
 		rescue SystemExit
 			puts "rescued a SystemExit exception"
 			return false