docgenerator 0.1.1

data/docgenerator.rb

@@ -0,0 +1,137 @@
+#Generic methods to create documents.
+#The target format ia generic, supported are LaTeX and HTML.
+#
+#==Elements
+#A document is structured by elements.
+#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 qill not occur in this generated documentation).
+#==	Examples
+#See the file Example_DocGenerator.rb
+#
+#
+#==	Open topics
+#-	control content
+#	(Tag br in HTML klappt).
+#-	Wiki-Output
+#-	ASCII-Output
+
+
+#How to handle the End-Tag for br/hr...
+#-false:	set <br />	(XHTML)
+#-nil:	set <br>	(HTML)
+#~ Problem:
+#~ HTML darf keine Endtags haben, XHTML verlangt es.
+#~ Die Konstante ENDTAG macht es einstellbar.
+#~ Zu machen: Flag im Dokument ob HTML oder XHTML.
+#~ Aber woher weiss element in welches Dokument es geh�rt?
+#~ Gleiche Problem bei to_s, bzw. Document.target
+ENDTAG	= false	if ! defined?( ENDTAG )
+#filled in DocGeneratorTemplate.rb (or elsewhere)
+SUPPORTED_LaTeX_TEMPLATES	= []	if ! defined?( SUPPORTED_LaTeX_TEMPLATES	)
+SUPPORTED_HTML_TEMPLATES	= []	if ! defined?( SUPPORTED_HTML_TEMPLATES	)
+
+#
+#@target @@target hat noch bugs.
+#mit UNDER_CONSTRUCTION	= true kann der Testmodus 
+UNDER_CONSTRUCTION	= false	if ! defined?( UNDER_CONSTRUCTION )
+
+module Backlinks
+	def set_backlink( content)
+		#Prepare backword link
+		cl = [ content ].flatten	#content list
+		cl.each{|c|
+			if c.respond_to?( :part_of )
+				c.part_of << self
+			end
+			if c.respond_to?( :part_of_doc )
+				c.part_of_doc << self.part_of_doc
+				c.part_of_doc.flatten!
+				#fixme Hier auch attribute backlink setzen?
+				if c.part_of_doc.include?( nil )
+					raise "Add nil as document in #{self.inspect}"
+				end
+			end
+			#Log in case of error.
+			if	UNDER_CONSTRUCTION and
+				! ( c.respond_to?( :part_of ) or c.respond_to?( :part_of_doc ) ) and
+				! (c.is_a?(String) or c.is_a?(Fixnum) )
+				puts "set_backlink: Not supported by #{c.inspect} in #{self.inspect} (#{c.respond_to?( :part_of )}/#{c.respond_to?( :part_of_doc )})"
+			end
+			
+		}
+		return self
+	end
+	#List of elements, where this element is part of.
+	#Filled by << in the superior element.
+	#Normaly only one element
+	attr_reader :part_of
+	#List of documents, where this element is part of.
+	#Filled by << in the superior element.
+	#Normaly only one element
+	attr_reader :part_of_doc
+	#Return an array with all ancestors.
+	#contains pairs of: [ ancestor, [array of ancestors ancestors]]
+	def ancestors
+		anc = []
+		@part_of.each{|a|
+			anc << a
+			anc << a.ancestors if a.respond_to?(:ancestors)
+		}
+		return anc
+	end
+end
+require 'docgenerator_element'
+
+#Returns an element of a type "name".
+#Attributes and content are optional parameter.
+#
+def element( name, attr = {}, content = nil )
+	element = Element.get( name )
+	if element
+		element = element.new(attr, content ) if element
+	else
+		element = Element.create( name, {}, true  ).new(attr, content )
+		puts "Usage of undefined element #{name}"
+	end
+	return element
+end
+
+require 'docgenerator_template'
+require 'docgenerator_css'
+require 'docgenerator_attribute'
+require 'docgenerator_document'
+
+#~ require 'DocGenerator_HTML' if __FILE__ != 'DocGenerator_HTML' #and __FILE__ != $0
+#~ require 'DocGenerator_LaTeX' if __FILE__ != 'DocGenerator_LaTeX' #and __FILE__ != $0
+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...)
+
+__END__
+class Test
+	def required?(); true; end
+end
+test = Test.new()
+puts test.required?
+Test.class_eval('def required?(); false; end')
+puts test.required?
+
+testclass2 = Class.new( Test )
+test2 = testclass2.new()
+puts test2.required?
+testclass2.class_eval('def required?(); true; end')
+puts test2.required?
+puts test.required?

