docgenerator 1.2.1 → 2.0.0

data/lib/{packages/docgenerator_url.rb → docgenerator/packages/url.rb}

@@ -2,10 +2,9 @@
 if ! defined?( Document )
 	require 'docgenerator' 
 end
-#
-#Used by
-#-ODPAnalyser
-#-Stummfilm/Bezugsquellen
+
+module Docgenerator
+module Packages
 
 #
 #Small Administration class for websites and their description
@@ -39,8 +38,8 @@ class Url
 	def to_s()
 		return "#{self.url()}"
 	end
-	def to_element()
-		return element(:a, {:href=>self.url}, self.linktext())
+	def to_doc(target, attr = {})
+		return element(:a, {:href=>self.url}, self.linktext()).to_doc(target, attr)
 	end
 	#Output with all details.
 	#The ctrl-hash contains all elements which should be included.
@@ -80,3 +79,5 @@ class Url
 		return li_list
 	end
 end
+end #module Packages
+end #module Docgenerator

data/lib/docgenerator/sections.rb

@@ -2,95 +2,269 @@
 #Headings and sectioning
 #
 
-#Small helper to make TeX-Hyperlinks like in HTML (attribute id)
-def hypertarget(id)
-	return "\\hypertarget{#{id}}{}" if id.is_a?(String)
-	#~ return '' if ! id.content or id.content.to_s =~/\A\s*\Z/
-	return '' if ! id.content or id.content.join =~/\A\s*\Z/  #Ruby 1.9
-	return "\\hypertarget{#{id}}{}"
+if $0 == __FILE__
+  $:.unshift('..')
+  require 'docgenerator'
+  
+  END{
+    [ 
+      Docgenerator::Sectioning::DummySectioning.new({}, 'aa'),
+      element(:section,{}, 'bb'),
+      element(:h1,{}, 'cc'),
+      element(:abstract,{}, 'cc'),
+    ].each{|sec|
+
+    #~ puts sec.to_latex
+    #~ puts sec.to_html
+    #~ puts sec.to_wiki
+    #~ puts sec.to_creole
+    #~ puts sec.to_text
+    }
+  }
 end
 
