docgenerator 1.1.1 → 1.2.1

data/lib/{docgenerator_lists.rb → docgenerator/lists.rb}

@@ -21,7 +21,7 @@ class ListEnvironment < Environment
 			@content << item
 		end
 	end
-  #Add parent-information to options. Is used by the list elements to get the list type.
+  #Add parent-information to options. This is used by the list elements to get the list type.
 	def to_doc( target, options = {} )
     o = Docgenerator_logger.set_option_defaults(options)
     o[:log].debug("enter to_doc for #{self.inspect}") if o[:log].debug?
@@ -43,6 +43,9 @@ class Itemize < ListEnvironment
 	def to_latex( options={} )
 		return to_latex_environment( 'itemize', nil, options )
 	end
+	def to_context( options={} )
+		return to_context_environment( 'itemize', '[1]', options )
+	end
 end
 class Enumerate < ListEnvironment
 	add_attributes( HTML_ATTR_ALL ) 
@@ -51,6 +54,9 @@ class Enumerate < ListEnvironment
 	def to_latex( options={} )
 		return to_latex_environment( 'enumerate', nil, options )
 	end
+	def to_context( options={} )
+		return to_context_environment( 'itemize', '[n]', options )
+	end
 end
 #
 #
@@ -88,6 +94,16 @@ class Item < Element
 		cmd	<<	"\n" if @crafter
 		return cmd
 	end
+  #Item is the same like in LaTeX,but we have to use to_context() for the sub-elements.
+	def to_context( options={} )
+		cmd	= ''
+		cmd	<<	"\n" if @crbefore
+		cmd	<<	"\n\\item "
+		#~ cmd	<<	"[#{@attr[:text]}] " if @attr[:text].filled?  #fixme
+		cmd	<<	@content.to_doc(:context, options)
+		cmd	<<	"\n" if @crafter
+		return cmd
+	end
 	def to_text(options={})
 		cmd	= ''
 		cmd	<<	"\n" if @crbefore

data/lib/{docgenerator_sections.rb → docgenerator/sections.rb}

@@ -5,13 +5,15 @@
 #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.to_s =~/\A\s*\Z/
+	return '' if ! id.content or id.content.join =~/\A\s*\Z/  #Ruby 1.9
 	return "\\hypertarget{#{id}}{}"
 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?
@@ -33,9 +35,15 @@ sect = Struct.new( 'Sections', :keys, :wiki, :html, :tex )
 								'{#{@content}}' +
 								'#{hypertarget(@attr[:id])}' +
 								'#{linebreak(@crafter)}',
+			:context	=>	'#{linebreak(@crbefore)}'	+ "\\#{s.tex}" + 
+								'#{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, 

data/lib/docgenerator/standard.rb

@@ -0,0 +1,81 @@
+#encoding: utf-8
+=begin rdoc
+This file change the behaviour of each Object.
+=end
+
+=begin rdoc
+Extend all objects by the methods 
+- to_doc
+- to_html
+- to_latex
+- to_wiki
+- to_text
+- to_context
+Redefine is_a?:
+Return true, when you test with a symbol.
+=end
+class Object
+  alias :old_is_a? :is_a?
+=begin rdoc
+Redefine the standard is_a?
+
+Returns also true, if one of the ids is in testvalue
+=end
+  def is_a?( testvalue)
+    if testvalue.old_is_a?(Symbol)
+      if old_is_a?(Element)
+        return ids.include?(testvalue) 
+      else
+        return false
+      end
+    else
+      return old_is_a?(testvalue)
+    end
+  end
+=begin rdoc
+to_doc returns the object as a string.
+will be redefined for 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[: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
+  end
+  def to_text(options = {}); to_doc(:text, options);  end
+  def to_latex(options = {}); to_doc(:latex, options);  end
+  def to_context(options = {}); to_doc(:context, options);  end
+  def to_html(options = {}); to_doc(:html, options);  end
+  def to_wiki(options = {}); to_doc(:wiki, options);  end
+  def to_creole(options = {}); to_doc(:creole, options);  end
+end
+
+=begin rdoc
+Recursive to_doc for each elements in the array.
+=end
+class Array
+=begin rdoc
+Returns the element for each parameter
+=end
+  def to_doc(target, options = {})
+    o = Docgenerator_logger.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|
+      begin
+        res = el.to_doc(target, o)
+      rescue ArgumentError
+        o[:log].fatal("ArgumentError to_doc for element <#{el.class}>") if o[:log].fatal?
+        res = el.to_doc(target)
+      end
+      #Add text. If necessary, convert the encoding.
+      begin 
+        str << res
+      rescue Encoding::CompatibilityError
+        str << res.encode(str.encoding)
+      end
+    }
+    return str
+  end #Array#to_doc
+end #Array