data/docgenerator_attribute.rb

@@ -0,0 +1,142 @@
+#Administrate attributes for elements.
+class Attribute
+	include Backlinks
+	@@settings	= {}
+	@@values		= {}
+	@@sortkey		= 99	#Just a counter to get identic positions between different program runs.
+	#Generic creation of a new class to define a new Atttribute.
+	#Settings is a hash with generell settings.
+	#Supported parameters:
+	#-	:required
+	#-	:content	adding values to this attribute add it to the content.
+	#-	:values	allowed values
+	#-	:html		used for html-output
+	#-	:latex		used for latex-output
+	#The sortkey is used for a sort-sequence of attributes.
+	def  Attribute.create( settings = [], values = nil, sortkey = (@@sortkey += 1 ) )
+		#First some checks
+		if ! settings.kind_of?( Array )
+			raise "Type error Attribute.create: Expected Array, get #{attr.class}"
+		end
+		#Generic class creation
+		attributeclass = Class.new( Attribute )
+		#Set the flags.
+		settings.each{|setting|
+			case setting
+			when :required
+				attributeclass.class_eval('def required?(); true; end')
+			when :content
+				attributeclass.class_eval('def content?();  true; end')
+			when :unique
+				attributeclass.class_eval('def unique?();  true; end')				
+			when :html
+				attributeclass.class_eval('def html?();  true; end')
+			when :latex
+				attributeclass.class_eval('def latex?();  true; end')
+			when :texkeyval
+				attributeclass.class_eval('def texkeyval?();  true; end')
+			when :text
+				attributeclass.class_eval('def text?();  true; end')
+			when :wiki
+				attributeclass.class_eval('def wiki?();  true; end')
+			else
+				puts "Attribute: Unknown setting <#{setting.inspect}>"
+			end
+		}
+		if values
+			attributeclass.class_eval("def allowed_values();  return #{values.inspect}; end")
+		end	
+		attributeclass.class_eval("def sortkey();  return #{sortkey}; end")
+		return attributeclass
+	end
+
+	#Each attribute is assigned to an element.
+	def initialize( name, element )
+		@name	= name
+		@element	= element
+		@attr_content	= []
+		@part_of		= [element]	#list of elements, where this element is part of (normaly only one element)
+		@part_of_doc	= []			#list of documents, where this element is part of (normaly only one document)
+		#@part_of_doc	= element.part_of_doc	May not work - is empty to generation time
+								
+	end
+	#Return class settings. Can be used for some checks.
+	def settings()
+		@@settings
+	end
+	#Check if the attribute is required.
+	#Redefined by Attribute.create and used in Element.to_s.
+	def required?();  false; end
+	#Check if the attribute can contain a "content".
+	#Redefined by Attribute.create.
+	def content?();  false; end
+	#Values may be added only once. 
+	def unique?();  false; end
+	#Sometimes the content of an attribute is needed directly.
+	def content();  @attr_content; end
+	#Check if content was added
+	def filled?();  return @attr_content.size > 0; end
+	#Attribut is used for HTML.
+	def html?();  false; end
+	#Attribut is used for Text.
+	def text?();  false; end
+	#Attribut is used for Wiki.
+	def wiki?();  false; end
+	#Attribute is used for latex.
+	#Only for informational reasons.
+	def latex?();  false; end
+	#Attribute is used as a keyval-option
+	def texkeyval?();  false; end
+	#Return all allowed values.
+	#Redefined by Attribute.create and used in Attributes.<<
+	#By default everything is allowed.	
+	#
+	#This method must return an Array with the allowed values or classes.
+	def allowed_values()
+		return nil
+	end
+	#Check if the given value is allowed.
+	def allowed?( value )
+		return true if allowed_values() == nil
+		allowed_values().each{|v|
+			if value == v
+				return true
+			elsif v.class == Class and value.is_a?( v )
+				return true
+			end
+			#Check next allowed value.
+		}
+		#No allowed value is set.
+		return false
+		#~ return allowed_values().include?( value )
+	end
+	#Add a value to the attribute content.
+	def <<( value )
+		if ! self.allowed?( value )
+			puts "Attribute #{@name}: Illegal value #{value.inspect} in #{@element.inspect}"
+		end
+		set_backlink( value )
+		if unique? and @attr_content.size > 0
+			puts "Attribute #{@name}: More then one value added (#{value}) in #{@element.inspect}"
+			return self
+		end
+		if content?
+			@element << value
+		else
+			@attr_content << value
+		end
+	end
+	#Return the content.
+	def to_s()
+	#~ def to_s( target = Document.target( self ) )
+		#list of documents, where this element is part of (normaly only one element)
+		if @part_of_doc.size == 0
+			@part_of_doc	= @element.part_of_doc	
+			set_backlink( @attr_content )
+		end
+		@attr_content.to_s()
+	end
+	def inspect()
+		return "<#Attribute #{@name} #{@attr_content.inspect} (in #{@element.ids}) >"
+	end
+end

