docgenerator 1.0.4 → 1.1.1

data/lib/yaml2presentation/yaml2presentation.rb

@@ -0,0 +1,1091 @@
+#~ fixmes:
+#~ Frame: puts in log umsetzte
+
+#~ require 'docgenerator'
+require 'wiki2doc/wiki2docgenerator.rb'
+require 'creole/creole2doc.rb'
+require 'packages/docgenerator_beamer.rb'
+require 'yaml'
+
+#Analyse Wiki-text inside a frame.
+class WikiFrame  < Wikitext
+  def wiki_macro( macro, parameters )
+    case macro
+      #Special feature, requires additional scripts.
+      when 'note'
+        element(:note,{}, parameters)
+      when 'rail'
+        raise "require rails parts" if ! Rail_diagramm
+        Rail_diagramm[parameters.to_sym]
+      else
+        super(macro, parameters)
+    end
+  end
+end
+
+#Redefinition of docgenerator-Frame class (or better extension.)
+#
+#Generell Problems:
+#-no lists outside a frame for LaTeX-Output
+#-frames with verbatim must contain the option ''fragile''
+class Frame
+  attr_accessor  :title
+  attr_accessor  :html_link
+  #Filename of a preview thumb
+  attr_reader  :thumb
+  attr_accessor  :framepic
+  attr_accessor  :picname
+  attr_accessor  :key
+  #Settings of Presentation
+  #contains things like "picwithframe"
+  attr_accessor  :settings
+  #Presentation, where frame is part of.
+  #Used to add detail pages of pictures
+  attr_accessor  :presentation
+  
+  #Add a picture to the frame
+  def pic=( picname )
+    if ! File.exist?(picname)
+      @log.error("Picture #{picname} missing") if @log.error?
+    end
+    @picname  = picname
+    self << @framepic  = Framepic.new( { :file => picname } )
+    @framepic.picture.thumbname = @thumb if @thumb
+    return @framepic
+  end
+  #Add a picture with link to a 'fullpage-mode'.
+  def picfull=( picname )
+    self.pic= picname
+    if self.presentation
+      self.presentation.attachment << picname
+      @framepic[:link] << "pic:#{picname}"
+    end
+    #not really functional. Is set later again with beamer_save
+    @framepic.picwithname = @settings[:picwithname]
+  end
+  #Add a picture in 'fullpage-mode'.
+  def piconly=( picname )
+    if ! File.exist?(picname)
+      @log.warn("Picture #{picname} missing")if @log.warn?
+    end
+    @picname  = picname
+    self << element(:includegraphicsJustified, {}, picname)
+    #~ return @framepic
+  end
+  def thumb=( thumbname )
+    raise "Thumb without picture (#{title}" if ! @framepic
+    if ! File.exist?(thumbname)
+      @log.warn("Thumb #{thumbname} missing") if @log.warn?
+    end        
+    @thumb  = thumbname
+    @framepic.picture.thumbname = thumbname if @framepic.picture
+  end  #Add option.
+  
+  #CSS-options for surrounding div
+  def pos=( pos )
+    if ! @framepic
+      @log.warn("Set pos #{pos} for undefined picture in #{@title}") if @log.warn?
+      return false
+    end
+    @framepic.div_css  = CSS.new() if ! @framepic.div_css
+    case pos
+      when 'left', 'right'
+        @framepic.div_css[:float]  = pos
+        @framepic.div_css[:padding]  = '10px'
+      when 'top', 'bottom'
+        @framepic.div_css[:float]  = 'none'
+      else
+        @log.warn("Undefined option #{pos} in #{@title}") if @log.warn?
+    end
+  end  #pos=
+  #Set picture width
+  def picwidth= (width )
+    if ! @framepic
+      @log.warn("Set width for undefined picture in #{@title}") if @log.warn?
+      return false
+    end
+    @framepic.img_css  = CSS.new() if ! @framepic.img_css
+    @framepic.img_css[:width]  = width
+  end
+  def framepicratio=( value )
+    vals = value.strip.split(/[,;]/)
+    vals.each{|val|
+      case val
+        when /\d*\.\d+/
+        else
+          @log.warn("Wrong ratio #{val} given with #{value}") if @log.warn?
+      end
+    }
+    @framepicratio = "\\framepicratio{#{vals[0]}}{#{vals[1]}}\n"
+  end
+  def img_class=( value )
+    if ! @framepic
+      @log.warn("Set width for undefined picture in #{@title}") if @log.warn?
+      return false
+    end
+    @framepic.img_class = value
+  end
+  #Set CSS-class for the div
+  def html_class=( value )
+    if ! @framepic
+      @log.warn("Set #{key} for undefined picture in #{@title}") if @log.warn?
+      return false
+    end
+    @framepic.div_class = value
+  end
+  def fragile=( value ); 
+    self[:options]  << 'fragile'
+  end
+  #Alignment top/bottom of page
+  def alignment= (value)
+    case value 
+      when 't', 'b'
+        self[:options]  << value
+      else
+        @log.warn("Undefined alignment #{value} (allowed: t/b)" ) if @log.warn?
+    end
+  end
+  #If there is a pic, move the content of the frame to the content of the pic.
+  def rearrange_content()
+    newcontent = []
+    @content.each{|e|
+      if e.is_a?(:framepic) or e.is_a?(:frametitle)
+          newcontent << e
+        else
+          @framepic  << e
+      end
+    }
+    return newcontent
+  end
+  def to_doc(target, options = {})
+    if self.key and @attr[:id].content.empty?
+      @attr[:id] << self.key 
+    end
+    super
+  end
+  #Store old logic of to_latex
+  alias :old_to_latex :to_latex
+  #Move content into TeX-Macro.
+  #Not nice, but so we can use << in frame and don't need an additional step.
+  def to_latex(options = {})
+    @content = rearrange_content() if @framepic  
+    @content.unshift(@framepicratio) if @framepicratio    
+    old_to_latex(options)
+  end
+  #~ def to_html(options = {})
+    #~ if self.key and @attr[:id].content.empty?
+      #~ @attr[:id] << self.key 
+    #~ end
+    #~ super
+  #~ end
+end  #Frame
+
+#Class to create
+#-Presentation (Using beamer-class for LaTeX)
+#
+class Presentation
+  #Little elp for me.
+  #Avoid the automatic generation of TeX-Entries
+  EMPTYBIBTEX = "\n%BibTeX-Entry>\n%BibTeX-Entry<\n"  
+  #
+  #Defaults settings for Presentation, used in Presentation#save_beamer.
+  #
+  DEF_SETTINGS  = {
+        #Values for Document
+        :template  => :emptyTemplate,
+        :splitscreen => nil,
+        :language  => ['ngerman'],  #Default
+        :author    => nil,
+        :defaultoptions  => {},  #Defaults for each frame
+        :wikiframe => WikiFrame,  #Wiki-type 
+        #~ :shortauthor  => nil,
+        :institute  => nil,
+        :date    => nil,
+        :shorttitle  => nil,
+        :subtitle  => nil,  #used for beamer
+        :logo      => nil,
+        :maketitle  => nil,
+        :maketoc  => nil,
+        :keywords  => nil,    #copied to @keywords
+        :description=> nil,  #copied to @description
+        :id      => nil,  #copied to @description
+        :altlang    => nil,  #copied to @description
+        #Outputs (true, nil)
+        :presentation    => false,
+        :beamer_article  => false,
+        :beamer_notes  => false,  #one value of BEAMER_NOTES
+        :beamer_include=> false,
+        :html        => false,#valid parameter: true, :overview_with_singlepages, :with_detailpic :with_detailpic_and_text
+        :pdftk        => false,#Additional pdftk-process
+        #Options for TeX
+        :runtex        => false,
+        :fullpage      => false,
+        #Picture name under picture
+        :picwithname  => false,
+        :classoption    => [],
+        :log              => Log4r::Logger.new( 'presentation', Log4r::WARN ),
+        #Valid keys - suppress the "Unknown key"-Warning for additional keys.
+        :valid_keys   => []
+  }  
+  DEF_SETTINGS[:log].outputters = Log4r::StdoutOutputter.new('Presentation')
+  
+  #show  - Include notes in the output file. Normal slides are also included.
+  #only    - Include only the notes in the output file and suppresses all frames.
+  #onlyslideswithnotes  - This includes all notes and those slides that contain a \note.
+  BEAMER_NOTES = [ 
+    'show',               #Normal presentation, including notes pages
+    'only',               #only notes pages
+    'onlyslideswithnotes',  #Normal page and notes page, only pages with comments
+    ]
+  #Option splitscreen/Taking Advantage of Multiple Screens
+  BEAMER_SPLIT_POSITIONS = [
+    'right',
+    'left',
+    'top',
+    'bottom',
+  ]
+  #Define a presentation/picture galery
+  def initialize(  title, settings = {})
+    @title  = title
+    @settings    = DEF_SETTINGS.merge(settings)
+    
+    @log = @settings[:log]
+    @log.info("Build Presentation #{title}") if @log.info?
+    
+    @head  = []
+    @attachment  = []
+    @content    = []
+    @frames    = []  #u.a. f�r Navigation
+    @bibtex    = nil
+    @description  = @settings[:description]
+    @keywords  = @settings[:keywords]
+    #~ log.level = Log4r::ERROR
+    #~ log.level = Log4r::DEBUG
+    #~ log.outputters = Log4r::StdoutOutputter.new('test_document_toc')    
+    
+    if ! [WikiFrame, Creole].include?(@settings[:wikiframe])
+        @log.error("Wrong type for wikiframe (#{@settings[:wikiframe]})") if @log.error?
+    end
+
+  end
+  attr_accessor  :title
+  #Some global settings.
+  #Can be set via macros in WikiPresentation.
+  #Allowed values, see method check_settings
+  attr_reader  :settings
+  #Attachments.
+  #Contains "big" pictures
+  attr_accessor  :attachment
+  #Additional heading information.
+  #Is a list.
+  attr_reader  :head
+  #Definition for a bibtex-entry
+  attr_accessor  :bibtex
+  attr_accessor  :keywords
+  attr_accessor  :description
+  #Logger for the presentation
+  attr_reader  :log
+
+  #Allowed keys and methods to be called.
+  #:main is a dummy method
+  KEYS = {  
+    'section'        => :main,
+    'sectionshort'    => :main,
+    'subsection'    => :main,
+    'subsectionshort'=> :main,
+    'title'        => :main,
+    'wiki'          => :main,
+    'notes'        => :main,
+    'restrict'      => :main,  #Allowed values: :latex, :html
+    'thumb'    => :thumb=,
+    'pic'      => :pic=,
+    'pic*'      => :picfull=,
+    'PIC'      => :piconly=,
+    'picwidth'  => :picwidth=,
+    'pos'      => :pos=,
+    'alignment'  => :alignment=,
+    'fragile'    => :fragile=,
+    'key'      => :key=,
+    'html_class'=> :html_class=,
+    'img_class'  => :img_class=,
+    'framepicratio'  => :framepicratio=,
+  }
+  #Add contents to Presentation.
+  #fixme2yaml
+  def <<(input)
+    data = input
+    data = YAML.load(input) if input.is_a?( String ) or input.is_a?( File )
+    data = [data]  if input.is_a?( Hash )
+    raise "Wrong datatype in Presentation << (#{input.class}, converted to #{data.class}" if ! data.is_a?(Array)
+    
+    data.each{|properties|
+      props = @settings[:defaultoptions].merge(properties)
+      if props['section']
+        @content << element(:section, {}, props['section']).cr
+        if props['sectionshort']
+        @content.last[:short] << props['sectionshort']
+        end
+      end
+      if props['subsection']
+        @content << element(:subsection, {}, props['subsection']).cr
+        if props['subsectionshort']
+        @content.last[:short] << props['subsectionshort']
+        end
+      end
+      
+      #Add in frames
+      @content  << frame  = element(:frame, :log => @log).CR
+      @frames  << frame
+      frame.presentation = self
+      frame.settings = @settings
+      frame.restrict_to(props['restrict']) if props['restrict']
+      if props['title']
+        frame.title = props['title']
+        frame  << element(:frametitle, {}, frame.title ).cr
+      else
+        @log.error("No title available(#{props.inspect})") if @log.error?
+      end
+      #Call methods for settings.
+      #The sequence is important (thumb, pos... requires a pic.
+      [  "pic", "pic*", "PIC", "thumb", 
+        "pos", "picwidth", 
+        "fragile", "alignment", 
+        "key", 
+        "html_class", "img_class",
+        "framepicratio"
+      ].each{|key|
+        if props[key]
+          frame.send( KEYS[key], props[key] )
+        end
+      }
+      frame  <<  @settings[:wikiframe].new(:content => props['wiki']) if props['wiki']
+      if props['notes']
+        frame  <<  element(:note,{},
+                    @settings[:wikiframe].new(:content => props['notes'])
+                    )
+      end
+      
+      #Check for unknown parameters (Typo?)
+      (props.keys - KEYS.keys - @settings[:valid_keys]).each{|key|
+        @log.warn("Unknown key '#{key}' in #{props.inspect}") if @log.warn?
+      }
+      @content  << element(:newline, {:clear=>'all'}).restrict_to(:html).cr
+    }
+    return self
+  end
+  
+  #The result are different files:
+  #-The presentation content (beamer_include)
+  #-The article version
+  #-the beamer version
+  #-the notes version
+  #-the HTML version
+  #The flags are used to write "true" to the documentsettings.
+  #-runtex (:pdflualatex, :latex, :pdflatex, :xelatex)
+  #-fullpage
+  def save( filename, *args )
+    settings  = DEF_SETTINGS.dup.update(@settings)
+    args.flatten.each{|arg|
+      if arg.is_a?(Hash)  #max. einmal, letzte Element
+        settings.update(arg)
+      else
+        settings[arg] = true
+      end
+    }  
+
+    #check settings
+    settings[:beamer_include] = ( settings[:presentation] or settings[:beamer_article] or settings[:beamer_notes] )
+    if ! (settings.keys - DEF_SETTINGS.keys).empty?
+      puts "Undefined setting #{(settings.keys - DEF_SETTINGS.keys ).inspect}"
+    end
+    @content.each{|frame| 
+      next if ! frame.is_a?(Frame)
+      frame.settings = settings 
+      frame.framepic.picwithname = settings[:picwithname] if settings[:picwithname] and frame.framepic
+    }
+
+    #fixme: Parameter zum setzen.
+    overwrite  = true
+      
+    dir  = File.dirname(filename)  + '/'
+    filename_base = File.basename(filename, '.tex')
+    
+    filename_html  =  "#{filename_base}.html"
+    filename_tex    =  "#{filename_base}.tex"
+    filename_pres  =  "#{filename_base}_screen.tex"
+    filename_artcl  =  "#{filename_base}_print.tex"
+    filename_note  =  "#{filename_base}_notes.tex"
+    filename_att    =  "#{filename_base}_attachment.tex"
+    
+    settings[:filename_att] = filename_att    
+    document = build_document(settings)
+    attachment = build_attachment_doc(settings) if @attachment.size > 0
+    
+    presentation = nil
+    presentation = build_presentation(filename, settings) if settings[:presentation]
+
+    article = nil
+    article = build_article(filename, settings) if settings[:beamer_article]
+    
+    notes = nil
+    notes = build_notes(filename, settings) if settings[:beamer_notes]
+    
+    #Save HTML
+    #~ Parameter zum einstellen:
+    #~ �bersicht mit
+    #~ -text
+    #~ -bild
+    #~ -link zu detail
+    #~ detail mit
+    #~ -bild
+    #~ -text
+    #~ -Aufbau Filename
+    case settings[:html]
+    #Overview contains the title and a link to the detail page
+    when :overview_with_singlepages
+      html_overview = build_html_overview_with_singlepages(dir, filename_html, settings)
+      html_overview.save(   dir + filename_html,  :overwrite => overwrite )
+    #Overview containes picture-thumb and text.
+    #The thumb is linked to a html with picture
+    when  :with_detailpic, :with_detailpic_and_text
+      #Build all picture-HTMLS, named with numbers
+      build_html_with_detailpic(filename_html, settings)
+      document.save(   dir + filename_html,  :overwrite => overwrite )
+    when true
+      document.save(   dir + filename_html,  :overwrite => overwrite )
+    when false  #No action
+    else
+      @log.error("Unknown feature for :html (#{@option[:html]}, #{__FILE__}##{__LINE__})") if @log.error?
+    end
+    
+    #Save TeX/Beamer-class
+    changed = false
+    changed = true if document.save(   dir + filename_tex,  :overwrite => overwrite )  if settings[:beamer_include]
+    changed = true if presentation.save(  dir + filename_pres,  :overwrite => overwrite )  if presentation
+    changed = true if article.save(      dir + filename_artcl,  :overwrite => overwrite )  if article
+    changed = true if notes.save(      dir + filename_note,  :overwrite => overwrite )  if notes
+    changed = true if attachment.save(  dir + filename_att,    :overwrite => overwrite )  if attachment
+
+    if settings[:runtex]
+      if changed
+        Document.runtex( filename_pres, settings[:runtex] )  if presentation
+        Document.runtex( filename_artcl, settings[:runtex] )  if article
+        Document.runtex( filename_note, settings[:runtex] )  if notes
+      else
+        @log.info('No TeX-call (no change in documents)') if @log.info?
+      end
+    end  #runtex
+    if pdftk = settings[:pdftk]
+      pdftk_base = filename_pres.gsub(/\.tex/, '')
+      call_pdftk( "#{pdftk_base}.pdf", "#{pdftk_base}2.pdf", settings[:pdftk])
+    end
+  end  #save_beamer
+  #
+  #Build the content of the presentation.
+  #Will be included to the different main documents.
+  def build_document(settings)
+    
+    document = Document.new(
+      :template => :beamer,
+      :title => title,
+      :shorttitle => settings[:shorttitle],
+      :log  => @log
+      )
+    document.description    =  @description
+    document.keywords    =  @keywords
+    if @bibtex
+    document.head << EMPTYBIBTEX.sub(/>\n/, ">\n%#{@bibtex.gsub(/\n/, "\n%")}\n")
+    else  #Avoid the automatic generation of BibTeX-Entries
+    document.head << element(:span,{},EMPTYBIBTEX).restrict_to(:latex)
+    end
+  
+    if settings[:author].respond_to?(:join)
+      document.author  = settings[:author].join(', ') 
+    elsif settings[:author]
+      document.author  = settings[:author]
+    end
+    document.head<< element(:institute, {}, settings[:institute]) if settings[:institute]
+    document.date    = settings[:date]  if settings[:date]
+    #~ document.logo    = settings[:logo]  if settings[:logo]
+    [ :id, :altlang ].each{|setting|
+      document.meta( setting, settings[setting]) if settings[setting]
+    }
+
+    document.head << element(:subtitle, {}, settings[:subtitle]).restrict_to(:latex)  if settings[:subtitle]
+
+    document.body << element(:maketitle).cr if settings[:maketitle]
+    case settings[:maketoc]
+      when true
+        document.body << element(:tableofcontents).cr
+      when :article
+        document.body << [ 
+            '\only<article>{',
+            element(:tableofcontents),
+            "}\n"
+            ]
+    end  #settings[:maketoc]
+    document.body << @content
+
+    #Collection of attachments 
+    if @attachment.size > 0
+      document.body << element(:span,{},[ '\only<presentation>{',
+        %q|
+          \appendix
+        |.gsub(/^\t*/, ''),
+        element(:input,{}, settings[:filename_att] ).cr,
+        '}%Big Pictures' ]
+        ).restrict_to(:latex)
+    end
+    return document
+  end #build_document
+  #
+  #Build the include to be attached at the end.
+  #This document contains the full-page pictures.
+  def build_attachment_doc(settings)
+      attachment  = Document.new(:template => :include, :log  => @log)
+      attachment.head << EMPTYBIBTEX
+      attachment.body << %q|
+          %
+          % Big Pictures / Plainframes
+          \section{Enlarged Pictures}%\frame{\sectionpage}
+          
+          \usebackgroundtemplate{}
+        |.gsub(/^\t*/, '')
+      @attachment.each{|picname|
+        attachment.body << <<-FRAME
+        \\frame<handout:0>[plain]{%\\frametitle{#{picname}}
+          \\hypertarget{pic:#{picname}}{}
+          \\includegraphicsJustified{#{picname}}
+          }
+          FRAME
+      }
+      return attachment
+  end #build_attachment_doc
+  #
+  #Build the main-tex-document for presentation.    
+  def build_presentation(filename, settings)
+    presentation = Document.new( :template => @settings[:template], :log  => @log )
+    if settings[:language].respond_to?(:join)
+      presentation.language  = settings[:language].join(',') 
+    elsif !settings[:language]
+      presentation.language  = 'ngerman'
+    else
+      presentation.language  = settings[:language]
+    end
+    presentation.add_option(:picwithname)  if settings[:picwithname]
+    presentation.add_option( settings[:classoption] )    if settings[:classoption]
+    
+    #~ @classoptions.each{|opt| presentation.add_option( opt ) }
+    presentation.head << EMPTYBIBTEX
+    
+    if settings[:fullpage]
+      presentation.head << "\\hypersetup{\n" 
+      presentation.head << "\tpdfpagemode=FullScreen,\n" 
+      presentation.head << "}\n" 
+    end
+    presentation.head << @head
+    
+    presentation.head << element(:input, {}, filename).cr
+    presentation
+  end #def build_presentation
+  #
+  #Build the main-tex-document for article.
+  def build_article(filename, settings)
+    if @settings[:template].to_s =~ /festo/i
+      article = Document.new( :template => :beamerFestoarticle, :log  => @log )
+    else
+      article = Document.new( :template => :beamerarticle, :log  => @log )
+    end
+    article.head << EMPTYBIBTEX
+    article.head << @head
+    
+    article.head << "\\input{#{filename}}\n"
+    article.language  = settings[:language].join(',')
+    article.add_option(:picwithname)  if settings[:picwithname]
+    article.add_option( settings[:classoption] )    if settings[:classoption]
+    return article
+  end #build_article
+  #
+  #Build the main-tex-document for notes.
+  #
+  #The following settings are possible:
+  #- show  - Include notes in the output file. Normal slides are also included.
+  #- only    - Include only the notes in the output file and suppresses all frames.
+  #- onlyslideswithnotes  - This includes all notes and those slides that contain a \note.
+  def build_notes(filename, settings)
+    settings[:beamer_notes] = 'only' if settings[:beamer_notes] == true
+    if ! BEAMER_NOTES.include?(settings[:beamer_notes])
+      @log.error("Beamer_Notes settings: unknown #{settings[:beamer_notes].inspect} - use #{BEAMER_NOTES.inspect}") if @log.error?
+    end
+    
+    #~ notes = Document.new( :template => DocumentTemplate[settings[:template]].sub(/<<classoptions>>/, "notes=#{settings[:beamer_notes]},<<classoptions>>") )
+    notes = Document.new( :template => DocumentTemplate[settings[:template]], :log  => @log )
+    notes.add_option("notes=#{settings[:beamer_notes]}")
+    notes.head << EMPTYBIBTEX
+    notes.head << @head
+
+    if settings[:splitscreen]
+      if ! BEAMER_SPLIT_POSITIONS.include?(settings[:splitscreen])
+        @log.error("Undefined option for splitscreen, use 'right'. (allowed: #{BEAMER_SPLIT_POSITIONS.inspect})") if @log.error?
+        settings[:splitscreen] = 'right'
+      end
+      if settings[:beamer_notes] != 'show'
+        @log.info("Use splitscreen without all frames") if @log.info?
+      end
+    notes.head << <<SPLITSCREEN
+\\usepackage{pgfpages}
+\\setbeameroption{show notes on second screen=#{settings[:splitscreen]}}
+SPLITSCREEN
+    end
+    
+    notes.head << "\\input{#{filename}}\n"
+    notes.language  = settings[:language].join(',')
+    notes.add_option(:picwithname)  if settings[:picwithname]
+    notes.add_option( settings[:classoption] )    if settings[:classoption]
+    return notes
+  end #build_notes
+  #Overview contains the title and a link to the detail page
+  def  build_html_overview_with_singlepages(dir, filename_html, settings)
+    #Links needed for navigation
+    @frames.each_with_index{|frame,count|
+      if frame.key
+        frame.html_link  = filename_html.sub(/\.htm/, "_#{frame.key}.htm" )
+      else
+        frame.html_link  = filename_html.sub(/\.htm/, "_#{count}.htm" )
+      end
+    }
+    #Build single files.
+    Knut::Picture.usethumbs  = false
+    @frames.each_with_index{|frame,count|
+      singleframe = Document.new()
+      singleframe.title  = frame.title
+      singleframe.body << html_navigation( count, filename_html )
+      singleframe.body << frame
+      singleframe.body << html_navigation( count, filename_html )
+      singleframe.save(   dir + frame.html_link,  :overwrite => true )  
+    }
+    Knut::Picture.usethumbs  = true
+    #Build main-File
+    html_overview  = Document.new( :log  => @log)
+    html_overview.title = title
+    html_overview.description  =  @description
+    html_overview.keywords    =  @keywords
+    [ :shorttitle, :id, :altlang ].each{|setting|
+      html_overview.meta( setting, settings[setting]) if settings[setting]
+    }
+    @content.each{|frame|
+      if frame.is_a?(Frame)
+        html_overview.body  << element(:p,{},[
+            element(:Rightarrow),
+            preview = element(:a,{:href=>frame.html_link}, frame.title)
+          ]).cr
+        #Add thumb
+        if frame.thumb
+            preview << element(:br )
+            preview << element(:img,{ :src =>frame.thumb} )
+        end
+      else
+        html_overview.body  << frame
+      end
+    }
+    return html_overview
+  end #build_html_overview_with_singlepages
+  #Build all picture-HTMLS, named with numbers
+  def build_html_with_detailpic(filename_html, settings)
+    @frames.each_with_index{|frame,count|
+      filename   = frame.title
+      if frame.framepic
+        filename = File.basename(frame.framepic.picture.filename, '.jpg')
+        #~ filename.gsub!(/\.(jpg|png)/i, '')
+        frame.framepic.picture.href = "./#{filename}.html"
+        frame.framepic.picture.title  = frame.title
+      end
+      frame.html_link = "#{filename}.html"
+    }
+    #Save all HTML for Pictures
+    @frames.each_with_index{|frame,count|
+      next if ! frame.framepic
+      post = []
+      case settings[:html]
+      # only navigation
+      when :with_detailpic
+        post << html_navigation( count, filename_html )
+      # complete content added (Preview + Text
+      when :with_detailpic_and_text
+        frame.content.each{|c|
+          #0=Titel
+          #1=framepic
+          #2=Description in Array
+          case c
+            when Framepic, element(:frametitle).class
+            when Array, WikiFrame, Creole
+              post << c 
+            else
+              #~ puts #{__FILE__}##{__LINE__} c.class, c.inspect
+          end
+        }
+        post << html_navigation( count, filename_html )
+      end
+      
+      frame.framepic.picture.html( 
+            :filename  => frame.html_link,
+            :id      => settings[:id]    ? "#{File.basename(frame.html_link, 'html')}#{settings[:id]}" : nil,
+            :altlang    => settings[:altlang] ? "#{File.basename(frame.html_link, 'html')}#{settings[:altlang]}" : nil,
+            :pre  => html_navigation( count, filename_html ),
+            :post  => post
+          )
+    }        
+  end #build_html_with_detailpic
+  alias :save_beamer :save
+  #
+  def call_pdftk(source, output, pdftksettings)
+    (pdftksettings.keys - [:owner_pw, :user_pw, :allow] ).each{|opt|
+      puts "PDFTK: Undefined option #{opt.inspect}"
+    }
+    pdftkcmd = ["pdftk #{source}"]
+    #~ pdftk << "output #{pdftk_base}_save.pdf"
+    pdftkcmd << "output #{output}"
+    pdftkcmd << "owner_pw #{pdftksettings[:owner_pw]}"  if pdftksettings[:owner_pw]
+    pdftkcmd << "user_pw #{pdftksettings[:user_pw]}"    if pdftksettings[:user_pw]
+    if pdftksettings[:allow]
+      ([pdftksettings[:allow]].flatten - [ 
+          'Printing', 'DegradedPrinting', 
+          'ModifyContents', #                     Also allows Assembly
+          'Assembly',
+          'CopyContents', #Also allows ScreenReaders
+          'ScreenReaders',
+          'ModifyAnnotations',  #Also allows FillIn
+          'FillIn',
+          'AllFeatures',
+        ]).each{|opt|
+        puts "PDFTK/allow: Undefined option #{opt.inspect}"
+      }
+      pdftkcmd << "allow"
+      pdftkcmd << pdftksettings[:allow]
+    end
+    pdftkcmd << "dont_ask"
+    pdftkcmd << "verbose"
+    puts pdftkcmd.join(" ")
+    system(pdftkcmd.join(" "))
+  end  #call_pdftk
+
+  #Return a HTML-element with links to pre- and successor
+  #  <=  ^  =>
+  #
+  def html_navigation( count, filename_html )
+    nav = element(:div, { :style => CSS.new( :text_align => 'center', :clear=>'both' )})
+    if @frames[count - 1] and count > 0
+      nav << element(:a, { :href=> @frames[count - 1].html_link }, element(:Leftarrow)).cr
+    end
+    nav  << element(:a, { :href=> filename_html }, element(:Uparrow)).cr
+    if @frames[count + 1]
+      nav << element(:a, { :href=> @frames[count + 1].html_link }, element(:Rightarrow)).cr
+    end
+    return nav
+  end
+  #Return all used pics.
+  #Can be used to detect new/obsolete pictures in a directory.
+  def used_pics()
+    pics = []
+    @frames.each{|frame|
+      #~ if frame.framepic
+        #~ pics << frame.framepic.picture.filename
+      #~ end
+      if frame.picname
+        pics << frame.picname
+      end
+    }
+    return pics
+  end
+end
+
+
+#
+#Read pictures and build yaml-Template.
+def dir2yaml( pattern, defaults = ''
+  #~ <<-DEFAULTS
+    #~ picwidth: 100%
+    #~ option: left
+    #~ list:
+    #~ # - Punkt 1
+#~ DEFAULTS
+  )
+  defaults.gsub!(/^\s*/, ' ')
+  files2yaml(Dir[pattern])
+end  #dir2yaml
+def files2yaml( files, defaults = '')
+  yaml = []
+  files.each{|f|
+    yaml << '-'
+    yaml << "\tpic: #{f}"
+    yaml << "\ttitle: #{f.gsub(/_|\.png|\.jpg/, ' ')}" if /title:/ !~ defaults
+    yaml << "\twiki: |\n\t\t#~ content" if /wiki:/ !~ defaults
+    yaml << defaults
+
+  }
+  return yaml.join("\n")
+end
+
+#Get something and build the data.
+#input can be:
+#-A file -> read it
+#-A string -> call YAML
+#-Else: I expect a valid array/hash
+def prepare_data( input )
+  data = input
+  lineno = 0
+  if input.is_a?(File)
+    #This is normally DATA, so we start with an offset.
+    lineno = input.lineno
+    input = input.readlines.to_s
+  end
+  if input.is_a?(String)
+    begin
+      data = YAML.load( input.gsub(/\t/, ' ') )
+    rescue ArgumentError
+      if /syntax error on line (.*), col/ =~ $!.to_s
+        lineno += $1.to_i
+        raise "Error in YAML-Input (Line #{lineno}?)"
+      end
+      raise "Error in YAML-Input: #{$!}"
+      raise "Error in YAML-Input: #{$!}\n#{input}"
+    end
+  end
+  return data
+end
+#Takes the yaml-data and make some corrections on it.
+#
+#Example:
+#Add a thumb on each value
+#  puts yaml2yaml(DATA, Proc.new{|y|
+#      y['thumb'] = "thumb_#{y['pic']}"
+#      y
+#    }).to_yaml
+#Problem: Umlaute are converted
+def yaml2yaml( input, corrections )
+  data    = prepare_data( input )  #Array of hashes
+  puts "yaml2yaml: No Proc-element given" if ! corrections.is_a?(Proc)
+  
+  newdata  = []
+  data.each{|props|
+    if ! props.is_a?(Hash)
+      raise "yaml2pres: props is no Hash (#{props.inspect})"
+      next
+    end
+    
+    newdata << corrections.call( props )
+  }
+  newdata
+end
+  
+
+
+
+if __FILE__  == $0
+<<TEMPLATE
+require 'C:/usr/Script/MyScripts' if File.exist?('C:/usr/Script/MyScripts.rb')
+require 'yaml2presentation'
+
+#~ Dir['*.JPG'].each{|f| Knut::Picture.new(f).mk_thumb }
+#~ Dir['*.jpg'].each{|f| Knut::Picture.new(f).mk_thumb }
+TEMPLATE
+
+pres = Presentation.new( 'Pr�sentationen mit yaml2presentation.rb', 
+        :template => :beamerthemetree
+    )
+pres.settings[:shorttitle] = 'yaml2presentation.rb'
+pres.settings[:author] = 'Knut Lickert'
+pres.settings[:date] = Date.today
+#~ pres.settings[:language] << 'Sprache'
+#~ pres.settings[:subtitle] = ''
+pres.head << <<HEADER
+\\AtBeginSection[] % Do nothing for \\section*
+{
+\\frame<beamer>{\\tableofcontents[current]}
+}
+
+\\AtBeginSubsection[]
+{
+\\frame<beamer>{\\tableofcontents[currentsection,currentsubsection]}
+}
+HEADER
+
+pres  << DATA.readlines.to_s.gsub(/\t/, '  ')
+puts pres.build_presentation('XX',{}).to_latex(:log=>pres.log)
+
+pres.save('doc_yaml2presentation',
+    #~ :presentation    => true, 
+    #~ :pdftk        => {
+                      #~ :owner_pw    => 'pw',
+                      #~ :user_pw    => 'pw2',
+                      #~ :allow        => [
+                      #~ 'CopyContents',
+                      #~ 'Printing',
+                      #~ ]
+                    #~ },
+    #~ :beamer_article  => true, 
+    :beamer_notes  => 'show', #/ 'only' / 'onlyslideswithnotes'
+    #~ :splitscreen  => 'bottom'
+    #~ :splitscreen  => 'right'    
+    #~ :html        => true,  #:overview_with_singlepages :with_detailpic
+    :runtex  => true, #:fullpage => true,
+    #~ :picwithname  => true,
+    :maketitle  => true,
+    :maketoc  => true
+    )
+    
+end
+
+#~ -
+  #~ section: �berschrift
+  #~ subsection: �berschrift 2
+  #~ title:  Titel
+  #~ key: key
+  #~ pic: test.jpg
+  #~ pic*: test.jpg
+  #~ picwidth: 12px
+  #~ thumb: thumb.png
+  #~ fragile: true
+  #~ alignment: t
+  #~ pos: left
+  #~ wiki: |
+    #~ Vorher
+    #~ *punkt 1
+    #~ *Punkt 2
+    #~ Nachher
+  #~ notes: |
+    #~ Notizen
+
+__END__
+-
+  section: Grunds�tzliche Idee
+  title:  Einleitung
+  wiki: |
+    Yaml-Syntax zur Erstellung
+    *Beamer-Pr�sentation (LaTeX) (Ersatz mkpres.rb)
+    *Webgalerie  (HTML)  (Ersatz web-gallery.rb)
+    Darstellung eines Frames wahlweise:
+    *Links ein Bild, rechts kurze Beschreibung
+    *Rechts ein Bild, links kurze Beschreibung
+    *Nur Text
+-
+  section: Features
+  subsection: HTML-Galerie
+  title: HTML-Galerie
+  wiki: |
+    *Thumb/Kurzfassung
+    *Langfassung auf Detailseite
+-
+  subsection: TeX/Beamer.sty
+  title: TeX/Beamer
+  #~ pic:  c:/usr/wwwHostEurope/Stummfilm/source/Tonfilm_Kitsch.jpg
+  pos: right
+  wiki: |
+    *Text in Wiki-Notation
+    *Link auf Detailbild am Ende
+-
+  section: Parameter
+  subsection: Gliederung
+  title: Gliederung
+  wiki: |
+    Parameter f�r Gliederungen:
+    *section
+    **sectionshort
+    *subsection
+    **subsectionshort
+    Jeweils in Frames integriert
+-
+  subsection: Optionen zum Frame
+  title: Optionen zum Frame
+  fragile: true
+  wiki: |
+    Bsp:
+        title:  Titel
+        key: key
+    *title: Titel des Frames
+    *key: Optional, f�r label/Link genutzt
+-
+  subsection: Optionen zum Text
+  title: Optionen zum Text
+  fragile: true
+  wiki: |
+    Bsp:
+        fragile: true
+        wiki: |
+        Vorher
+        *punkt 1
+        *Punkt 2
+        Nachher
+        notes: |
+          Notizen
+          
+    *notes: Anmerkungen zum Frame (LaTeX)
+    *fragile: LaTeX, falls Wiki verbatim-Text enth�lt.
+-
+  subsection: Optionen von Bildern
+  title: Bild einf�gen
+  fragile: true
+  wiki: |
+    Bsp:
+      pic: test.jpg
+      pic*: test.jpg
+      PIC: test.jpg
+      thumb: thumb.png
+    *pic: Bildadresse
+    *pic*: Bild mit Link zu Bild in Fullpage am Dokumentende
+    *PIC: Bild in Fullpage
+    *thumb: Vorlage f�r ''pic*'' (sinnvoll f�r HTML)
+-
+  title: Bildoptionen
+  fragile: true
+  wiki: |
+    Bsp:
+      href: http://...
+      picwidth: 12px
+      alignment: t
+      html_class: xx
+      img_class: xx
+    *href: Link auf externe Adresse
+    *alt (HTML)
+    *html\_class (HTML)
+    *img\_class (HTML)
+
+-
+  title: Bildposition
+  fragile: true
+  wiki: |
+    Bsp:
+        pos: left
+    Bildposition relativ zum Text
+    *'''left'''
+    *right
+    *top
+    *bottom
+    Anordnung des Bildes. F�r TeX nur links.
+-
+  title: Bild/Textverh�ltnis
+  fragile: true
+  wiki: |
+    Nur f�r LaTeX.
+    
+    Bsp:
+        framepicratio: 0.25;0.5
+    Bildgr��e und Textgr��e im Verh�ltnis zur Textbreite.
+-
+  subsection: Weitere Optionen
+  title: Option Restrict
+  wiki: |
+    Werte f�r restrict
+    *:latex
+    *:html
+    Ausgabe auf ein Format begrenzen.
+-
+  title: Option pdftk
+  wiki: |
+    Mit der Option ''pdftk'' wird mittels pdftk eine zweite 
+    Screen-Version erzeugt.
+    
+    Optionen:
+    *owner\_pw
+    *user\_pw
+    *allow: Ausnahmen f�r Verbote, wenn Passwort gesetzt.