data/lib/{docgenerator_tabular.rb → docgenerator/tabular.rb}

@@ -1,6 +1,8 @@
-#
-#Definition of tabular elements for DocGenerator.rb
-#
+#encoding: utf-8
+=begin rdoc
+Definition of tabular elements for DocGenerator.rb
+=end
+
 #~ if __FILE__ == $0
 	#~ require 'DocGenerator' 
 #~ end
@@ -243,7 +245,7 @@ class Row < Element
       o[:log].debug("table/row without corresponding file") if o[:log].debug?
       cmd << Regexp.escape('\\')
     end
-		cmd	<< "[#{@attr[:add_vspace].content.to_s}]" if @attr[:add_vspace].content.size > 0
+		cmd	<< "[#{@attr[:add_vspace].content.join}]" if @attr[:add_vspace].content.size > 0
 		cmd	<< @hline.to_latex(o)		if @hline
 		cmd	<< @toprule.to_latex(o)	if @toprule
 		cmd	<< @midrule.to_latex(o)	if @midrule
@@ -269,11 +271,13 @@ class Row < Element
 		css = @attr[:style].content[0]
     o[:log].error( "docgenerator_tabular: style is no CSS #{css.inspect}" ) if css and ! css.is_a?(CSS) and o[:log].error?
 		@attr[:style] << css = CSS.new if ! css		
+    
 		#Doesn't work. Style sheet setting in tr doesn't go to td
 		if @hline
 			css[:border_bottom_style]	= 'solid'  
-			css[:border_bottom_width] = 'thick'  
+			css[:border_bottom_width] = 'medium'  
 		end
+    
 		# cmd	<< @toprule.to_s	if @toprule
 		# cmd	<< @midrule.to_s	if @midrule
 		# cmd	<< @bottomrule.to_s	if @bottomrule

data/lib/packages/docgenerator_listings.rb

@@ -28,9 +28,13 @@ LSTSETTINGS = 	{
 	}
 
 Element.create( [:lstlistoflistings], {}, false )