-#Fixmes:
-#-	addsec 
-#-	article/report
-#- context (actual like latex
-sect = Struct.new( 'Sections', :keys, :wiki, :html, :tex )
-[
-	sect.new( [:part],			0,	'', 'part'),	#fixme: neue HTML-Datei?
-	sect.new( [:chapter],			1,	'', 'chapter'),	#fixme: neue HTML-Datei?
-	sect.new( [:h1, :section],		2,	'h1', 'section'),
-	sect.new( [:h2, :subsection],	3,	'h2', 'subsection'),
-	sect.new( [:h3, :subsubsection], 4,	'h3', 'subsubsection'),
-	sect.new( [:h4, :paragraph],	5,	'h4', 'paragraph'),
-	sect.new( [:h5, :subparagraph],	6,	'h5', 'subparagraph'),
-	sect.new( [:h6, :minisec],			7,	'h6', 'minisec'),
-].each{ |s|
-	Element.create( s.keys,	{
-		:short	=> Attribute.create( [ :latex ] ),
-	}.update( HTML_ATTR_ALL ),	true, 
-		{	:htmltag	=> s.html,
-			#~ :latex	=> '#{linebreak(@crbefore)}' + "\\#{s.tex}" + '{#{@content}}#{linebreak(@crafter)}',
-			:latex	=>	'#{linebreak(@crbefore)}'	+ "\\#{s.tex}" + 
+#
+module Docgenerator
+=begin rdoc
+Collection of section elements.
+
+Define of
+* part, chapter, [sub]*section, [sub]paragraph
+* h1...h6
+
+=end
+module Sectioning
+
+=begin rdoc
+Define Element :sectioning
+
+This is a dummy-element as template for section...
+
+Attributes may be:
+* :short: 
+* HTML_ATTR_CORE
+* HTML_ATTR_I18N
+* HTML_ATTR_EVENTS
+* :lang, ATTR_LANG
+=end
+class DummySectioning < Element
+  class << self
+    def inherited(subclass)
+      Element.inherited(subclass)     
+      subclass.class_eval(<<-attr
+        add_attributes HTML_ATTR_CORE
+        add_attributes HTML_ATTR_I18N
+        add_attributes HTML_ATTR_EVENTS
+        add_attribute :lang, ATTR_LANG
+        add_attribute :short, Attribute.create( [ :latex ] )
+      attr
+      )
+    end
+=begin rdoc
+Define the number of '=' for this section-command in wiki syntax.
+=end
+    def set_wikilevel( level )
+      class_eval( "def wikilevel(); '#{'=' * level}'; end")
+    end
+  end #class << self
+=begin rdoc
+Default marup for title for wikis.
+
+Is redefined by set_wikilevel( level )
+=end
+  def wikilevel(); ''; end 
+  
+  #Small helper to make TeX-Hyperlinks like in HTML (attribute id)
+  def hypertarget(id)
+    return "\\hypertarget{#{id}}{}" if id.is_a?(String)
+    #~ return '' if ! id.content or id.content.to_s =~/\A\s*\Z/
+    return '' if ! id.content or id.content.join =~/\A\s*\Z/  #Ruby 1.9
+    return "\\hypertarget{#{id}}{}"
+  end
+=begin rdoc
+Determine the TeX-Makroname from class name
+=end
+  def texmakro()
+    self.class.name.split('::').last.downcase
+  end
+
+  add_latex_output	'#{linebreak(@crbefore)}'	+ '\\#{texmakro}' + 
 								'#{texoptional(:short)}'	+
 								'{#{@content}}' +
 								'#{hypertarget(@attr[:id])}' +
-								'#{linebreak(@crafter)}',
-			:context	=>	'#{linebreak(@crbefore)}'	+ "\\#{s.tex}" + 
+								'#{linebreak(@crafter)}'
+                
+  add_context_output	'#{linebreak(@crbefore)}'	+ '\\#{texmakro}' + 
 								'#{texoptional(:short)}'	+
 								'{#{@content}}' +
 								'#{hypertarget(@attr[:id])}' +
-								'#{linebreak(@crafter)}',
-			:text	=> "\n" + '#{linebreak(@crbefore)}#{@content}' + "\n" + 
-								' ' * s.wiki * 2 + '-' * 30 + "\n"  + '#{linebreak(@crafter)}',
-			:wiki	=> '#{linebreak(@crbefore)}' + "\n" + '='* (s.wiki ) + '#{@content}' + '='* (s.wiki) + "\n" + '#{linebreak(@crafter)}',
-			:creole	=> '#{linebreak(@crbefore)}' + "\n" + '='* (s.wiki ) + '#{@content}' + "\n" + '#{linebreak(@crafter)}',
-		} )
-}
-#~ Element.create( [:h1],	HTML_ATTR_ALL,	true, 
-	#~ {	:htmltag	=> 'h1',
-		#~ :latex	=> "\n" + '\section{#{@content}}' + "\n"
-	#~ } )
-#~ Element.create( [:h2],	HTML_ATTR_ALL,	true, 
-	#~ {	:htmltag	=> 'h2',
-		#~ :latex	=> "\n" + '\subsection{#{@content}}' + "\n"
-	#~ } )
-	
-Element.create( [:addsec],	HTML_ATTR_ALL,	true, 
-	{	:htmltag	=> 'h2',
-		:latex	=> '#{linebreak(@crbefore)}' + '\addsec{#{@content}}' + '#{linebreak(@crafter)}'
-	} )
-	
-
-class Caption < Element
-	#Make the key known to the complete key-list of elements.
-	Element.add( [:caption],  Caption )
-	#
-	add_attributes( {
-		:optional		=> Attribute.create( [ :latex ] ),
-		} )
-	def to_latex()
-		cmd	=	''
-		cmd	<<	"\n" if @crbefore
-		cmd	<<	"\\caption"
-		if @attr[:optional].content != []
-			cmd	<<	"["
-			cmd	<<	@attr[:optional].content.to_s
-			cmd	<<	"]"
-			cmd	<<	"\n\t" if @crmid
-		end
-		cmd	<<	"{"
-		cmd	<< @content.to_s
-		cmd	<<	"}"
-		cmd	<<	"\n" if @crafter
-		return cmd
-	end
-end
+								'#{linebreak(@crafter)}'
 
