docgenerator 2.1.0 → 2.1.1

data/lib/docgenerator/characters.rb

@@ -6,6 +6,10 @@ This document is UTF-8-encoded.
 A side effect: Hanna/Rdoc will not add this code to the documentation.
 =end
 
+#
+# Fixme: Add unicode-codepoints
+#
+
 
 #
 module Docgenerator
@@ -37,7 +41,65 @@ Attributes are not defined for this element.
       add_text_output ''
       add_creole_output '{{shy}}'
     end #Shy
+=begin rdoc
+Define Element ZeroWidthSpace
+
+Create an instance with
+  element( :zerowidthspace )
+or
+  ZeroWidthSpace.new( )
+Attributes are not defined for this element.
+
+See http://stackoverflow.com/questions/5038920/html-soft-hypen-shy-without-dash
+=end
+    class ZeroWidthSpace < Element
+      has_no_content false
+      add_html_output '&#8203;'
+      add_latex_output '""'
+      add_text_output ''
+      #~ add_creole_output '{{-}}'
+    end #ZeroWidthSpace
+    
+=begin rdoc
+Define Element :thinsp
+
+Small space in text
+
+Create an instance with
+  element( :thinsp )
+or
+  thinsp.new( )
+Attributes are not defined for this element.
+
+See http://stackoverflow.com/questions/5038920/html-soft-hypen-shy-without-dash 
+for usage as Soft hypen (&shy;) without dash.
+=end
+    class Thinsp < Element
+      has_no_content false
+      add_html_output '&thinsp;'
+      add_latex_output '\,'
+      add_text_output ''
+      add_creole_output '{{thinsp}}'
+    end #thinsp
+=begin rdoc
+Define Element :wbr
+
+optionalen line break, no separator.
 
+Create an instance with
+  element( :wbr )
+or
+  Wbr.new( )
+Attributes are not defined for this element.
+=end
+    class Wbr < Element
+      has_no_content false
+      add_html_output '&wbr;'
+      add_latex_output '""'
+      add_text_output ''  #&#8203;
+      add_creole_output '{{wbr}}'
+    end #Wbr
+    
 =begin rdoc
 Define Element :space, :ensp
 
@@ -382,7 +444,7 @@ Attributes are not defined for this element.
       add_id :<=
       has_no_content false
       add_html_output '&lArr;'
-      add_latex_output '\ensuremath{\Lefttarrow}'
+      add_latex_output '\ensuremath{\Leftarrow}'
       add_text_output '<='
       add_creole_output '<='
     end #Larr
@@ -476,6 +538,23 @@ Attributes are not defined for this element.
     end #Lt
 
 =begin rdoc
+Define Element :ll, :<<
+
+Create an instance with
+  element( :l< )
+  element( :<< )
+or
+  Ll.new( )
+Attributes are not defined for this element.
+=end
+    class Ll < Element
+      add_id :<<
+      has_no_content false
+      add_html_output '&laquo;'
+      add_latex_output '\ll '
+      add_text_output '<<'
+    end #Lt
+=begin rdoc
 Define Element :gt, :>
 
 Create an instance with
@@ -493,6 +572,24 @@ Attributes are not defined for this element.
       add_text_output '>'
     end #Gt
 
+=begin rdoc
+Define Element :gg, :>>
+
+Create an instance with
+  element( :gg )
+  element( :>> )
+or
+  Gg.new( )
+Attributes are not defined for this element.
+=end
+    class Gg < Element
+      add_id :>>
+      has_no_content false
+      add_html_output '&raquo;'
+      add_latex_output '\gg '
+      add_text_output '>>'
+    end #Gt
+    
 =begin rdoc
 Define Element :infin, :infty
 
@@ -755,6 +852,7 @@ Attributes are not defined for this element.
       has_no_content false
       add_html_output '&bdquo;'
       add_latex_output '\glqq '
+      add_text_output '„'
       add_wiki_output '„'
       add_creole_output '„'
     end #Bdquo
@@ -770,11 +868,10 @@ Attributes are not defined for this element.
 =end
     class Leftdoublequotemark < Element
       add_id :ldquo
-      add_id :grqq
       has_no_content false
       add_html_output '&ldquo;'
