docgenerator 2.0.0 → 2.1.0

data/lib/docgenerator/css.rb

@@ -1,3 +1,4 @@
+#encoding: utf-8
 =begin rdoc
 Define classes to use cascading style sheets (CSS) for HTML-documents.
 =end
@@ -14,150 +15,150 @@ Create an instance with
 
 Only for HTML.
 =end
-class Style < Element
-	#~ add_attributes( HTML_ATTR_ALL ) 
-	add_latex_output ''
-	add_text_output ''
-	add_wiki_output ''
-	add_creole_output ''
-	#Prepare HTML-Output for Style-Tag.
-	#The values can be overwritten, if different CSS-Elements are inside.
-	def to_html( options = {} )
-    o = set_option_defaults(options)
-    o[:log].debug("Enter style.to_html") if o[:log].debug?
-		res =	""
-		res <<	"\n" if @crbefore
-		res <<	"<style type=\"text/css\">\n"
-		@content.each{|c|
-				res	<< c.to_html(options)
-		}
-		res << "</style>"
-		res << "\n" if @crafter
-		return res
-	end
-end #Style
+    class Style < Element
+      #~ add_attributes( HTML_ATTR_ALL ) 
+      add_latex_output ''
+      add_text_output ''
+      add_wiki_output ''
+      add_creole_output ''
+      #Prepare HTML-Output for Style-Tag.
+      #The values can be overwritten, if different CSS-Elements are inside.
+      def to_html( options = {} )
+        o = set_option_defaults(options)
+        o[:log].debug("Enter style.to_html") if o[:log].debug?
+        res =	""
+        res <<	"\n" if @crbefore
+        res <<	"<style type=\"text/css\">\n"
+        @content.each{|c|
+            res	<< c.to_html(options)
+        }
+        res << "</style>"
+        res << "\n" if @crafter
+        return res
+      end
+    end #Style
 
-CSS_COLORS = [ /rgb\((\d+%?,?){3,3}\)/, 
-			#rgb(R,G,B), rgb(%,%,%) oder #XXXXXX
-			#/gray\d{1,3}/
-			'black','gray', 'grey', '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', 'lightgray', 'lightslategray', 'lightslategrey', #yes, both are defined
-      'lightpink', 'lightsalmon', 'lightseagreen', 'lightskyblue', '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' ]
+    CSS_COLORS = [ /rgb\((\d+%?,?){3,3}\)/, 
+          #rgb(R,G,B), rgb(%,%,%) oder #XXXXXX
+          #/gray\d{1,3}/
+          'black','gray', 'grey', 'maroon','red', 'green', 'lime', 'olive', 'yellow', 'navy', 'blue', 'purple', 'fuchsia', 'teal', 'aqua', 'silver', 'white',
+          #Netscape-Farbnamen (120 additional colors)
+          #Falsche Darstellungen, siehe http://www.rzuser.uni-heidelberg.de/~x22/ht/farben2.html
+          'lightblue', 'lightcoral', 'lightcyan', 'lightgoldenrodyellow', 'lightgreen', 
+          'lightgrey', 'lightgray', 'lightslategray', 'lightslategrey', #yes, both are defined
+          'lightpink', 'lightsalmon', 'lightseagreen', 'lightskyblue', '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' ]
 
 =begin rdoc
 Class to collect css-settings for a Element.
 
 This values can be used inline (style-Attribute) and inside style>-Tags
 =end
