docgenerator 2.1.1 → 3.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: c7aa1a103c221470b9175ad34855d17cc11bb1bc
-  data.tar.gz: 36cc3d2e385eac113dcbaf2c62b61db3b2d98473
+  metadata.gz: cd108cc058c487c972f6cb1109f5a1c89d2d68e2
+  data.tar.gz: 5b44229fb757db659df881fed9d32730a728191f
 SHA512:
-  metadata.gz: f8f822678971a30cac152cb54680e5e0cf467ee6a324630cfc0177852a05d2e9124271bdb1143d7fd0801a649d320c3335950aad03b4b31cbd8e198297fc72bc
-  data.tar.gz: 8a4b9a35f508dc2d9734c864b98478b575491dd3393ebacb81696de4cb7c50780c4cb815b8800cf637f172cabba433df6082f4c0456824d9d7e10436bd836085
+  metadata.gz: 58bbd95977ee3e3567ed687214143aa4f86a9ee83398864c4e7bb14ba4363c4f6ef73d14087ef4d399f06030a496383f5a2998301857d42e20f7857a1eb4e947
+  data.tar.gz: 6fb65c6ea46159d8fccfefed1fa8b2c52eec97e1c818c11e775313299d19eeb70025e5dd00f132cc400e36d5d6524ef6d98e8c64682c1c0ce470bc402d52c7e6

data/lib/docgenerator.rb

@@ -343,26 +343,26 @@ if $0 == __FILE__ and RUBY_VERSION =~ /1.9/
   $:.unshift('.')
 end
 
-require 'docgenerator/version' 
-require 'docgenerator/standard'
-require 'docgenerator/element_meta' #Meta-class definitions
-require 'docgenerator/element'  #includes definition of method 'element'
-#~ require 'docgenerator/compatibility_v1' #some old code
-require 'docgenerator/templates/docgenerator_template'
-require 'docgenerator/css'
-require 'docgenerator/templates/docgenerator_template_css'
-require 'docgenerator/attribute'
-require 'docgenerator/document'
+require_relative  'docgenerator/version' 
+require_relative  'docgenerator/standard'
+require_relative  'docgenerator/element_meta' #Meta-class definitions
+require_relative  'docgenerator/element'  #includes definition of method 'element'
+#~ require_relative  'docgenerator/compatibility_v1' #some old code
+require_relative  'docgenerator/templates/docgenerator_template'
+require_relative  'docgenerator/css'
+require_relative  'docgenerator/templates/docgenerator_template_css'
+require_relative  'docgenerator/attribute'
+require_relative  'docgenerator/document'
 #~ require_relative 'docgenerator/document'
 
-require 'docgenerator/elements'
-require 'docgenerator/environments'
-require 'docgenerator/lists'		#define environment
-require 'docgenerator/sections'
-require 'docgenerator/tabular'
-require 'docgenerator/footnote'
-require 'docgenerator/index'  #makeindex, index, printindex...
-require 'docgenerator/characters'	#special characters (spaces, euro-sign...)
+require_relative  'docgenerator/elements'
+require_relative  'docgenerator/environments'
+require_relative  'docgenerator/lists'		#define environment
+require_relative  'docgenerator/sections'
+require_relative  'docgenerator/tabular'
+require_relative  'docgenerator/footnote'
+require_relative  'docgenerator/index'  #makeindex, index, printindex...
+require_relative  'docgenerator/characters'	#special characters (spaces, euro-sign...)
 #~ require_relative 'docgenerator/characters'	#special characters (spaces, euro-sign...)
 
 #quicktest

data/lib/docgenerator/characters.rb

@@ -802,6 +802,7 @@ Attributes are not defined for this element.
       add_html_output '–'
       add_latex_output '--'
       add_creole_output '–'
+      add_text_output '–' #or UTF-8: –
     end #--
 
 =begin rdoc

data/lib/docgenerator/css.rb