data/docgenerator_characters.rb

@@ -0,0 +1,171 @@
+#
+# Special Characters
+#
+Element.create( [:space, :ensp], {},false, 
+	{	:html => ' ',
+		:latex	=> '~'
+	} )
+Element.create( [:bigspace, :emsp], {},false, 
+	{	:html => ' ',
+		:latex	=> '~~'
+	} )
+Element.create( [:nbsp], {},false, 
+	{	:html => ' ',
+		:latex	=> '~'
+	} )
+#
+#Requires \usepackage[right,eurosym]{eurofont}
+#		@head << element(:usepackage, {:option=>'right,eurosym' }, 'eurofont' )
+Element.create( [:euro], {},false, 
+	{	:html => '&euro;',
+		:latex	=> '\euro'
+	} )
+
+Element.create( [:percent, :'%'], {},false, 
+	{	:html => '%',
+		:latex	=> '\%'
+	} )
+
+Element.create( [:'^'], {},false, 
+	{	:html => '^',
+		:latex	=> '\hat{}'
+	} )
+	
+Element.create( [:iquest ], {},false, #�	umgekehrtes Fragezeichen
+	{	:html => '&iquest;',
+		:latex	=> '�'	#?`
+	} )
+
+
+Element.create( [:ampersand, :'&'], {},false, 
+	{	:html => '&amp;',
+		:latex	=> '\&'
+	} )
+
+Element.create( [:rbrace, :'}'], {},false, 
+	{	:html => '}',
+		:latex	=> '\}'
+	} )
+Element.create( [:lbrace, :'{'], {},false, 
+	{	:html => '{',
+		:latex	=> '\{'
+	} )
+
+Element.create( [:backslash ], {},false, 
+	{	:html => '\\',
+		:latex	=> '\ensuremath{\backslash}'
+	} )
+
+Element.create( [:radic], {},false, 
+	{	:html => '&radic;',
+		:latex	=> '\ensuremath{\sqrt{}}'
+	} )
+
+Element.create( [:rarr, :rightarrow, :'->'], {},false, 
+	{	:html => '&rarr;',
+		:latex	=> '\ensuremath{\rightarrow}'
+	} )
+
+Element.create( [:rArr, :Rightarrow, :'=>'], {},false, 
+	{	:html => '&rArr;',
+		:latex	=> '\ensuremath{\Rightarrow}'
+	} )
+Element.create( [:larr, :leftarrow, :'<-'], {},false, 
+	{	:html => '&larr;',
+		:latex	=> '\ensuremath{\leftarrow}'
+	} )
+
+Element.create( [:lArr, :Leftarrow, :'<='], {},false, 
+	{	:html => '&lArr;',
+		:latex	=> '\ensuremath{\Lefttarrow}'
+	} )
+
+Element.create( [:uArr, :Uparrow ], {},false, 
+	{	:html => '&uArr;',
+		:latex	=> '\ensuremath{\Uparrow}'
+	} )
+
+Element.create( [:lt, :'<'], {},false, 
+	{	:html => '&lt;',
+		:latex	=> '\ensuremath{<}'
+	} )
+Element.create( [:gt, :'>'], {},false, 
+	{	:html => '&gt;',
+		:latex	=> '\ensuremath{>}'
+	} )
+
+Element.create( [:infin, :infty], {},false, 
+	{	:html => '&infin;',
+		:latex	=> '\ensuremath{\infty}'
+	} )
+
+Element.create( [:divide ], {},false, 
+	{	:html => '&divide;',
+		:latex	=> '\ensuremath{\div}'
+	} )
+
+Element.create( [:yen], {},false, 
+	{	:html => '&yen;',
+		#~ :latex	=> '\ensuremath{\infty}'
+	} )
+
+Element.create( [:sim ], {},false, 
+	{	:html => '&sim;',
+		:latex	=> '\ensuremath{\sim}'
+	} )
+
+Element.create( [:brvbar ], {},false, #durchbrochener Strich
+	{	:html => '&brvbar;',
+		:latex	=> '|'	#not really correct
+		#~ :latex	=> '\ensuremath{\sim}'
+	} )
+
+Element.create( [:euros], {},true, 
+	{	:html => '#{@content}&euro;',
+		:latex	=> '\euros{#{@content}}'
+	} )
+
+	
+Element.create( [:neg, :not], {},false, 
+	{	:html => '&not;',
+		:latex	=> '\ensuremath{\neg}'
+	} )
+
+Element.create( [:times], {},false, 
+	{	:html => '&times;',
+		:latex	=> '\ensuremath{\times}'
+	} )
+
+Element.create( [:otimes], {},false, 
+	{	:html => '&otimes;',
+		:latex	=> '\ensuremath{\otimes}'
+	} )
+
+Element.create( [:empty], {},false, 
+	{	:html => '&empty;',
+		:latex	=> '\ensuremath{\emptyset}'	#fixme richtig?
+	} )
+
+Element.create( [:'_', :underscore], {},false, 
+	{	:html => '_',
+		:latex	=> '\_',
+	} )
+
+Element.create( [:bullet], {},false, 
+	{	:html => '&#149;',
+		:latex	=> '\ensuremath{\bullet}'
+	} )
+Element.create( [:'--', :ndash], {},false, 
+	{	:html => '&ndash;',	#'&#8211;'
+		#:html => '&#150;',
+		:latex	=> '--'
+	} )
+Element.create( [:'---', :mdash], {},false, 
+	{	:html => '&mdash;',	#'&#8212;'
+		#:html => '&#151;',
+		:latex	=> '---'
+	} )
+Element.create( [:dagger], {},false, 
+	{	:html => '&dagger;',
+		:latex	=> '\dag'
+	} )

