docgenerator 0.1.1 → 1.0.2

data/docgenerator.rb

@@ -1,137 +0,0 @@
-#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_template.rb

@@ -1,103 +0,0 @@
-if __FILE__ == $0
-	require 'DocGenerator' 
-end
-
-class DocumentTemplate
-	@@templates	= {}
-	def DocumentTemplate.add_template( key, target, template)
-		@@templates[key] = template.gsub(/^\t*/, '')	#fixme check uniqi
-		case target
-		when nil
-		when :latex
-			SUPPORTED_LaTeX_TEMPLATES	<< key
-		when :html
-			SUPPORTED_HTML_TEMPLATES	<< key
-		end
-	end
-	def DocumentTemplate.[]( key )
-		if @@templates[key]
-			return @@templates[key].dup
-		else
-			puts "Template unknown: #{key}"
-			return nil
-		end
-	end
-	def DocumentTemplate.keys()
-		return @@templates.keys
-	end
-end
-
-
-DocumentTemplate.add_template( 
-	:include, :latex, %q|<<prefix>>
-		% ----------------------------------------------------------------
-		<<head>>
-		% ----------------------------------------------------------------
-		<<body>>
-		% ----------------------------------------------------------------
-	|)
-	
-DocumentTemplate.add_template( 
-	:article, :latex, %q|<<prefix>>
-		\documentclass[<<classoptions>>]{scrartcl}
-		\usepackage{babel}
-		\usepackage[ansinew]{inputenc}
-		\usepackage{hyperref}
-		% ----------------------------------------------------------------
-		<<head>>
-		% ----------------------------------------------------------------
-		\begin{document}
-		<<body>>
-		\end{document}
-		% ----------------------------------------------------------------
-	|)
-#~ DocumentTemplate.add_template( 
-	#~ :report, '',
-	#~ |)
-#~ DocumentTemplate.add_template( 
-	#~ :book, '',
-	#~ |)
-
-		#~ <!doctype html public "-//W3C//DTD XHTML 1.0 Strict//EN"   "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
-
-DocumentTemplate.add_template( 
-	:html, :html, %q|<!--
-		<<prefix>>
-		-->
-		<!doctype html public "-//W3C//DTD HTML 4.01 Transitional//EN">
-		<html>
-		<<head>>
-		<<body>>
-		</html>
-		|)
-
-{
-	:xhtml_strict	=> '<!DOCTYPE HTML PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN"  "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">',
-	:xhtml_trans	=> '<!DOCTYPE HTML PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"  "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">',
-	:html401_strict	=> '<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01//EN" "http://www.w3.org/TR/html4/strict.dtd">',
-	:html401_trans	=> '<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">',
-}.each{ |key, doctype|
-	DocumentTemplate.add_template( 
-		key, :html, %Q|<!--
-			<<prefix>>
-			-->
-			#{doctype}
-			<html>
-			
-			<<head>>
-			
-			<<body>>
-			</html>
-			|)
-}
-
-
-
-DocumentTemplate.add_template( 
-	:text, :text, %q|
-		<<body>>
-	|)
-DocumentTemplate.add_template( 
-	:wiki, :wiki, %q|
-		<<body>>
-	|)

data/packages/docgenerator_beamer.rb