@@ -133,6 +133,11 @@ This values can be used inline (style-Attribute) and inside style>-Tags
         #Generell settings
       #~ ['bottom', 'top', 'middle', 'baseline'],
       }
+      #Check if a key is valid.
+      def supports?(key)
+        return @@values[key]
+      end
+      
       def initialize( values ={} )
         @values	= {}
         #~ set_option_defaults(values) #guarantee :log

data/lib/docgenerator/document.rb

@@ -64,7 +64,7 @@ The templates refer to the corresponding TeX-classes.
       #Set template defaults
       @template  = {
         :html    => DocumentTemplate[:html],
-        :latex  => DocumentTemplate[:article],
+        :latex  => DocumentTemplate[:article_utf8],
         :text    => DocumentTemplate[:text],
         :wiki    => DocumentTemplate[:wiki],
       }
@@ -519,8 +519,11 @@ If the method is called directly to prepare document snipplets, you can use:
                   )
 
 =end
-    def to_doc( target, options )
+    def to_doc( target, options = {} )
       #~ o = set_option_defaults(options)
+      options[:template] ||= @template[target]
+      options[:log] ||= @log
+      
       options[:log].info( "Build document for #{target.inspect}" ) if options[:log].info?
 
       #check target
@@ -672,6 +675,8 @@ Usage:
         out.gsub!( /&/, '\\\\&')
         out.gsub!( /_/, '\_')
         out.gsub!( /#/, '\#')
+        #~ out.gsub!( /\^/, '\(\wedge\)')
+        out.gsub!( /\^/, '\textasciicircum{}')
         #~ out.gsub!( /€/, '\euro ')  #regexp is in utf-8 -- may make problems.
         return out
       end

data/lib/docgenerator/element.rb

@@ -86,7 +86,7 @@ In Elementto_doc you can give another logger!
         elsif @attr_alias[k]
           @attr_alias[k] << v
         else
-          @log.warn("Usage of unknown attribute '#{k}' in #{self.inspect}") if @log.warn?
+          @log.warn("Usage of unknown attribute '#{k}' in #{self.inspect} (Available: #{@attr.keys})") if @log.warn?
           #~ @log.debug(caller) if @log.debug?
         end
       }
@@ -554,7 +554,7 @@ def element( name, attr = {}, content = nil )
 	elementclass = Docgenerator::Element.get( name )
 	if ! elementclass #Create a dummy element.
 		#~ element = Docgenerator::Element.create( name, {}, true  ).new(attr, content )
-		Docgenerator::DOCGENERATOR_LOGGER.error( "Usage of undefined element #{name}. Create an anonymous class")
+		Docgenerator::DOCGENERATOR_LOGGER.error( "Usage of undefined element #{name.inspect}. Create an anonymous class")
 		elementclass = Class.new(Docgenerator::Element)
     elementclass.add_id name
 	end

data/lib/docgenerator/elements.rb

@@ -278,7 +278,7 @@ For LaTeX \tableofcontents is created, with attribute :as_list you can create a
     class Tableofcontents < Element
       
       add_attributes HTML_ATTR_ALL
-      add_attribute :level      , Attribute.create( [ :html, :latex ], [Fixnum], 1 )
+      add_attribute :level      , Attribute.create( [ :html, :latex ], [Integer], 1 )
       add_attribute :pre        , Attribute.create( [ :html, :latex ], nil, 2 )
       add_attribute :post      , Attribute.create( [ :html, :latex ], nil, 2 )
       add_attribute :as_list  , Attribute.create( [ :latex ], [true, false], 2 )
@@ -801,6 +801,53 @@ Attributes may be:
       add_wiki_output '#{linebreak(@crbefore)}[[??#{@attr[:name]}]]#{@content}#{linebreak(@crafter)}'
     end #Label
 