data/docgenerator_css.rb

@@ -0,0 +1,207 @@
+if __FILE__ == $0
+	require 'docgenerator' 
+end
+
+#~ Element.create( [:style], {
+		#~ :type		=> Attribute.create( [ :html, :required ], "text/css", 1 ),
+	#~ }, true,
+	#~ {	:htmltag	=> 'style',
+		#~ :html	=> "\n<style type=\"text/css\">\n" + '#{@content}' + "</style>\n",
+		#~ :latex	=> nil
+	#~ } )
+
+class Style < Element
+	Element.add( [:style],  self)
+	#~ add_attributes( HTML_ATTR_ALL ) 
+	add_output( :latex,	'')	
+	#Prepare HTML-Output for Style-Tag.
+	#The values can be overwritten, if different CSS-Elements are inside.
+	def to_html()
+		res =	""
+		res <<	"\n" if @crbefore
+		res <<	"<style type=\"text/css\">\n"
+		@content.each{|c|
+			if c.is_a?(CSS)
+				res << c.to_tab.join(";\n")
+				res	<< ";\n"
+			else	#For compatibility 
+				res	<< "#{c};\n"
+			end
+		}
+		res << "</style>"
+		res << "\n" if @crafter
+		return res
+	end
+end
+
+CSS_COLORS = [ /rgb\((\d+%?,?){3,3}\)/, 
+			#rgb(R,G,B), rgb(%,%,%) oder #XXXXXX
+			#/gray\d{1,3}/
+			'black','gray','maroon','red', 'green', 'lime', 'olive', 'yellow', 'navy', 'blue', 'purple', 'fuchsia', 'teal', 'aqua', 'silver', 'white',
+			#Netscape-Farbnamen (120 zus�tzliche Farben)
+			#Falsche Darstellungen, siehe http://www.rzuser.uni-heidelberg.de/~x22/ht/farben2.html
+			'lightblue', 'lightcoral', 'lightcyan', 'lightgoldenrodyellow', 'lightgreen', 'lightgrey', 'lightpink', 'lightsalmon', 'lightseagreen', 'lightskyblue', 'lightslategray', 'lightsteelblue', 'lightyellow',
+			'greenyellow', 'palegreen', 'darkgreen',
+			'darkred', 'firebrick',
+			'salmon',
+		]
+CSS_BORDER = [ 'none', 'hidden', 'dotted', 'dashed', 'solid', 'double', 'groove', 'ridge', 'inset', 'outset' ]
+CSS_WIDTH =	[ /\d*(cm|mm|px|em|%)/, 'thin', 'medium', 'thick' ]
+#Class to collect css-settings for a Element.
+#This values can be used inline (style-Attribute) and inside style>-Tags
+class CSS
+	#List of all allowed values.
+	#The first value is a regular expression, coninued by fixed values.
+	@@values = {
+		'font-size'	=> [ /\A\d+(pt|px|em)/, 'xx-small', 'x-small', 'small', 'medium', 'large','x-large','xx-large','smaller','larger' ],
+		'font-style'	=> ['italic', 'oblique', 'normal'],
+		'font-weight'	=> ['bold' ],	#fixme complete it
+		'color'		=> CSS_COLORS,
+		'background-color'	=> CSS_COLORS,
+		'visibility'	=> ['hidden', 'visible' ],
+		'text-decoration' => ['underline', 'overline', 'line-through', 'blink', 'none'],
+		#Ausrichtung
+		'float'	=> ['left', 'right', 'none' ],
+		'text-align'	=> ['left', 'center', 'right', 'justify', 'char'],
+		'vertical-align'	=> ['top', 'middle','bottom','baseline','sub','super','text-top','text-bottom'],
+		'clear'			=> ['left', 'right','both','none'],	#Fortsetzung bei Textumfluss
+		'white-space'	=> [ 'normal', 'pre', 'nowrap' ],	#Textumbruch innererhalb des tags
+		#Borders: CSS-Eigenschaften: Au�enrand/Abstand
+		'margin'				=> CSS_WIDTH,
+		'margin-top'		=> CSS_WIDTH,
+		'margin-bottom'	=> CSS_WIDTH,
+		'margin-left'		=> CSS_WIDTH,
+		'margin-right'		=> CSS_WIDTH,
+		#Borders: CSS-Eigenschaften: Innenabstand
+		'padding'			=> CSS_WIDTH,
+		'padding-top'		=> CSS_WIDTH,
+		'padding-bottom'	=> CSS_WIDTH,
+		'padding-left'		=> CSS_WIDTH,
+		'padding-right'	=> CSS_WIDTH,
+		#Tabulars
+		'border-style'				=> CSS_BORDER,
+		'border-left-style'	=> CSS_BORDER,
+		'border-right-style'	=> CSS_BORDER,
+		'border-top-style'		=> CSS_BORDER,
+		'border-bottom-style'	=> CSS_BORDER,
+		'border-width'				=> CSS_WIDTH,
+		'border-left-width'	=> CSS_WIDTH,
+		'border-right-width'	=> CSS_WIDTH,
+		'border-top-width'		=> CSS_WIDTH,
+		'border-bottom-width'	=> CSS_WIDTH,
+		'border-color'				=> CSS_COLORS,
+		'border-left-color'	=> CSS_COLORS,
+		'border-right-color'	=> CSS_COLORS,
+		'border-top-color'		=> CSS_COLORS,
+		'border-bottom-color'	=> CSS_COLORS,
+		'table-layout'		=> ['auto', 'fixed'],	#Not in Opera
+		'empty-cells'		=> ['show', 'hide'],
+		'border-collapse'	=> ['separate', 'collapse'],
+		#Positionierung und Anzeige von Elementen
+		'position'		=> ['absolute', 'fixed', 'relative', 'static'],
+		'top'				=> CSS_WIDTH,
+		'left'				=> CSS_WIDTH,
+		'bottom'			=> CSS_WIDTH,
+		'right'			=> CSS_WIDTH,
+		'width'			=> CSS_WIDTH,
+		'min-width'		=> CSS_WIDTH,
+		'max-width'		=> CSS_WIDTH,
+		'height'			=> CSS_WIDTH,
+		'min-height'		=> CSS_WIDTH,
+		'max-height'		=> CSS_WIDTH,
+		'overflow'		=> ['visible', 'hidden', 'scroll', 'auto' ],
+		#Lists
+		'list-style-type'	=> [	
+				'decimal', 'lower-roman', 'upper-roman', 'lower-alpha', 'upper-alpha', 'lower-greek', 'hebrew', 'decimal-leading-zero', 
+				'cjk-ideographic', 'hiragana', 'katakana', 'hiragana-iroha', 'katakana-iroha',	#Japanese
+				'disc', 'circle', 'square', 	#ul
+				'none'],
+		'list-style-position'	=> [ 'inside', 'outside'],
+		'list-style-image'		=> String,	#URI
+		#~ 'list-style'			=> @@values['list-style-type'] + @@values['list-style-position'],
+		#Generell settings
+	#~ ['bottom', 'top', 'middle', 'baseline'],
+	}
+	def initialize( values ={} )
+		@values	= {}
+		values.each{|k,v|
+			self[k] = v
+		}
+		@cr = nil
+	end
+	#Make key unique. convert symbol to String...
+	def generalize_key( k )
+		key = nil
+		if k.is_a?(Symbol)
+			key = k.to_s.gsub('_','-')
+		else
+			key = k
+		end
+		return key
+	end
+	def []( k )
+		return @values[generalize_key( k )]
+	end
+	#Add a setting.
+	#
+	#If an existing value is overwritten, you get a warning.
+	#To replace a value, use
+	#	css[key].replace( value )	(But the you have no check)
+	def []=( k, v )
+		key = generalize_key( k )
+		if @values[key]
+			puts "CSS: Overwrite #{k.inspect}"
+		end
+		if ! @@values[key]
+			puts "CSS: Undefined key #{k.inspect}"
+		elsif @@values[key].include?(v)	#Fine
+		elsif @@values[key][0].is_a?(Regexp) and @@values[key][0] =~ v.to_s
+		else
+			puts "CSS: #{v} not allowed for #{key}"		
+		end
+		
+		@values[key] = v
+	end
+	#returns the values for a direct css in the style-attribute for a HTML-tag.
+	def to_s()
+		return self.to_tab.join(';')
+	end
+	#Returns a tab with the textes for each characteristic.
+	def to_tab()
+		s = []
+		@values.each{|k,v|
+			s << "#{k}: #{v}"
+		}
+		return s
+	end
+end
+
+if __FILE__ == $0
+require 'docgenerator'
+css = CSS.new({ :text_align => 'AA', :font_size => 'large'})
+css2 = CSS.new({ :font_size => '12px'})
+puts '-'*10
+style = element(:style)
+style << 'a'
+style << css
+style << css
+puts css.to_s()
+puts '-'*5
+puts style.to_s(:html)
+#~ puts style.to_s(:latex)
+
+end
+
+__END__
+<style type="text/css">
+<!--
+test {
+	font-family: monospace;
+	font-size: xx-large;
+	font-weight: bold;
+	font-style: italic;
+	text-decoration: underline;
+	text-align: center;
+}
+-->
+</style>