-class CSS
-	#List of all allowed values.
-	#The first value is a regular expression, coninued by fixed values.
-	@@values = {
-		'font-size'	=> [ 'xx-small', 'x-small', 'small', 'medium', 'large','x-large','xx-large','smaller','larger', /\A\d+(pt|px|em)/ ],
-		'font-style'	=> ['italic', 'oblique', 'normal'],
-		'font-weight'	=> ['bold', 'bolder', 'lighter', 'normal', /\A\d00\Z/ ],
-		'color'		=> CSS_COLORS,
-		'background-color'	=> CSS_COLORS,
-		'visibility'	=> ['hidden', 'visible' ],
-		'text-decoration' => ['underline', 'overline', 'line-through', 'blink', 'none'],
-		#Ausrichtung
-		'float'	=> ['left', 'right', 'none' ],
-    'display'  => ['inline'],
-		'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	= {}
-    #~ set_option_defaults(values) #guarantee :log
-    @log = values[:log] || DOCGENERATOR_DEFAULT_LOGGER
-    values.delete(:log)
-    
-		values.each{|k,v|
-			self[k] = v
-		}
-		@cr = nil
-	end
+    class CSS
+      #List of all allowed values.
+      #The first value is a regular expression, coninued by fixed values.
+      @@values = {
+        'font-size'	=> [ 'xx-small', 'x-small', 'small', 'medium', 'large','x-large','xx-large','smaller','larger', /\A\d+(pt|px|em)/ ],
+        'font-style'	=> ['italic', 'oblique', 'normal'],
+        'font-weight'	=> ['bold', 'bolder', 'lighter', 'normal', /\A\d00\Z/ ],
+        'color'		=> CSS_COLORS,
+        'background-color'	=> CSS_COLORS,
+        'visibility'	=> ['hidden', 'visible' ],
+        'text-decoration' => ['underline', 'overline', 'line-through', 'blink', 'none'],
+        #Ausrichtung
+        'float'	=> ['left', 'right', 'none' ],
+        'display'  => ['inline'],
+        '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	= {}
+        #~ set_option_defaults(values) #guarantee :log
+        @log = values[:log] || DOCGENERATOR_DEFAULT_LOGGER
+        values.delete(:log)
+        
+        values.each{|k,v|
+          self[k] = v
+        }
+        @cr = nil
+      end
 =begin rdoc
 Make key unique. convert symbol to String...
 =end
-	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
+      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
 =begin rdoc
 Add a setting.
 
@@ -165,45 +166,44 @@ 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)
 =end
-	def []=( k, v )
-		key = generalize_key( k )
-		if @values[key]
-			@log.warn("CSS: Overwrite #{k.inspect}") if @log.warn?
-		end
-		if ! @@values[key]
-			@log.error("CSS: Undefined key #{k.inspect}") if @log.error?
-		elsif @@values[key].include?(v)	#Fine
-		elsif @@values[key][0].is_a?(Regexp) and @@values[key][0] =~ v.to_s
-		else
-			@log.error("CSS: #{v} not allowed for #{key}") if @log.error?
-		end
-		
-		@values[key] = v
-	end
+      def []=( k, v )
+        key = generalize_key( k )
+        if @values[key]
+          @log.warn("CSS: Overwrite #{k.inspect}") if @log.warn?
+        end
+        if ! @@values[key]
+          @log.error("CSS: Undefined key #{k.inspect}") if @log.error?
+        elsif @@values[key].include?(v)	#Fine
+        elsif @@values[key][0].is_a?(Regexp) and @@values[key][0] =~ v.to_s
+        else
+          @log.error("CSS: #{v} not allowed for #{key}") if @log.error?
+        end
+        
+        @values[key] = v
+      end
 =begin rdoc
 Returns the values for a direct css in the style-attribute for a HTML-tag.
 =end
-	def to_html(options={})
-    o = {
-      :map => "%s;",
-    }.update(options)
-		return self.to_tab.map{|p| o[:map] % p}.join()
-	end
-	def to_s()
-		return self.to_html
-	end
+      def to_html(options={})
+        o = {
+          :map => "%s;",
+        }.update(options)
+        return self.to_tab.map{|p| o[:map] % p}.join()
+      end
+      def to_s()
+        return self.to_html
+      end
 =begin rdoc
 Returns a tab with the textes for each characteristic.
 =end
-	def to_tab()
-		s = []
-		@values.sort.each{|k,v|
-			s << "#{k}: #{v}"
-		}
-		return s
-	end
-end #CSS
-
+      def to_tab()
+        s = []
+        @values.sort.each{|k,v|
+          s << "#{k}: #{v}"
+        }
+        return s
+      end
+    end #CSS
 end #module Docgenerator
 
 if __FILE__ == $0