@@ -1,250 +0,0 @@
-#
-# The text 'Beamer' must be part of this template.
-# Without it, the title-Class will not use the short version for title.#
-#
-DocumentTemplate.add_template(:beamer, :latex, %q|<<prefix>>
-	% ----------------------------------------------------------------
-	% For Usage with Beamer
-	% ----------------------------------------------------------------
-	<<head>>
-	% ----------------------------------------------------------------
-	\begin{document}
-	<<body>>
-	\end{document}
-	% ----------------------------------------------------------------
-|.gsub(/^\t*/, ''))
-DocumentTemplate.add_template(:beamerhead, :latex, %q|<<prefix>>
-	\documentclass[<<classoptions>>]{beamer}
-	%<<theme>>
-	\usepackage{babel}
-	\usepackage[ansinew]{inputenc}
-	\usepackage{beamertool}
-	\usepackage{hyperref}
-	% ----------------------------------------------------------------
-	<<head>>
-|.gsub(/^\t*/, ''))
-[	
-	:beamerthemebars, :beamerthemeboxes, :beamerthemeclassic,
-	:beamerthemelined, :beamerthemeplain, :beamerthemesidebar,
-	:beamerthemesidebardark, :beamerthemesidebardarktab,
-	:beamerthemesidebartab, :beamerthemesplit,
-	:beamerthemesplitcondensed, :beamerthemetree,
-	:beamerthemevcd,
-].each{ |theme|
-	DocumentTemplate.add_template(theme, :latex, DocumentTemplate[:beamerhead].sub(/%<<theme>>/, "\\usepackage{#{theme}}"))
-}
-DocumentTemplate.add_template(:beamerarticle, :latex, %q|<<prefix>>
-	\documentclass[class=scrartcl,<<classoptions>>]{beamer}
-	\usepackage{babel}
-	\usepackage{beamerbasearticle}
-	\usepackage[article]{beamertool}
-	\usepackage[ansinew]{inputenc}
-	\usepackage{hyperref}
-	% ----------------------------------------------------------------
-	<<head>>
-|.gsub(/^\t*/, ''))
-
-
-#Define TeX-Kommands
-
-#frame -- environment.
-#options
-#~ Element.create( :frame, {}, true, {
-	#~ :latex => '#{linebreak(@crbefore)}\frame{#{@content}}#{linebreak(@crafter)}'
-	#~ } )
-	
-class Frame < Element
-	add_attributes( {
-		:options	=> Attribute.create( [ :latex ], [nil, 'fragile', 't', 'b'] ),
-	}.update( HTML_ATTR_ALL ) )
-	Element.add( [:frame],  Frame)
-	#Returns a div-element.
-	#The class for the css is set to 'frame' (if not defined before).
-	def htmltag( )
-		if @attr[:class].content.empty?
-			@attr[:class]	<< :frame
-		end
-		'div' 
-	end
-	def to_latex( )
-		option	= "[#{@attr[:options].content.join(',')}]"
-		option	= nil if option == '[]'
-		#~ return "#{linebreak(@crbefore)}\\frame#{option}{\n#{@content}}#{linebreak(@crafter)}"
-		return "#{linebreak(@crbefore)}\\begin{frame}#{option}\n#{@content}\n\\end{frame}#{linebreak(@crafter)}"
-	end
-end
-
-#
-#Frametitle.
-#Can be changed by
-#	Element.get( :frametitle ).class_eval( "def htmltag(); 'h4'; end")
-Element.create( :frametitle, { }, true, {
-	:latex	=> '#{linebreak(@crbefore)}\frametitle{#{@content}}#{linebreak(@crafter)}',
-	:htmltag	=> 'p', #'h4',
-	:html	=> '#{linebreak(@crbefore)}<#{htmltag} class = "frametitle">#{@content}</#{htmltag}>#{linebreak(@crafter)}',
-	} )
-
-Element.create( :block, {
-		:title	=> Attribute.create( [ :latex ] ),
-	}, true, {
-		:latex => '#{linebreak(@crbefore)}' + '\begin{block}{#{@attr[:title]}}' + '#{linebreak(@crmid)}' + '#{@content}\end{block}' + '#{linebreak(@crafter)}'
-	} )
-
-#
-# Notes in Beamer.
-#
-Element.create( :note, { }, true, {
-	:latex	=> '#{linebreak(@crbefore)}\note{#{@content}}#{linebreak(@crafter)}',
-	:htmltag	=> 'p', #'h4',
-	:html	=> '#{linebreak(@crbefore)}<#{htmltag} class = "note">#{@content}</#{htmltag}>#{linebreak(@crafter)}',
-	} )
-
-#\framePic{filename}{
-#	description
-#}
-#~ Element.create( :framepic, {	:file	=> Attribute.create( [ :required ] ), 
-					#~ :link	=> Attribute.create( )
-				#~ }, true, {
-	#~ :latex => '\framePic{#{@attr[:file]}}{#{@content}}'
-	#~ } )
-
-Element.create( :institute, {
-	}, true, {
-		:latex => '#{linebreak(@crbefore)}' + '\institute{#{@content}}' + '#{linebreak(@crafter)}'
-	} )
-
-Element.create( :subtitle, {
-	}, true, {
-		:latex => '#{linebreak(@crbefore)}' + '\subtitle{#{@content}}' + '#{linebreak(@crafter)}'
-	} )
-
-begin
-#define Knut::Picture
-require 'knut_picture'
-rescue
-	#Define Knut::Picture with reduced functionality
-	module Knut
-	class Picture
-		def initialize( filename )	
-			@filename		= filename
-			@basename	= File.basename(@filename)
-			@dir				= File.dirname(@filename)
-			if ! File.exists?( @filename )
-				puts "#{self.class}: #{@filename} not found"
-			else
-				@size			= File.size(@filename)
-				@sizekb		= @size / 1024
-			end
-		end
-		#Filename including the path
-		attr_reader :filename
-		#Directory of the picture
-		attr_reader :dir
-		attr_reader :basename
-		def tech_description()
-			"#{@basename} (#{@sizekb}KB)"
-		end		
-	end
-	end
-end
-
-class Framepic < Element
-	Element.add( [:framepic],  Framepic)
-	add_attributes( {	
-					:file			=>	Attribute.create( [ :required ] ), 
-					:link			=>	Attribute.create( ),
-				}.update( HTML_ATTR_ALL ) )
-	#container for the picture
-	def picture()
-		@picture = Knut::Picture.new( @attr[:file].content.first ) if ! @picture
-		@picture
-	end
-	attr_accessor :div_css
-	attr_accessor :img_css
-	attr_accessor :div_class
-	attr_accessor :img_class
-	attr_accessor :picwithname
-	def to_html()
-		html = []	#element(:div, {:class => :framepic })
-		#~ if @attr[:link].content.size > 0
-			#~ html << "[#{@attr[:link]}]"
-		#~ end
-			
-		html << div_img	= element(:div ).CR
-		if self.picture.href
-			div_img	<< element(:a, { :href => self.picture.href },
-										img = element(:img )
-								)
-		else
-			div_img	<< img = element(:img )
-		end
-		if self.picture.thumbname	and self.picture.usethumb?
-			img[:src] << self.picture.thumbname
-		else
-			img[:src] << self.picture.filename
-		end
-		@div_css	 = CSS.new() if ! @div_css	
-		div_img[:class]	<< @div_class if @div_class 
-		div_img[:style]	<< @div_css	
-		div_img[:align]	<< 'center'	if div_img[:align].content.empty?
-		img[:class]		<< @img_class if @img_class 
-		img[:style]		<< @img_css	if @img_css
-		if picwithname
-			div_img	<< element(:br ).cr
-			div_img	<< element(:footnotesize, {}, self.picture.tech_description)
-		end
-		html	<< @content
-		return html.to_s
-	end
-	def to_latex()
-		result = ""
-		result << "\n" if @crbefore
-		result << "\\framePic"
-		if self.div_css	#Check alignment
-			case self.div_css[:float]
-				when nil, 'left'	#standard
-				when 'right'
-					result << "[right]"
-				else
-					puts "#{__FILE__}##{__LINE__}: Undefined float '#{self.div_css[:float]}' for TeX"
-				end
-		end
-		result << "{#{self.picture.filename}}"
-		if @attr[:link].content.size > 0
-			result << "[#{@attr[:link]}]"
-		end
-		result << "{"
-		result << "\n" if @crmid
-		result << "#{@content}"
-		result << "\n" if @crmid
-		result << "}"
-		result << "\n" if @crafter
-		return result
-	end
-end
-
-
-Element.create( :includegraphicsJustified, {}, true, {
-	:latex	=> '\includegraphicsJustified{#{@content}}',
-	:html	=> '<img src = "#{@content}" style = "max-width: 80%" />',
-	} )
-
-#fixme --> docgenerator_color ?
-class Textcolor < Element
-	Element.add( [:textcolor],  Textcolor)
-	add_attributes( {	:mode	=> Attribute.create( [ :required ], [:rgb] ), 
-					:color	=> Attribute.create( [ :required ], [String] ),
-				} ) 
-	def to_latex()
-		result = ""
-		result << "\n" if @crbefore
-		result << "\\textcolor[#{attr[:mode]}]{#{@attr[:color]}}"
-		result << "\n" if @crmid
-		result << "{"
-		result << "#{@content}"
-		result << "\n" if @crmid
-		result << "}"
-		result << "\n" if @crafter
-		return result
-	end
-end