+=begin rdoc
+Define Element :pageref
+
+Create an instance with
+  element( :pageref, [ attributes, [content]] )
+or
+  Pageref.new( [ attributes, [content]] )
+  
+Attributes may be:
+* HTML_ATTR_CORE
+* HTML_ATTR_I18N
+* HTML_ATTR_EVENTS
+* ATTR_LANG
+=end
+    class Pageref < Element
+      add_attributes HTML_ATTR_CORE
+      add_attributes HTML_ATTR_I18N
+      add_attributes HTML_ATTR_EVENTS
+      add_html_output '#{linebreak(@crbefore)}<a name="#{@content}">#{linebreak(@crmid)}&Rightarrow;</a>#{linebreak(@crafter)}'
+      add_latex_output '#{linebreak(@crbefore)}\pageref{#{@content}}#{linebreak(@crmid)}#{linebreak(@crafter)}'
+      #~ add_text_output '(#{@content}) #{@content}'
+      #~ add_wiki_output '#{linebreak(@crbefore)}[[??#{@content}]]#{@content}#{linebreak(@crafter)}'
+    end #pageref
+=begin rdoc
+Define Element :ref
+
+Create an instance with
+  element( :ref, [ attributes, [content]] )
+or
+  Ref.new( [ attributes, [content]] )
+  
+Attributes may be:
+* HTML_ATTR_CORE
+* HTML_ATTR_I18N
+* HTML_ATTR_EVENTS
+* ATTR_LANG
+=end    
+    class Ref < Element
+      add_attributes HTML_ATTR_CORE
+      add_attributes HTML_ATTR_I18N
+      add_attributes HTML_ATTR_EVENTS
+      add_html_output '#{linebreak(@crbefore)}<a name="#{@content}">#{linebreak(@crmid)}&Rightarrow;</a>#{linebreak(@crafter)}'
+      add_latex_output '#{linebreak(@crbefore)}\ref{#{@content}}#{linebreak(@crmid)}#{linebreak(@crafter)}'
+      #~ add_text_output '(#{@content}) #{@content}'
+      #~ add_wiki_output '#{linebreak(@crbefore)}[[??#{@content}]]#{@content}#{linebreak(@crafter)}'
+    end #ref
+
 =begin rdoc
 Define Element :hypertarget
 
@@ -933,7 +980,7 @@ Attributes may be:
 * :size: 
 =end
     class Font < Element
-      add_attribute :size, Attribute.create([:html], [ Fixnum ])
+      add_attribute :size, Attribute.create([:html], [ Integer ])
       add_html_tag 'font'
     end #Font
 
@@ -1102,6 +1149,26 @@ Attributes are not defined for this element.
       add_text_output '#{linebreak(@crbefore)}#{@content}#{linebreak(@crafter)}'
     end #Emph
 
+=begin rdoc
+Define Element :textsc
+
+Create an instance with
+  element( :textsc, [ attributes, [content]] )
+or
+  textsc.new( [ attributes, [content]] )
+Attributes are not defined for this element.
+=end
+    class Textsc < Element
+      add_id :textsc
+      add_latex_output '#{linebreak(@crbefore)}\textsc{#{@content}}#{linebreak(@crafter)}'
+      add_html_output '#{linebreak(@crbefore)}<span style="font-variant-caps: small-caps">#{@content}</span>#{linebreak(@crafter)}'
+      add_wiki_output '#{linebreak(@crbefore)}'''#{@content}'''#{linebreak(@crafter)}'
+      #The additional space is wanted (else ** may be a itemize-list)
+      add_creole_output '#{linebreak(@crbefore)} **#{@content}**#{linebreak(@crafter)}'
+      add_text_output '#{linebreak(@crbefore)}#{@content}#{linebreak(@crafter)}'
+    end #textsc
+
+
 =begin rdoc
 Define Element :stroke
 

data/lib/docgenerator/index.rb

