docgenerator 1.1.1 → 1.2.1

data/lib/docgenerator.rb

@@ -1,69 +1,155 @@
-#Generic methods to create documents.
-#The target format is generic, supported are LaTeX and HTML.
-#Plain text and a Wiki-version exist also, but they are not well maintained.
-#
-#
-#==Wiki
-#Docgenerator is also the base for two Wiki-analyser.
-#Both parse a wiki-source and build a docgenerator tree.
-#In combination, you get a wiki to html and wiki to LaTeX converter.
-#
-#Details see
-#- Creole (Creole-syntax)
-#- Wikitext (Wikimedia-syntax, no longer supported.)
-#
-#==Elements
-#A document is structured by Element.
-#Each element contains attributes/parameters and content. 
-#(Think of HTML-attributes and TeX-Parameters and the content of HTML-Tags and TeX-Environments.).
-#
-#Each element corresponds to a HTML-Tag or a LaTeX-Makro/Environment.
-#There is a "translation" between HTML and LaTeX elements.
-#
-#Elements are defined by Element.get (or the method element() ), 
-#new element types can be defined with Element.create() ).
-#
-#Some elements (in fact, most of them) are generated dynamic,
-#so they will not occur in this generated documentation).
-#
-#===	Examples
-#A document with a paragraph:
-# doc = Document.new
-# doc.body << element(:p,{}, 'Content')
-# doc.save( 'test.tex', true)
-# doc.save( 'test.html', true)
-#
-#A document with a (unnumbered) list:
-# doc = Document.new
-# doc.body << ul = element(:ul)
-# ul << element(:li,{}, 'List content 1')
-# ul << element(:li,{}, 'List content 2')
-# doc.save( 'test.tex', true)
-# doc.save( 'test.html', true)
-#
-#See the unit tests and the examples-folder of the docgenerator distribution for more examples.
-#
-#
-#== Known problems
-#This program is developed under Windows.
-#I expect encoding problems on other systems
-#(It's not a problem of the program, but a test problem on my side).
+=begin rdoc
+= NAME
+Docgenerator
+
+= SYNOPSIS
+Docgenerator provides a ruby interface to build documents.
+
+= DESCRIPTION
+The document generation is build via 'Elements', 
+the target format is generic, actual supported are:
+-LaTeX 
+-HTML
+Plain text and a Wiki-version exist also, but they are not well maintained,
+a context-export is planned for the future (but it has a low level-importance for me).
+
+
+==Wiki
+Docgenerator is also the base for two Wiki-analyser.
+Both parse a wiki-source and build a docgenerator tree.
+In combination, you get a wiki to html and wiki to LaTeX converter.
+
+Details see
+* Creole (Creole-syntax)
+* Wikitext (Wikimedia-syntax, no longer supported.)
+
+==Elements
+A document is structured by Element.
+Each element contains attributes/parameters and content. 
+(Think of HTML-attributes and TeX-Parameters and the content of HTML-Tags and TeX-Environments.).
+
+Each element corresponds to a HTML-Tag or a LaTeX-Makro/Environment.
+There is a "translation" between HTML and LaTeX elements.
+
+Elements are defined by Element.get (or the method element() ), 
+new element types can be defined with Element.create() ).
+
+Some elements (in fact, most of them) are generated dynamic,
+so they will not occur in this generated documentation).
+
+===	Examples
+A document with a paragraph:
+ doc = Document.new
+ doc.body << element(:p,{}, 'Content')
+ doc.save( 'test.tex', true)
+ doc.save( 'test.html', true)
+
+A document with a (unnumbered) list:
+ doc = Document.new
+ doc.body << ul = element(:ul)
+ ul << element(:li,{}, 'List content 1')
+ ul << element(:li,{}, 'List content 2')
+ doc.save( 'test.tex', true)
+ doc.save( 'test.html', true)
+
+See the unit tests and the examples-folder of the docgenerator distribution for more examples.
+
+
+== Known problems
+This program is developed under Windows.
+I expect encoding problems on other systems
+(It's not a problem of the program, but a test problem on my side).
+
+HTML-Versions are not supported properly 
+(main problem: End-Tag for br)
+
+More at http://ruby.lickert.net/docgenerator/index.html
+=end
+
 #
-#HTML-Versions are not supported properly 
-#(main problem: End-Tag for br)
+#For quick test
 #
-#More at http://ruby.lickert.net/docgenerator/index.html
-
-#Version information.
-begin
-  if Gem.loaded_specs['docgenerator']
-    DOCGENERATOR_VERSION = Gem.loaded_specs['docgenerator'].version
-  else
-    DOCGENERATOR_VERSION = "#{File.expand_path('docgenerator')} (no Gem)"
-  end
-rescue  NameError #No gems?
-    DOCGENERATOR_VERSION = "#{File.expand_path('docgenerator')} (no Gem)"
+if $0 == __FILE__ and RUBY_VERSION == '1.9.1'
+  $:.unshift('./')
 end
+
+
+
+=begin rdoc
+Just a dummy for the version.
+This module should be included by all classes.
+=end
+module Docgenerator   
+  #Define Version number  
+  VERSION = '1.2.1'
+end #Docgenerator
+
+
+=begin rdoc
+Small include-module to define a to_doc-distributor
+
+If you include this, please redefine to_latex, to_html.... else you get a endless loop.
+=end
+module Docgenerator_to_doc
+=begin rdoc
+to_doc returns the object as a string.
+=end
+  def to_doc(target, options = {})
+    o = Docgenerator_logger.set_option_defaults(options)
+    str = ""
+    case target
+      when :latex
+        str = self.to_latex(options)
+      when :html
+        str = self.to_html(options)
+      when :context
+        str = self.to_context(options)
+      when :wiki
+        str = self.to_wiki(options)
+      when :creole
+        str = self.to_creole(options)
+      else; 
+        o[:log].error( "Unknown target #{target.inspect} for #{self.class}") if o[:log].error?
+        str = self.to_doc_str()
+    end #case target
+    str
+  end
+=begin rdoc
+The following code must be redefinded
+=end
+  def to_text(options = {})
+    o = Docgenerator_logger.set_option_defaults(options)
+    o[:log].fatal( "Please redefine to_text in #{self.class}") if o[:log].fatal?
+    self.respond_to?(:to_str) ? self.to_str : self.to_s    
+  end
+  def to_latex(options = {})
+    o = Docgenerator_logger.set_option_defaults(options)
+    o[:log].fatal( "Please redefine to_text in #{self.class}") if o[:log].fatal?
+    self.respond_to?(:to_str) ? self.to_str : self.to_s    
+  end
+  def to_context(options = {})
+    o = Docgenerator_logger.set_option_defaults(options)
+    o[:log].fatal( "Please redefine to_text in #{self.class}") if o[:log].fatal?
+    self.respond_to?(:to_str) ? self.to_str : self.to_s    
+  end
+  def to_html(options = {})
+    o = Docgenerator_logger.set_option_defaults(options)
+    o[:log].fatal( "Please redefine to_text in #{self.class}") if o[:log].fatal?
+    self.respond_to?(:to_str) ? self.to_str : self.to_s    
+  end
+  def to_wiki(options = {})
+    o = Docgenerator_logger.set_option_defaults(options)
+    o[:log].fatal( "Please redefine to_text in #{self.class}") if o[:log].fatal?
+    self.respond_to?(:to_str) ? self.to_str : self.to_s    
+  end
+  def to_creole(options = {})
+    o = Docgenerator_logger.set_option_defaults(options)
+    o[:log].fatal( "Please redefine to_text in #{self.class}") if o[:log].fatal?
+    self.respond_to?(:to_str) ? self.to_str : self.to_s    
+  end
+end #Docgenerator_to_doc
+
+
 require 'log4r'
 require 'yaml'  #needed by docgenerator_template.rb
 
@@ -78,44 +164,44 @@ require 'yaml'  #needed by docgenerator_template.rb
 ENDTAG	= false	if ! defined?( ENDTAG )
 
 
+=begin rdoc
+The docgenerator own log-formatter.
 
-#The docgenetor own log-formatter.
-#
-#Reason:
-#docgenerator throws logging information.
-#The trace would inform, where the problems come from (a docgenerator-tool)
-#but normally the problems are document problems,
-#so we need the first step outside the docgenerator-path
+Reason:
+docgenerator throws logging information.
+The trace would inform, where the problems come from (a docgenerator-tool)
+but normally the problems are document problems,
+so we need the first step outside the docgenerator-path
+=end
 class LogFormatter < Log4r::BasicFormatter
-    #Use another format for the logger.
-    #
-    #Based on BasicFormatter. 
-    #When used with trace on, return the location from docgenerator and the first non-docgenerator position.
-    def format(event)
-      buff = sprintf(@@basicformat, Log4r::MaxLevelLength, Log4r::LNAMES[event.level],
-             event.name)
-      mytrace = []
-      #~ buff += (event.tracer.nil? ? "" : "(#{event.tracer[0]})") + ": "
-      if event.tracer.nil?
-      else
-        event.tracer.each{|trace|
-          if trace !~ /lib\/docgenerator/
-            mytrace << trace
-            break
-          end          
-        }
-        mytrace << event.tracer[0]
-      end
-      buff += ": "
-      buff += format_object(event.data) 
-      #~ buff += (event.tracer.nil? ? "" : " (#{event.tracer.join('/')})")
-      buff += (event.tracer.nil? ? "" : " (#{mytrace.join('|')})")
-      buff += "\n"
-      buff
+  #Use another format for the logger.
+  #
+  #Based on BasicFormatter. 
+  #When used with trace on, return the location from docgenerator and the first non-docgenerator position.
+  def format(event)
+    buff = sprintf(@@basicformat, Log4r::MaxLevelLength, Log4r::LNAMES[event.level],
+           event.name)
+    mytrace = []
+    #~ buff += (event.tracer.nil? ? "" : "(#{event.tracer[0]})") + ": "
+    if event.tracer.nil?
+    else
+      event.tracer.each{|trace|
+        if trace !~ /lib\/docgenerator/
+          mytrace << trace
+          break
+        end          
+      }
+      mytrace << event.tracer[0]
     end
+    buff += ": "
+    buff += format_object(event.data) 
+    #~ buff += (event.tracer.nil? ? "" : " (#{event.tracer.join('/')})")
+    buff += (event.tracer.nil? ? "" : " (#{mytrace.join('|')})")
+    buff += "\n"
+    buff
   end
+end #LogFormatter
 
-  
 #Default Logger
 DOCGENERATOR_LOGGER = Log4r::Logger.new( 'docgenerator')
 DOCGENERATOR_LOGGER.level = Log4r::FATAL
@@ -124,19 +210,20 @@ DOCGENERATOR_LOGGER.outputters = Log4r::StdoutOutputter.new('log_stdout',
         )
 
 
-#
-#A 'global' parameter setting
-#
-#For usage of
-#    o = Docgenerator_logger.set_option_defaults(options)
-#    o[:log].debug("Enter ...") if o[:log].debug?
+=begin rdoc
+A 'global' parameter setting
+
+For usage of
+    o = Docgenerator_logger.set_option_defaults(options)
+    o[:log].debug("Enter ...") if o[:log].debug?
+=end
 module Docgenerator_logger
   #Each to_doc, to_html, to_latex, to_wiki, to_text has an option-parameter.
   #This option-hash should contain at least a :log-value. 
   #This method completes the option hash with a default logger if no logger is given.
   def self.set_option_defaults(options)
     return {
-        :log  => DOCGENERATOR_LOGGER
+        :log  => DOCGENERATOR_LOGGER,
         #Added from Document:
         # :document   useable for documentation
         # :filename   useable for documentation
@@ -147,11 +234,13 @@ module Docgenerator_logger
       }.update(options)
   end
 end
-require 'docgenerator_element'
+require 'docgenerator/standard'
+require 'docgenerator/element'
 
-#Returns an element of a type "name".
-#Attributes and content are optional parameter.
-#
+=begin rdoc
+Returns an element of a type "name".
+Attributes and content are optional parameter.
+=end
 def element( name, attr = {}, content = nil )
 	element = Element.get( name )
 	if element
@@ -164,18 +253,20 @@ def element( name, attr = {}, content = nil )
 end
 
 require 'templates/docgenerator_template'
-require 'docgenerator_css'
+require 'docgenerator/css'
 require 'templates/docgenerator_template_css'
-require 'docgenerator_attribute'
-require 'docgenerator_document'
-
-require 'docgenerator_elements'
-require 'docgenerator_environments'
-require 'docgenerator_lists'		#define environment
-require 'docgenerator_sections'
-require 'docgenerator_tabular'
-require 'docgenerator_footnote'
-require 'docgenerator_characters'	#special characters (spaces, euro-sign...)
+require 'docgenerator/attribute'
+require '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/characters'	#special characters (spaces, euro-sign...)
+#~ require_relative 'docgenerator/characters'	#special characters (spaces, euro-sign...)
 
 __END__
 class Test

data/lib/{docgenerator_attribute.rb → docgenerator/attribute.rb}

@@ -127,7 +127,8 @@ class Attribute
 	#Return the content.
 	def to_s()
 	#~ def to_s( target = Document.target( self ) )
-		@attr_content.to_s()
+		#~ @attr_content.to_s() #Ruby 1.8
+		@attr_content.join()  #Ruby 1.9
 	end
 	def inspect()
 		return "<#Attribute #{@name} #{@attr_content.inspect} (in #{@element.ids}) >"

data/lib/{docgenerator_characters.rb → docgenerator/characters.rb}

@@ -1,3 +1,5 @@
+# encoding: utf-8
+
 #Some Coding to prepare the unit tests
 #~ els = nil
 #~ DATA.each{|line|
@@ -16,6 +18,12 @@
 #
 # Special Characters
 #
+Element.create( [:shy ], {},false, 
+	{	:html => '­',
+		:latex	=> '"-', #only with babel/ngerman
+		:text	=> '', 
+		:creole	=> '{{shy}}',
+	} )
 Element.create( [:space, :ensp], {},false, 
 	{	:html => ' ',
 		:latex	=> '~'
@@ -43,7 +51,10 @@ Element.create( [:percent, :'%'], {},false,
 
 Element.create( [:dollar, :'$'], {},false, 
 	{	:html => '$',
-		:latex	=> '\$'
+		:latex	=> '\$',
+		:creole	=> '$',
+		:wiki	=> '$',
+		:text	=> '$',
 	} )
 
 Element.create( [:'^'], {},false, 
@@ -51,15 +62,19 @@ Element.create( [:'^'], {},false,
 		:latex	=> '\hat{}'
 	} )
 	
-Element.create( [:iquest ], {},false, #�	umgekehrtes Fragezeichen
+Element.create( [:iquest ], {},false, #¿ umgekehrtes Fragezeichen
 	{	:html => '¿',
-		:latex	=> '�'	#?`
+		:latex	=> '¿',	#?`
+		:creole	=> '¿',
+		:wiki	=> '¿',
+		:text	=> '¿',
 	} )
 
 
 Element.create( [:ampersand, :'&'], {},false, 
 	{	:html => '&',
-		:latex	=> '\&'
+		:latex	=> '\&',
+		:text	=> '&',
 	} )
 
 Element.create( [:rbrace, :'}'], {},false, 
@@ -109,6 +124,22 @@ Element.create( [:uArr, :Uparrow ], {},false,
 		:latex	=> '\ensuremath{\Uparrow}'
 	} )
 
+Element.create( [:uarr, :uparrow ], {},false, 
+	{	:html => '↑',
+		:latex	=> '\ensuremath{\uparrow}'
+	} )
+  
+Element.create( [:dArr, :Downarrow ], {},false, 
+	{	:html => '⇓',
+		:latex	=> '\ensuremath{\Downarrow}'
+	} )
+
+Element.create( [:darr, :downarrow ], {},false, 
+	{	:html => '↓',
+		:latex	=> '\ensuremath{\downarrow}'
+	} )
+  
+  
 Element.create( [:lt, :'<'], {},false, 
 	{	:html => '&lt;',
 		:latex	=> '\ensuremath{<}'
@@ -189,7 +220,7 @@ Element.create( [:bullet], {},false,
 Element.create( [:'--', :ndash], {},false, 
 	{	:html => '&ndash;',	#'&#8211;'
 		#:html => '&#150;',
-		:latex	=> '--'
+		:latex	=> '--',
 	} )
 Element.create( [:'---', :mdash], {},false, 
 	{	:html => '&mdash;',	#'&#8212;'
@@ -199,4 +230,42 @@ Element.create( [:'---', :mdash], {},false,
 Element.create( [:dagger], {},false, 
 	{	:html => '&dagger;',
 		:latex	=> '\dag'
-	} )
+	} )
+
+#See http://www.cs.sfu.ca/~ggbaker/reference/characters/#double
+Element.create( [:bdquo], {},false, 
+	{	:html => '&bdquo;',
+		:latex	=> '"',
+		:creole	=> '{{bdquo}}',
+	} )
+ Element.create( [:ldquo], {},false, 
+	{	:html => '&ldquo;',
+		:latex	=> '``',
+		:text	=> '``',
+		:creole	=> '{{ldquo}}',
+	} ) 
+Element.create( [:rdquo], {},false, 
+	{	:html => '&rdquo;',
+		:latex	=> "''",
+		:text	=> "''",
+		:creole	=> '{{rdquo}}',
+	} ) 
+  
+#einfaches low-9-Zeichen
+Element.create( [:sbquo], {},false, 
+	{	:html => '&sbquo;',
+		#~ :latex	=> '‚', #‚ -> kein Komma ,
+		:creole	=> '{{sbquo}}',
+	} )
+Element.create( [:lsquo], {},false, 
+	{	:html => '&lsquo;',
+		:latex	=> '`',
+		:text	=> '`',
+		:creole	=> '{{lsquo}}',
+	} ) 
+Element.create( [:rsquo], {},false, 
+	{	:html => '&rsquo;',
+		:latex	=> "’",
+		:text	=> "’",
+		:creole	=> '{{rsquo}}',
+	} )