-class Abstract < Environment
-	#~ add_attributes( HTML_ATTR_ALL ) 
-	Element.add( [:abstract],  Abstract)
-	#~ def htmltag(); ''; end
-	def to_latex( )
-		return to_latex_environment( 'abstract' )
-	end
-end
+  #'underlined' title
+	add_text_output	"\n" + '#{linebreak(@crbefore)}#{@content}' + "\n" + 
+								'#{wikilevel.gsub(/=/,\'  \')}' + 								
+                '-' * 30 + "\n"  + '#{linebreak(@crafter)}'
+                
+	add_wiki_output	'#{linebreak(@crbefore)}' + "\n" + '#{wikilevel}' + '#{@content}' + '#{wikilevel}' + "\n" + '#{linebreak(@crafter)}'
+  
+	add_creole_output	'#{linebreak(@crbefore)}' + "\n" + '#{wikilevel}' + '#{@content}' + "\n" + '#{linebreak(@crafter)}'
+end #Sectioning
+
+
+=begin rdoc
+Define Element :part
+
+Create an instance with
+  element( :part, [ attributes, [content]] )
+or
+  Part.new( [ attributes, [content]] )
+
+Attributes see class DummySectioning.
+=end
+class Part < DummySectioning
+  #~ add_html_tag ''
+end #Part
+
+=begin rdoc
+Define Element :chapter
+
+Create an instance with
+  element( :chapter, [ attributes, [content]] )
+or
+  Chapter.new( [ attributes, [content]] )
+
+Attributes see class DummySectioning.
+=end
+class Chapter < DummySectioning
+  set_wikilevel 1
+  #~ add_html_tag ''
+end #Chapter
+
+=begin rdoc
+Define Element :h1, :section
+
+Create an instance with
+  element( :h1, [ attributes, [content]] )
+  element( :section, [ attributes, [content]] )
+or
+  Section.new( [ attributes, [content]] )
+
+Attributes see class DummySectioning.
+=end
+class Section < DummySectioning
+  set_wikilevel 2
+  add_id :h1
+  add_html_tag 'h1'
+end #H1
+
+=begin rdoc
+Define Element :h2, :subsection
+
+Create an instance with
+  element( :h2, [ attributes, [content]] )
+  element( :subsection, [ attributes, [content]] )
+or
+  Subsection.new( [ attributes, [content]] )
+
+Attributes see class DummySectioning.
+=end
+class Subsection < DummySectioning
+  set_wikilevel 3
+  add_id :h2
+  add_html_tag 'h2'
+end #H2
+
+=begin rdoc
+Define Element :h3, :subsubsection
+
+Create an instance with
+  element( :h3, [ attributes, [content]] )
+  element( :subsubsection, [ attributes, [content]] )
+or
+  Subsubsection.new( [ attributes, [content]] )
+Attributes may be:
+
+Attributes see class DummySectioning.
+=end
+class Subsubsection < DummySectioning
+  set_wikilevel 4
+  add_id :h3
+  add_html_tag 'h3'
+end #H3
+
+=begin rdoc
+Define Element :h4, :paragraph
+
+Create an instance with
+  element( :h4, [ attributes, [content]] )
+  element( :paragraph, [ attributes, [content]] )
+or
+  Paragraph.new( [ attributes, [content]] )
+
+Attributes see class DummySectioning.
+=end
+class Paragraph < DummySectioning
+  set_wikilevel 5
+  add_id :h4
+  add_html_tag 'h4'
+end #H4
+
+
+=begin rdoc
+Define Element :h5, :subparagraph
+
+Create an instance with
+  element( :h5, [ attributes, [content]] )
+  element( :subparagraph, [ attributes, [content]] )
+or
+  Subparagraph.new( [ attributes, [content]] )
+
+Attributes see class DummySectioning.
+=end
+class Subparagraph < DummySectioning
+  set_wikilevel 6
+  add_id :h5
+  add_html_tag 'h5'
+end #H5
+
+=begin rdoc
+Define Element :h6, :minisec
+
+Create an instance with
+  element( :h6, [ attributes, [content]] )
+  element( :minisec, [ attributes, [content]] )
+or
+  Minisec.new( [ attributes, [content]] )
+
+Attributes see class DummySectioning.
+=end
+class Minisec < DummySectioning
+  set_wikilevel 7
+  add_id :h6
+  add_html_tag 'h6'
+end #H6
+
+
+=begin rdoc
+Define Element :addsec
+
+\\addsec is a command provided by koma-script.
+
+Create an instance with
+  element( :addsec, [ attributes, [content]] )
+or
+  Addsec.new( [ attributes, [content]] )
+  
+Attributes may be:
+* HTML_ATTR_ALL
+=end
+class Addsec < Element
+  add_attributes HTML_ATTR_CORE
+  add_attributes HTML_ATTR_I18N
+  add_attributes HTML_ATTR_EVENTS
+  add_attribute :lang, ATTR_LANG
+  add_html_tag 'h2'
+  add_latex_output '#{linebreak(@crbefore)}' + '\addsec{#{@content}}' + '#{linebreak(@crafter)}'
+end #Addsec
+end #module Sectioning
+end #module Docgenerator