@@ -75,7 +75,7 @@ Attributes are not defined for this element.
             else
               cmd << "[#{@attr[:subindex]}]"
           end
-          cmd = linebreak(@crafter)
+          cmd << linebreak(@crafter)
           cmd
         end
         

data/lib/docgenerator/packages/listings.rb

@@ -1,33 +1,35 @@
+#encoding: utf-8 
+
+#
 module Docgenerator
-module Listings
-LSTSETTINGS = 	{
-		:language	=> Attribute.create( [ :texkeyval] ),
-		:style		=> Attribute.create( [ :texkeyval] ),
-		:basicstyle	=> Attribute.create( [ :texkeyval] ),
-		:emph	=> Attribute.create( [ :texkeyval] ),
-		:emphstyle	=> Attribute.create( [ :texkeyval] ),
-		:keywordstyle	=> Attribute.create( [ :texkeyval] ),
-		:commentstyle	=> Attribute.create( [ :texkeyval] ),
-		:style	=> Attribute.create( [ :texkeyval] ),
-		:breaklines	=> Attribute.create( [ :texkeyval], ['true', 'false'] ),
-		:mathescape	=> Attribute.create( [ :texkeyval], ['true', 'false'] ),
-		:prebreak	=> Attribute.create( [ :texkeyval] ),
-		:postbreak	=> Attribute.create( [ :texkeyval] ),
-		:tabsize	=> Attribute.create( [ :texkeyval], [ Integer ] ),
-		:firstline	=> Attribute.create( [ :texkeyval], [ Integer ] ),
-		:lastline	=> Attribute.create( [ :texkeyval], [ Integer ] ),
-#~ showspaces=true,
-#~ showtabs=true,
-#~ tab=\rightarrowfill}		
-		:numbers		=> Attribute.create( [ :texkeyval], [ 'none', 'left', 'right' ] ),
-		:numberstyle	=> Attribute.create( [ :texkeyval] ),
-		:firstnumber	=> Attribute.create( [ :texkeyval], [ Integer ] ),
-		:stepnumber	=> Attribute.create( [ :texkeyval], [ Integer ] ),
-		:numbersep		=> Attribute.create( [ :texkeyval], [ Integer ] ),
-		#
-		:morekeywords	=> Attribute.create( [ :texkeyval], [ String ] ),
-		:morecomment	=> Attribute.create( [ :texkeyval], [ String ] ),
-	}
+  module Listings
+    LSTSETTINGS = 	{
+        :language	=> Attribute.create( [ :texkeyval] ),
+        :style		=> Attribute.create( [ :texkeyval] ),
+        :basicstyle	=> Attribute.create( [ :texkeyval] ),
+        :emph	=> Attribute.create( [ :texkeyval] ),
+        :emphstyle	=> Attribute.create( [ :texkeyval] ),
+        :keywordstyle	=> Attribute.create( [ :texkeyval] ),
+        :commentstyle	=> Attribute.create( [ :texkeyval] ),
+        :breaklines	=> Attribute.create( [ :texkeyval], ['true', 'false'] ),
+        :mathescape	=> Attribute.create( [ :texkeyval], ['true', 'false'] ),
+        :prebreak	=> Attribute.create( [ :texkeyval] ),
+        :postbreak	=> Attribute.create( [ :texkeyval] ),
+        :tabsize	=> Attribute.create( [ :texkeyval], [ Integer ] ),
+        :firstline	=> Attribute.create( [ :texkeyval], [ Integer ] ),
+        :lastline	=> Attribute.create( [ :texkeyval], [ Integer ] ),
+    #~ showspaces=true,
+    #~ showtabs=true,
+    #~ tab=\rightarrowfill}		
+        :numbers		=> Attribute.create( [ :texkeyval], [ 'none', 'left', 'right' ] ),
+        :numberstyle	=> Attribute.create( [ :texkeyval] ),
+        :firstnumber	=> Attribute.create( [ :texkeyval], [ Integer ] ),
+        :stepnumber	=> Attribute.create( [ :texkeyval], [ Integer ] ),
+        :numbersep		=> Attribute.create( [ :texkeyval], [ Integer ] ),
+        #
+        :morekeywords	=> Attribute.create( [ :texkeyval], [ String ] ),
+        :morecomment	=> Attribute.create( [ :texkeyval], [ String ] ),
+      }
 
 
 =begin rdoc
