docgenerator 0.1.1

data/docgenerator_footnote.rb

@@ -0,0 +1,106 @@
+#
+# Footnotes
+#
+class Footnote < Element
+	@@group = Hash.new()
+	Element.add( [:footnote ],  Footnote)
+	add_attributes( 		{
+			:counter => Attribute.create(),
+			:groupid => Attribute.create()
+		}.update(HTML_ATTR_ALL)
+	) 
+	def counter()
+		if ! @attr[:counter].filled?
+			groupid = @attr[:groupid].content[0]
+			if  ! @@group[groupid]
+				@@group[groupid] = Footnotegroup.get( groupid )
+			end
+			@@group[groupid] << self
+			@attr[:counter]		<< @@group[groupid].size
+		end
+		return @attr[:counter]
+	end
+	def to_html( )
+		cmd	= ''
+		cmd	<<	"\n" if @crbefore
+		if Footnotegroup.get( @attr[:groupid].content[0] ).html_link
+			cmd	<<	"<sup><a href=\"#foot#{counter}\">#{counter}</a></sup>"
+		else
+			cmd	<<	"<sup>#{counter}</sup>"
+		end
+		cmd	<<	"\n" if @crafter
+		return cmd
+	end
+	def to_latex( )
+		cmd	= ''
+		cmd	<<	"\n" if @crbefore
+		cmd	<<	"\\footnote{#{@content}}"
+		cmd	<<	"\n" if @crafter
+		return cmd
+	end
+	def to_text()
+		return '#{linebreak(@crbefore)}' +  "- #{@content}" + ' #{linebreak(@crafter)}'
+	end
+	def get_content()
+		return @content
+	end
+end
+
+class Footnotegroup
+	@@all	= { }
+	#Use
+	#	Footnotegroup.get
+	#to get the collected footnotes.
+	#It is not a good idea to use this with LaTeX, because LaTeX makes it automatic.
+	#(But you can try it with tables.
+	def self.get( groupid = nil )
+		if ! @@all[groupid]
+			@@all[groupid] = self.new( groupid )
+		end
+		return @@all[groupid]
+	end
+	def initialize( groupid )
+		@groupid		= groupid
+		@footnotes	= []
+		@attr		= {}
+		@html_link	= true
+	end
+	#Flag, if the footnote and the footnote mark should be linked.
+	attr_accessor :html_link
+	def attr=( attr )
+		@attr = attr
+	end
+	def <<( footnote )
+		@footnotes	<< footnote
+	end
+	def size()
+		return @footnotes.size
+	end
+	def to_s()
+		return '' if @footnotes.size == 0
+		ul = element(:p, @attr ).cr
+		@footnotes.each{|f|
+			#~ ul << element(:sup, {}, f.counter )
+			ul << footnotemark = element(:sup )
+			if @html_link
+				footnotemark  << element(:label, { :name => "foot#{f.counter}" }, f.counter )
+			else
+				footnotemark  << f.counter
+			end
+			ul << f.get_content
+			ul << element(:br).cr
+		}
+		return ul.to_s
+	end
+end
+
+
+Element.create( [:footnotemark ], {}.update(HTML_ATTR_ALL),true, 
+	{	:htmltag	=> 'sup',
+		:latex	=> '#{linebreak(@crbefore)}\footnotemark[#{@content}]#{linebreak(@crafter)}'	#fixme
+	} )
+
+
+__END__
+	txt << f = element(:footnote,{:groupid=>1}, 'eins/Gruppe 1')
+	txt << Footnotegroup.get()

data/docgenerator_lists.rb