-Element.create( [:lstloadlanguages], {}, true, {:html => '' } )
+Element.create( [:lstloadlanguages], {}, true, { 
+  :latex => '#{linebreak(@crbefore)}\lstloadlanguages{#{@content}}#{linebreak(@crafter)}',
+  :html => '',
+  } )
 Element.create( [:lstset], LSTSETTINGS, false, {
 		:latex	=> '#{linebreak(@crbefore)}\lstset{#{texkeyval()}}#{linebreak(@crafter)}',
+    :html => '',
 			})
 Element.create( [:lstdefinestyle], LSTSETTINGS, true, {
 		:latex	=> '#{linebreak(@crbefore)}\lstdefinestyle{#{@content}}{#{texkeyval()}}#{linebreak(@crafter)}',
@@ -57,7 +61,7 @@ class Lstinline < Element
 	def htmltag; 'pre'; end
 	#Redefine standard output. 
 	#Options are given, if an option is avalaible.
-	def to_latex()
+	def to_latex(  options={}  )
 		if ! @content.include?( '!' );	sep = '!'
 		elsif ! @content.include?( '?' );	sep = '?'
 		else
@@ -67,7 +71,7 @@ class Lstinline < Element
 		cmd << '\lstinline'
 		cmd << "[#{texkeyval()}]"
 		cmd << sep
-		cmd << "#{@content.to_latex}"
+		cmd << "#{@content.to_latex( options)}"
 		cmd << sep
 		cmd << linebreak(@crafter)
 		return cmd
@@ -86,10 +90,10 @@ class Lstlisting < Environment
 	def htmltag; 'pre'; end
 	#Redefine standard output. 
 	#Options are given, if an option is avalaible.
-	def to_latex()
+	def to_latex( options={} )
 		option	= "[#{texkeyval()}]"
 		option	= nil if option == '[]'
-		return to_latex_environment( 'lstlisting', option )
+		return to_latex_environment( 'lstlisting', option,  options )
 	end
 end
 

data/lib/packages/docgenerator_pdfpages.rb

@@ -2,17 +2,23 @@
 #requires a
 #	doc.head << element(:usepackage,{},'pdfpages')
 #
+#The usepackage command loads this script by its own.
+#
 
 
-#if ! $".include?('docgenerator.rb')
-if ! defined?( Document )
-	require 'docgenerator' 
-end
-
-puts "#{__FILE__} fixme: options includepdf: hyperref/addsec.."
-Element.create( :includepdf, {
+#
+#Implement includepdf from pdfpages-package.
+#
+#Only pages-parameter is supported (yet).
+class IncludePDF < Element
+  
+  Element.add( [:includepdf],  IncludePDF )
+  
+  add_attributes( {
 			:pages		=>	Attribute.create( [ :texkeyval], [ String ] ),
-			#~ :pages		=>	Attribute.create( [ :texkeyval], [ String ] ),
-		}, true, {
-			:latex	=> '#{linebreak(@crbefore)}\includepdf[#{texkeyval()}]{#{@content}}#{linebreak(@crafter)}',
-		})
+    }#.update(HTML_ATTR_ALL)
+    )
+    
+  add_output( :latex,  '#{linebreak(@crbefore)}\includepdf[#{texkeyval()}]{#{@content}}#{linebreak(@crafter)}')
+    
+end #IncludePDF

data/lib/packages/docgenerator_url.rb

@@ -80,5 +80,3 @@ class Url
 		return li_list
 	end
 end
-
-

data/lib/templates/docgenerator_template.rb

@@ -1,25 +1,34 @@
-#
-#Definition of templates.
-#
-#This templates are used for document types.
+#encoding: cp1252
+=begin rdoc
+Definition of templates.
+
+This templates are used for document types.
+
+This Source-code is stored in cp1252. 
+All templates will get this encoding.
+
+
+=end
 class DocumentTemplate
 	@@templates	= {}
-  #
-  #Define a template.
-  #
-  #A template gets a key, a target and the corresponding source.
-  #
-  #Valid targets are:
-  #-:latex
-  #-:html
-  #-:wiki
-  #-:text
-  #
-  #The source should contain the following place holder:
-  #- <<prefix>>   Contains later some admin data like time of creation...
-  #- <<head>>   Some header definitions
-  #- <<body>>   The main text
-  #- <<classoptions>> Class options (LaTeX)
+=begin rdoc
+
+Define a template.
+
+A template gets a key, a target and the corresponding source.
+
+Valid targets are:
+-:latex
+-:html
+-:wiki
+-:text
+
+The source should contain the following place holder:
+- <<prefix>>   Contains later some admin data like time of creation...
+- <<head>>   Some header definitions
+- <<body>>   The main text
+- <<classoptions>> Class options (LaTeX)
+=end
 	def initialize( key, target, template)
     @key     = key
     @target = target
@@ -27,7 +36,9 @@ class DocumentTemplate
 		case target
 		when :text
 		when :wiki
+		when :creole
 		when :latex
+		when :context
 		when :html
     else
       puts "DocumentTemplate: Undefined target #{target.inspect}"
@@ -67,13 +78,13 @@ class DocumentTemplate
 	def DocumentTemplate.keys()
 		return @@templates.keys
 	end
-  #
-  # To add new templates via an external yaml-definition file.
-  # See 'docgenerator_template.yaml' as an example.
-  #
-  # You can use DocumentTemplate.to_yaml() to build your file.
-  #
-	def DocumentTemplate.load( yamlfile = "#{File.dirname(__FILE__)}/docgenerator_template.yaml" )
+=begin rdoc
+To add new templates via an external yaml-definition file.
+See 'docgenerator_template.yaml' as an example.
+
+You can use DocumentTemplate.to_yaml() to build your file.
+=end
+	def DocumentTemplate.load( yamlfile )
     File.open(yamlfile){|yaml|
       YAML.load(yaml).each{|key, data|
         DocumentTemplate.new( key, data[:target], data[:source] )
@@ -93,7 +104,22 @@ class DocumentTemplate
 	end
 end
 
-DocumentTemplate.load()
+  [
+    "#{File.dirname(__FILE__)}/docgenerator_template.yaml",
+=begin
+ocra-settings:
+
+If you 'compile' your script with ocra, the template file is not found.
+
+You have to add it yourself with 
+  ocra <your_script>.rb docgenerator_template.yaml
+
+(How to do it better?
+=end
+    "#{File.dirname(__FILE__)}/../../../../../../../../src/docgenerator_template.yaml",  #for ocra-version (exe)
+  ].each{| template_file |  
+    DocumentTemplate.load(template_file)  if File.exist?(template_file)
+}
 
 #~ Dir["#{File.dirname(__FILE__)}/*.{wiki,latex,text,html}"].each{|templatename|
   #~ key, target = File.basename(templatename).split(/\./)
@@ -134,7 +160,18 @@ DocumentTemplate.new(
 	#~ |)
 
 		#~ <!doctype html public "-//W3C//DTD XHTML 1.0 Strict//EN"   "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
-
+    
+DocumentTemplate.new( 
+	:context, %q|<<prefix>>
+		% ----------------------------------------------------------------
+		<<head>>
+		% ----------------------------------------------------------------
+    \starttext
+		<<body>>
+    \stoptext
+		% ----------------------------------------------------------------
+	|)
+  
 DocumentTemplate.new( 
 	:html, :html, %q|<!--
 		<<prefix>>

data/lib/templates/docgenerator_template.yaml

@@ -24,6 +24,12 @@
     
     <<body>>
 
+:creole: 
+  :target: :creole
+  :source: |
+    
+    <<body>>
+
 :xhtml_trans: 
   :target: :html
   :source: |
@@ -103,3 +109,15 @@
     <<body>>
     \end{document}
     % ----------------------------------------------------------------
+
+:context: 
+  :target: :context
+  :source: |
+    <<prefix>>
+    % ----------------------------------------------------------------
+    <<head>>
+    % ----------------------------------------------------------------
+    \starttext
+    <<body>>
+    \stoptext
+    % ----------------------------------------------------------------

data/lib/wiki2doc/wiki2docgenerator.rb

@@ -285,6 +285,8 @@ end
 #Get text in wiki-format and build a docgenerator-version.
 #
 class Wikitext
+  include Docgenerator  #get VERSION
+  
   #
   #Make short description for the Wiki-syntax
   def self.help( version = :syntax)
@@ -630,9 +632,11 @@ tabhelp
         end
       when 'filecontent'
         if File.exist?( val.first )
+          text = File.read(val.first)
+          #~ text.force_encoding(val[1] ) if val[1]
           return element(:div,
                                 Hash[*val[1..-1].map{|v| kv = v.split(/=/); [kv[0].to_sym, kv[1]]}.flatten], 
-                                File.read(val.first) )
+                                text )
         else
           log.error( "#{self.class}#wiki_macro: File #{value} missing for filecontent in line #{@lineno}" ) if log.error?
         end
@@ -692,7 +696,7 @@ tabhelp
     collector		= nil	#collect content for other application
     collectorline	= nil	#collect content for other application
     
-    txt.each{|line|
+    txt.each_line{|line|
     
       if line.gsub!( /#~.*/, '')	#delete comments
         #skip processing, if the line is now empty.