-      add_latex_output '\grqq'
-      add_text_output '``'
+      add_latex_output '\lq\lq{}' 
+      add_text_output '“'
       add_wiki_output '“'
       add_creole_output '“'
     end #Ldquo
@@ -790,12 +887,13 @@ Attributes are not defined for this element.
 =end
     class Rightdoublequotemark < Element
       add_id :rdquo
-      add_id :rqq
+      add_id :grqq
       has_no_content false
       add_html_output '&rdquo;'
-      add_latex_output '\rqq '
-      add_text_output ''''
-      #~ add_creole_output ''
+      add_latex_output '\grqq '
+      add_text_output '”'
+      add_wiki_output '”'
+      add_creole_output '”'
     end #Rdquo
 
 =begin rdoc

data/lib/docgenerator/compatibility_v1.rb

@@ -102,12 +102,18 @@ This code is obsolete.
 Please use Element.create_convert_to_code to get a template to replace your Element#create.
 =end
   def  self.create( name, attr = {}, content = false, output = {} )
-    DOCGENERATOR_LOGGER.warn("Element.create called -> to be replaced") if DOCGENERATOR_LOGGER.warn?
+    if @@ids[name]
+      DOCGENERATOR_LOGGER.error("Element.create for existing #{name.inspect} called -> ignored") if DOCGENERATOR_LOGGER.error?
+      return
+    else
+      DOCGENERATOR_LOGGER.warn("Element.create for #{name.inspect} called -> to be replaced") if DOCGENERATOR_LOGGER.warn?
+    end
     create_convert_to_code( [name].flatten, attr, content, output ) if DOCGENERATOR_LOGGER.warn?
     #First some checks
     if ! attr.kind_of?( Hash )
       raise "Type error Element.create: Expected Hash, get #{attr.class}"
     end
+    
     #Generic class creation
     elementclass = Class.new( Element )
     #Add the id of the new class to central collection.

data/lib/docgenerator/document.rb

@@ -99,7 +99,7 @@ The templates refer to the corresponding TeX-classes.
 
       settings.each{|key, value|
         case key
-          when :title, :shorttitle, :author, :date, :keywords, :description, :creator, :language
+          when :title, :shorttitle, :subtitle, :author, :date, :location, :keywords, :description, :creator, :language
             self.send("#{key}=".to_sym, value)
           #~ when :odp, :pdf, :amazon  #VALID_META_TAGS
           when *VALID_META_TAGS.map{|mkey|mkey.to_sym}
@@ -136,13 +136,14 @@ The templates refer to the corresponding TeX-classes.
             @body << element(:maketitle ).cr if settings[key]
           when :latex_options
             add_option(value)
-          when :log
+          when :log, :logname
           else
             @log.warn("Document.new: Unknown setting #{key.inspect} (=#{value.inspect})") if @log.warn?
         end
       } #settings
 
       if @template[:html].encoding.name == 'UTF-8'
+        @log.debug("Document.new: set UTF-8 for html") if @log.debug?
         @head << element(:htmlonly,{},'<meta http-equiv="Content-Type" content="text/html; charset=utf-8">').Cr
       end
 
@@ -154,6 +155,8 @@ The templates refer to the corresponding TeX-classes.
     attr_reader  :log
     #Document title
     attr_accessor  :title, :shorttitle
+    #For usage in ocument title
+    attr_accessor  :subtitle
     #Set document description
     attr_writer  :author, :date, :keywords, :description, :creator
     attr_writer  :language
@@ -207,6 +210,7 @@ Add a meta-tag-information for the HTML-Output.
       #Build docinfo.
       result = []
       result << element( :title, {:short => shorttitle }, @title).CR if @title
+      result << element( :subtitle, {}, @subtitle).CR if @subtitle
       result << element( :author, {}, @author).cr if @author
       result << element( :date, {}, @date).cr if @date
       result << element( :keywords, {}, @keywords).cr if @keywords
@@ -369,17 +373,6 @@ Valid options:
         return false
       end
       
-      
-      prefix = [   nil, 
-          "Build by\t#{__FILE__}",
-          "Dir:\t\t#{Dir.pwd}",
-          "Creator:\tDocgenerator #{Docgenerator::VERSION} - http://rubygems.org/gems/docgenerator",
-          "Target:\t\t#{filename}",
-          "#{Time.now.strftime('%Y/%m/%d %H:%M:%S')}",
-          nil,
-          "#{PREFIX_ENDFLAG}"
-        ].join("\n\t")
-      
       #Determine the target document type, depending on extension.
       extension = File.basename( filename ).split( /\./).last
       case extension
@@ -419,6 +412,20 @@ Valid options:
                       :replacements => options[:replacements],
                       :log  => @log
                       })
+
+      #Define a file prefix.
+      prefix = [ nil,
+        ( target == :latex ? "!TEX encoding= %s" : 'encoding: %s' ) % new.encoding,
+        #~ "!TEX TS-program = lualatex",
+          "Build by\t#{__FILE__}",
+          "Dir:\t\t#{Dir.pwd}",
+          "Creator:\tDocgenerator #{Docgenerator::VERSION} - http://rubygems.org/gems/docgenerator",
+          "Target:\t\t#{filename}",
+          "#{Time.now.strftime('%Y/%m/%d %H:%M:%S')}",
+          nil,
+          "#{PREFIX_ENDFLAG}"
+        ].join("\n\t")
+
       #Get previous content if available
       old = nil
       if File.exist?( filename )
@@ -559,7 +566,10 @@ If the method is called directly to prepare document snipplets, you can use:
       new.sub!( '<<head>>',  @head.to_doc(target, options ).encode(encoding))
       
       options[:log].debug( "Build body") if options[:log].debug?
-      new.sub!( '<<body>>',  @body.to_doc(target, options).encode(encoding))
+      #The block version is needed.
+      #Else there is a problem with \&  
+      #Example: puts 'xx<<body>>xx'.sub('<<body>>', 'a\&b')
+      new.sub!( '<<body>>'){ @body.to_doc(target, options).encode(encoding) }
       
       new.sub!( '<<classoptions>>',  @options.uniq.join(',').encode(encoding))
       
@@ -571,6 +581,10 @@ If the method is called directly to prepare document snipplets, you can use:
       return new
     end  #Document#to_doc
 
+    def inspect()
+      return "#<Document '#{self.title}'>"
+    end
+
     #
     #Eigenclass Document
     class << self 
@@ -643,6 +657,10 @@ Better solution:
 * use elements from Docgenerator::Characters
 * Use unicode in TeX-Document.
 * Put string into \path, \verb or similar.
+
+Usage:
+  Docgenerator::Document.texify('text_with_underscore')
+  
 =end
       def texify( input )
         out = input.strip
@@ -657,9 +675,6 @@ Better solution:
         #~ out.gsub!( /€/, '\euro ')  #regexp is in utf-8 -- may make problems.
         return out
       end
-      def inspect()
-        return "#<Document '#{@title}'>"
-      end
-    end #Eigenclass Document
+    end #Eigenclass Document    
   end  #Document
-end #module Docgenerator
+end #module Docgenerator

data/lib/docgenerator/element.rb

@@ -419,6 +419,7 @@ false-values are ignored.
 If you need a "value=true", then add 'true' as a string.
 
 Example (Packages::IncludePDF):
+
   class IncludePDF < Element
     add_attribute    :pages,  Attribute.create( [ :texkeyval], [ String ] )
     add_attribute    :nup,  Attribute.create( [ :texkeyval], [ /\d+x\d+/ ] )  #multiple logical pages onto each sheet of paper. 

data/lib/docgenerator/element_meta.rb

@@ -225,7 +225,7 @@ Define the output routine, based on a string.
         cmd = <<-code
         def to_#{target}(options = {})
           o = set_option_defaults(options)
-          o[:log].debug("enter to_doc(#{target}) for #{self.inspect}, options: \#{options.keys.inspect}") if o[:log].debug?
+          o[:log].debug("enter to_#{target} for #{self.inspect}, options: \#{options.keys.inspect}") if o[:log].debug?
         code
         template = string.gsub(/\\/, '\\\\\\')
         template.gsub!(/"/, '\"')