@@ -39,9 +41,9 @@ or
   Lstlistoflistings.new( [ attributes, [content]] )
 Attributes are not defined for this element.
 =end
-class Lstlistoflistings < Element
-  has_no_content false
-end #Lstlistoflistings
+    class Lstlistoflistings < Element
+      has_no_content false
+    end #Lstlistoflistings
 
 
 =begin rdoc
@@ -53,10 +55,10 @@ or
   Lstloadlanguages.new( [ attributes, [content]] )
 Attributes are not defined for this element.
 =end
-class Lstloadlanguages < Element
-  add_latex_output '#{linebreak(@crbefore)}\lstloadlanguages{#{@content}}#{linebreak(@crafter)}'
-  add_html_output ''
-end #Lstloadlanguages
+    class Lstloadlanguages < Element
+      add_latex_output '#{linebreak(@crbefore)}\lstloadlanguages{#{@content}}#{linebreak(@crafter)}'
+      add_html_output ''
+    end #Lstloadlanguages
 
 =begin rdoc
 Define Element :lstset
@@ -68,12 +70,12 @@ or
 Attributes may be:
 * LSTSETTINGS
 =end
-class Lstset < Element
-  has_no_content false
-  add_attributes LSTSETTINGS
-  add_latex_output '#{linebreak(@crbefore)}\lstset{#{texkeyval()}}#{linebreak(@crafter)}'
-  add_html_output ''
-end #Lstset
+    class Lstset < Element
+      has_no_content false
+      add_attributes LSTSETTINGS
+      add_latex_output '#{linebreak(@crbefore)}\lstset{#{texkeyval()}}#{linebreak(@crafter)}'
+      add_html_output ''
+    end #Lstset
 
 =begin rdoc
 Define Element :lstdefinestyle
@@ -85,10 +87,10 @@ or
 Attributes may be:
 * LSTSETTINGS
 =end
-class Lstdefinestyle < Element
-  add_attributes LSTSETTINGS
-  add_latex_output '#{linebreak(@crbefore)}\lstdefinestyle{#{@content}}{#{texkeyval()}}#{linebreak(@crafter)}'
-end #Lstdefinestyle
+    class Lstdefinestyle < Element
+      add_attributes LSTSETTINGS
+      add_latex_output '#{linebreak(@crbefore)}\lstdefinestyle{#{@content}}{#{texkeyval()}}#{linebreak(@crafter)}'
+    end #Lstdefinestyle
 =begin rdoc
 Define Element :lstinputlisting
 
@@ -99,18 +101,16 @@ or
 Attributes may be:
 * 
 =end
-class Lstinputlisting < Element
-  add_attributes LSTSETTINGS
-  add_attributes HTML_ATTR_CORE
-  add_attributes HTML_ATTR_I18N
-  add_attributes HTML_ATTR_EVENTS
-  add_attribute :lang, ATTR_LANG
-  add_attribute :caption, Attribute.create( [ :texkeyval], nil, 1 )
-  add_html_tag 'pre'
-  add_latex_output '#{linebreak(@crbefore)}\lstinputlisting[#{texkeyval()}]{#{@content}}#{linebreak(@crafter)}'
-end #Lstinputlisting
-
-#~ lstlisting
+    class Lstinputlisting < Element
+      add_attributes LSTSETTINGS
+      add_attributes HTML_ATTR_CORE
+      add_attributes HTML_ATTR_I18N
+      add_attributes HTML_ATTR_EVENTS
+      add_attribute :lang, ATTR_LANG
+      add_attribute :caption, Attribute.create( [ :texkeyval], nil, 1 )
+      add_html_tag 'pre'
+      add_latex_output '#{linebreak(@crbefore)}\lstinputlisting[#{texkeyval()}]{#{@content}}#{linebreak(@crafter)}'
+    end #Lstinputlisting
 
 =begin rdoc
 Define Element :lstinline