@@ -0,0 +1,163 @@
+
+#Generell class for list environments
+class ListEnvironment < Environment
+	add_attributes( HTML_ATTR_ALL ) 
+	#Only items are allowed to be added.
+	#
+	#If an array is given, each item is added on it 
+	def << ( item)
+		if item.is_a?(Array)
+			item.each{|it| self << it }
+		else
+			if self.class == Description
+				#fixme: Reihenfolge
+				if ! ( item.is_a?( Element.get(:dt) ) or item.is_a?( Element.get(:dd) ) )
+					puts "Add non-item to list (#{item.class} #{@called_by})"
+				end
+			elsif ! item.is_a?( Element.get(:item) )
+				puts "Add non-item to list (#{item.class} #{@called_by})"
+			end
+			@content << item
+			set_backlink( item )
+		end
+	end
+	def to_wiki( )
+		res = "#{@content}\n"
+		return res.gsub(/\n\n/, "\n")
+	end
+	alias :to_text :to_wiki
+end
+class Itemize < ListEnvironment
+	add_attributes( HTML_ATTR_ALL ) 
+	Element.add( [:ul, :itemize],  Itemize)
+	def htmltag(); 'ul'; end
+	def to_latex( )
+		return to_latex_environment( 'itemize' )
+	end
+end
+class Enumerate < ListEnvironment
+	add_attributes( HTML_ATTR_ALL ) 
+	Element.add( [:ol, :enumerate],  Enumerate)
+	def htmltag(); 'ol'; end
+	def to_latex( )
+		return to_latex_environment( 'enumerate' )
+	end
+end
+#
+#
+#HTML:
+#	<dl>
+#	<dt> <dd>
+#	</dl>
+class Description < ListEnvironment
+	add_attributes( HTML_ATTR_ALL ) 
+	Element.add( [:description, :dl],  Description)
+	def htmltag(); 'dl'; end
+	def to_latex( )
+		return to_latex_environment( 'description' )
+	end
+end
+
+#
+#Item line in a list.
+#The look will be defined by the environment where it is in (itemize/ul, enumerate/ol)
+#
+#bug to_html 
+class Item < Element
+	Element.add( [:li, :item],  Item)
+	add_attributes( 		{
+			:text => Attribute.create( [ :latex ] )
+		}.update(HTML_ATTR_ALL)
+	)
+	def htmltag(); 'li'; end
+	def to_latex( )
+		cmd	= ''
+		cmd	<<	"\n" if @crbefore
+		cmd	<<	"\n\\item "
+		cmd	<<	"[#{@attr[:text]}] " if @attr[:text].filled?
+		cmd	<<	@content.to_s
+		cmd	<<	"\n" if @crafter
+		return cmd
+	end
+	def to_text()
+		cmd	= ''
+		cmd	<<	"\n" if @crbefore
+		cmd	<<	"- #{@content}"
+		cmd	<<	"\n" if @crafter
+		return cmd
+	end
+	#fixme geschachtete 
+	#-	** auf stufe 2
+	#-	kein * wenn als n�chstes eine Liste kommt.
+	def to_wiki()
+		cmd	= ''
+	#~ puts part_of.inspect
+		if part_of.size != 1
+			puts ":li/wiki: Unclear list type #{part_of.inspect}"
+		else
+			list = part_of[0]
+		end
+		#~ cmd	<<	"\n" if @crbefore
+		case list.class.to_s.to_sym
+		when :Itemize
+			cmd	<<	"\n* #{@content}"
+		when :Enumerate
+			cmd	<<	"\n# #{@content}"
+		else
+			puts ":li/wiki: Unknown list type #{part_of.inspect}"
+			cmd	<<	"\n* #{@content}"
+		end
+		#~ cmd	<<	"\n" if cmd[-1,1] != "\n"
+		cmd	<<	"\n" if @crafter and cmd[-1,1] != "\n"
+		return cmd
+	end
+end	#Item
+
+#HTML:
+#	<dl>
+#	<dt> <dd>
+#	</dl>
+class DT < Element
+	Element.add( [:dt],  DT)
+	add_attributes( HTML_ATTR_ALL ) 
+	def htmltag(); 'dt'; end
+	def to_text();	"\n#{@content}: " end
+	def to_wiki()
+		cmd	= ''
+		cmd	<<	"\n" if @crbefore
+		cmd	<<	"\n;#{@content}"
+		cmd	<<	"\n"
+		return cmd
+	end
+	def to_latex( )
+		cmd	= ''
+		cmd	<<	"\n" if @crbefore
+		cmd	<<	"\n\\item[#{@content}] "
+		cmd	<<	"\n" if @crafter
+		return cmd
+	end
+end
+#HTML:
+#	<dl>
+#	<dt> <dd>
+#	</dl>
+class DD < Element
+	Element.add( [:dd],  DD)
+	add_attributes( HTML_ATTR_ALL ) 
+	def htmltag(); 'dd'; end
+	def to_text(); "\n\t#{@content}\n" end
+	def to_wiki()
+		cmd	= ''
+		cmd	<<	"\n" if @crbefore
+		cmd	<<	"\n:#{@content}"
+		cmd	<<	"\n"
+		return cmd
+	end
+	def to_latex( )
+		cmd	= ''
+		cmd	<<	"\n" if @crbefore
+		cmd	<<	" #{@content} "
+		cmd	<<	"\n" if @crafter
+		return cmd
+	end
+end

data/docgenerator_sections.rb

@@ -0,0 +1,88 @@
+#
+#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 "\\hypertarget{#{id}}{}"
+end
+
+#Fixmes:
+#-	addsec 
+#-	article/report
+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( [:minisec],			7,	'h5', '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}" + 
+								'#{texoptional(:short)}'	+
+								'{#{@content}}' +
+								'#{hypertarget(@attr[:id])}' +
+								'#{linebreak(@crafter)}',
+			:text	=> "\n" + '#{linebreak(@before)}#{@content}' + "\n" + 
+								' ' * s.wiki * 2 + '-' * 30 + "\n"  + '#{linebreak(@crafter)}',
+			:wiki	=> '#{linebreak(@crbefore)}' + "\n" + '='* (s.wiki ) + '#{@content}' + '='* (s.wiki) + "\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
+
+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