data/lib/docgenerator/standard.rb

@@ -1,6 +1,6 @@
 #encoding: utf-8
 =begin rdoc
-This file change the behaviour of each Object.
+This file change the behaviour of each Object and extends Array
 =end
 
 =begin rdoc
@@ -9,36 +9,44 @@ Extend all objects by the methods
 - to_html
 - to_latex
 - to_wiki
+- to_creole
 - to_text
 - to_context
 Redefine is_a?:
-Return true, when you test with a symbol.
+Allows comparison with a symbol.
 =end
 class Object
   alias :old_is_a? :is_a?
 =begin rdoc
-Redefine the standard is_a?
+Redefine the standard is_a? to allow to
+compare with Symbol.
 
-Returns also true, if one of the ids is in testvalue
+Returns also true, if you compare Docgenerator::Element with a Symbol
+and one of the ids if the element corresponds to the Symbol.
+
+Example:
+  newline = element(:br)
+  newline.is_a?(:newline) #true
 =end
   def is_a?( testvalue)
     if testvalue.old_is_a?(Symbol)
-      if old_is_a?(Element)
-        return ids.include?(testvalue) 
+      if old_is_a?(Docgenerator::Element)
+        return element_ids.include?(testvalue) 
       else
         return false
       end
-    else
+    else  #old/normal behaviour.
       return old_is_a?(testvalue)
     end
   end
 =begin rdoc
 to_doc returns the object as a string.
-will be redefined for Element
+will be redefined for Docgenerator::Element
+
 =end
   def to_doc(target, options = {})
-    o = Docgenerator_logger.set_option_defaults(options)
-    if self.is_a?(Element) and ! self.respond_to?(:to_doc)
+    o = Docgenerator.set_option_defaults(options)
+    if self.is_a?(Docgenerator::Element) and ! self.respond_to?(:to_doc)
       o[:log].error( "Missing to_doc routine for #{self.class}") if o[:log].error?
     end
     self.respond_to?(:to_str) ? self.to_str : self.to_s
@@ -59,7 +67,7 @@ class Array
 Returns the element for each parameter
 =end
   def to_doc(target, options = {})
-    o = Docgenerator_logger.set_option_defaults(options)
+    o = Docgenerator.set_option_defaults(options)
     o[:log].debug("enter to_doc(#{target}) for Array, options: #{options.keys.inspect}") if o[:log].debug?
     str = ""
     self.each{|el|