@@ -121,30 +121,30 @@ or
   Lstinline.new( [ attributes, [content]] )
 Attributes are not defined for this element.
 =end
-class Lstinline < Element
-	add_attributes HTML_ATTR_ALL
-	add_attributes LSTSETTINGS
-	add_attribute :caption, Attribute.create( [ :latex ], nil, 1 )
-  add_html_tag 'pre'
-	#Redefine standard output. 
-	#Options are given, if an option is avalaible.
-	def to_latex(  options={}  )
-    o = set_option_defaults(options)    
-		if ! @content.include?( '!' );	sep = '!'
-		elsif ! @content.include?( '?' );	sep = '?'
-		else
-			o[:log].warn("lstinline: found no sep. for #{content}") if o[:log].warn?
-		end
-		cmd = linebreak(@crbefore)
-		cmd << '\lstinline'
-		cmd << "[#{texkeyval()}]"
-		cmd << sep
-		cmd << "#{@content.to_latex( options)}"
-		cmd << sep
-		cmd << linebreak(@crafter)
-		return cmd
-	end
-end
+    class Lstinline < Element
+      add_attributes HTML_ATTR_ALL
+      add_attributes LSTSETTINGS
+      add_attribute :caption, Attribute.create( [ :latex ], nil, 1 )
+      add_html_tag 'pre'
+      #Redefine standard output. 
+      #Options are given, if an option is avalaible.
+      def to_latex(  options={}  )
+        o = set_option_defaults(options)    
+        if ! @content.include?( '!' );	sep = '!'
+        elsif ! @content.include?( '?' );	sep = '?'
+        else
+          o[:log].warn("lstinline: found no sep. for #{content}") if o[:log].warn?
+        end
+        cmd = linebreak(@crbefore)
+        cmd << '\lstinline'
+        cmd << "[#{texkeyval()}]"
+        cmd << sep
+        cmd << "#{@content.to_latex( options)}"
+        cmd << sep
+        cmd << linebreak(@crafter)
+        return cmd
+      end
+    end
 
 =begin rdoc
 Define Environment :lstlisting
@@ -155,23 +155,23 @@ or
   Lstlisting.new( [ attributes, [content]] )
 Attributes are not defined for this element.
 =end
-class Lstlisting < Environments::Environment
-	add_attributes HTML_ATTR_ALL 
-	add_attributes LSTSETTINGS
-	add_attribute :options, Attribute.create( [ :texkeyval], nil, 1 )
+    class Lstlisting < Environments::Environment
+      add_attributes HTML_ATTR_ALL 
+      add_attributes LSTSETTINGS
+      add_attribute :options, Attribute.create( [ :texkeyval], nil, 1 )
 
-	add_html_tag 'pre'
+      add_html_tag 'pre'
 =begin rdoc  
 Redefine standard output. 
 Options are given, if an option is avalaible.
 =end
-	def to_latex( options={} )
-		option	= "[#{texkeyval()}]"
-		option	= nil if option == '[]'
-		return to_latex_environment( 'lstlisting', option,  options )
-	end
-end
-end #module Listings
+      def to_latex( options={} )
+        option	= "[#{texkeyval()}]"
+        option	= nil if option == '[]'
+        return to_latex_environment( 'lstlisting', option,  options )
+      end
+    end
+  end #module Listings
 end #module Docgenerator
 __END__
 doc.head	<< element(:usepackage,{ }, 'listings').cr