docgenerator 1.2.1 → 2.0.0

data/lib/docgenerator/packages/attachfile.rb

@@ -0,0 +1,136 @@
+module Docgenerator
+module Packages
+=begin rdoc
+Support for attachfile.sty.
+=end
+module Attachfile
+#Options for Support for Attachfile
+ATTACHFILE_OPTIONS = 	{
+		:author		=>	Attribute.create( [ :texkeyval], [ String ] ),
+		:description=>	Attribute.create( [ :texkeyval], [ String ] ),
+		:subject	=>	Attribute.create( [ :texkeyval], [ String ] ),
+		:icon			=>	Attribute.create( [ :texkeyval], [ 	'Graph', 'Paperclip', 'PushPin', 'Tag' ] ),
+		:mimetype=>	Attribute.create( [ :texkeyval], [ 	
+										'text/plain',
+										'video/mpeg',
+								] ),
+}
+
+=begin rdoc
+Define Element :attachfile
+
+Create an instance with
+  element( :attachfile, [ attributes, [content]] )
+or
+  Attachfile.new( [ attributes, [content]] )
+Attributes may be:
+* :author: 
+* :description: 
+* :subject: 
+* :icon: 
+* :mimetype: 
+=end
+class Attachfile < Element
+  add_attributes ATTACHFILE_OPTIONS
+  add_latex_output '#{linebreak(@crbefore)}\attachfile[#{texkeyval()}]{#{@content}}#{linebreak(@crafter)}'
+end #Attachfile
+
+=begin rdoc
+Define Element :noattachfile
+
+Create an instance with
+  element( :noattachfile, [ attributes, [content]] )
+or
+  Noattachfile.new( [ attributes, [content]] )
+Attributes may be:
+* :author: 
+* :description: 
+* :subject: 
+* :icon: 
+* :mimetype: 
+=end
+class Noattachfile < Element
+  has_no_content false
+  add_attributes ATTACHFILE_OPTIONS
+  add_latex_output '#{linebreak(@crbefore)}\noattachfile[#{texkeyval()}]#{linebreak(@crafter)}'
+end #Noattachfile
+
+=begin rdoc
+Define Element :textattachfile
+
+Create an instance with
+  element( :textattachfile, [ attributes, [content]] )
+or
+  Textattachfile.new( [ attributes, [content]] )
+Attributes may be:
+* :text: 
+* :author: 
+* :description: 
+* :subject: 
+* :icon: 
+* :mimetype: 
+=end
+class Textattachfile < Element
+ add_attributes ATTACHFILE_OPTIONS
+ add_attribute :text, Attribute.create( [], [ String ] )
+ add_latex_output '#{linebreak(@crbefore)}\textattachfile[#{texkeyval()}]{#{@content}}{#{@attr[:text]}}#{linebreak(@crafter)}'
+end #Textattachfile
+
+=begin rdoc
+Define Element :notextattachfile
+
+Create an instance with
+  element( :notextattachfile, [ attributes, [content]] )
+or
+  Notextattachfile.new( [ attributes, [content]] )
+Attributes may be:
+* :text: 
+* :author: 
+* :description: 
+* :subject: 
+* :icon: 
+* :mimetype: 
+=end
+class Notextattachfile < Element
+  has_no_content false
+  add_attribute :text, Attribute.create( [], [ String ] )
+  add_attributes ATTACHFILE_OPTIONS
+  add_latex_output '#{linebreak(@crbefore)}\notextattachfile[#{texkeyval()}]{#{@attr[:text]}}#{linebreak(@crafter)}'
+end #Notextattachfile
+
+end #module Docgenerator
+end #module Attachfile
+end # module Packages
+__END__
+doc.body	<< element(:usepackage,{ }, 'listings').cr
+	\attachfilesetup {hoptionsi}
+
+==Options==
+	appearance=hbooleani
+	author=htexti
+	color=hredi hgreeni hbluei
+	date=htexti
+	description=htexti
+	subject=htexti
+	icon=hnamei
+		Graph
+		Paperclip
+		PushPin
+		Tag	
+	mimetype=htypei
+	print=hbooleani
+	timezone=hoffseti
+	zoom=hbooleani
+
+	Option Default setting
+	appearance true
+	author none
+	color 1 0.9255 0.7765
+	date automatic
+	description none
+	subject none
+	icon PushPin
+	mimetype none
+	print true
+	timezone none
+	zoom true

data/lib/{packages/docgenerator_caption.rb → docgenerator/packages/caption.rb}

@@ -1,8 +1,16 @@
+=begin rdoc
+Support for caption.sty.
+=end
+
 #
-#Support for caption.sty.
-#-
-#
+module Docgenerator
+module Packages
+=begin rdoc
+Support for caption.sty.
 
+* http://www.ctan.org/tex-archive/macros/latex/contrib/caption/
+=end
+module Caption
 #~ Element.create( [:captionof], {
 			#~ :float_type =>	Attribute.create( [ :latex, :required ], [ 'figure', 'table' ] ),
 			#~ :lst_entry =>	Attribute.create( [ ], [ String ] ),
@@ -10,34 +18,35 @@
 		#~ :latex	=> '#{linebreak(@crbefore)}\captionof{#{@attr[:float_type]}}[#{@attr[:lst_entry]}]{#{@content}}#{linebreak(@crafter)}',
 			#~ })
 
-#
-#
+=begin rdoc
+Macro defined by caption.sty.
+
+=end
 class Captionof < Element
-	#Make the key known to the complete key-list of elements.
-	Element.add( [:captionof],  Captionof)
 	#~ add_attributes( HTML_ATTR_ALL ) 
-	add_attributes( {
-			:float_type =>	Attribute.create( [ :latex, :required ], [ 'figure', 'table' ] ),
-			:lst_entry =>	Attribute.create( [ ], [ String ] ),
-		} ) 
+	add_attribute :float_type, Attribute.create( [ :latex, :required ], [ 'figure', 'table' ] )
+	add_attribute :lst_entry, Attribute.create( [ ], [ String ] )
 	
 	#Redefine standard output. 
 	#Options are given, if an option is avalaible.
-	def to_latex()
+	add_latex_output  { | options = {} |
 		cmd = linebreak(@crbefore)
 		cmd << "\\captionof{#{@attr[:float_type]}}"
 		#Empty [] would return empty entry for list of figures,
 		cmd << "[#{@attr[:lst_entry]}]" if @attr[:lst_entry].content?
 		cmd << "{#{@content}}"
 		cmd << linebreak(@crafter)
-		return cmd
-	end
-	def htmltag(); 'span'; end	#fixme
-	#~ def to_html()
-		#~ return ''
-	#~ end
-end	#Usepackage
+		
+    cmd
+  }
+    
+	add_html_tag 'span' #fixme
+  
+end	#Captionof
 
+end #module Caption
+end #module Packages
+end #module Docgenerator
 __END__
 
 C:\proTeXt\texmf\doc\latex\caption

data/lib/docgenerator/packages/hyperref.rb

@@ -0,0 +1,194 @@
+module Docgenerator
+module Packages
+=begin rdoc
+Support of package hyperref.sty
+=end
+module Hyperref
+
+=begin rdoc
+Dynamic PDF-Features
+=end
+class HyperrefForm < Environments::Environment
+	add_attribute:options, Attribute.create( [ :latex ], [nil] )
+	add_id :Form
+  
+	add_latex_output {| options = {} |
+      option	= "[#{@attr[:options].content.join(',')}]"
+      option	= nil if option == '[]'
+      to_latex_environment( 'Form', option, options )
+    }
+end
+
+=begin rdoc
+Define Element :Reset
+
+Create an instance with
+  element( :Reset, [ attributes, [content]] )
+or
+  Reset.new( [ attributes, [content]] )
+Attributes are not defined for this element.
+=end
+class Reset < Element
+  add_latex_output '#{linebreak(@crbefore)}\Reset{#{@content}}#{linebreak(@crafter)}'
+end #Reset
+
+=begin rdoc
+Define Element :CheckBox
+
+Create an instance with
+  element( :CheckBox, [ attributes, [content]] )
+or
+  Checkbox.new( [ attributes, [content]] )
+Attributes may be:
+* :name: 
+* :onclick: 
+* :onblur: 
+=end
+class Checkbox < Element
+  add_attribute :name, Attribute.create( [ :texkeyval ] )
+  add_attribute :onblur, Attribute.create( [ :texkeyval ] )
+  add_attribute :onclick, Attribute.create( [ :texkeyval ] )
+  
+  add_latex_output '#{linebreak(@crbefore)}\CheckBox[#{texkeyval()}]{#{@content}}#{linebreak(@crafter)}'
+end #Checkbox
+
+=begin rdoc
+Define Element :PushButton
+
+Create an instance with
+  element( :PushButton, [ attributes, [content]] )
+or
+  Pushbutton.new( [ attributes, [content]] )
+Attributes may be:
+* :onclick: 
+* :width: 
+* :height: 
+* :borderstyle: 
+* :bordercolor: 
+* :color: 
+* :backgroundcolor: 
+=end
+class Pushbutton < Element
+  add_attribute :width, Attribute.create( [ :texkeyval ], nil, 5)	#regexp not supported - CSS_WIDTH
+  add_attribute :height, Attribute.create( [ :texkeyval ], nil, 6)	#regexp not supported - CSS_WIDTH
+  add_attribute :borderstyle, Attribute.create( [ :texkeyval ], ['S', 'D', 'B', 'I', 'U'], 10 )	#S (solid, durchgehend), D (dashed, gestrichelt), B (beveled, erh�ht), I (inset, versenkt), U (unterstrichen)
+  add_attribute :bordercolor, Attribute.create( [ :texkeyval ], nil, 11 )
+  add_attribute :color, Attribute.create( [ :texkeyval ], nil, 15 )
+  add_attribute :backgroundcolor, Attribute.create( [ :texkeyval ], nil, 15 )
+  add_attribute :onclick, Attribute.create( [ :texkeyval ] )
+		#~ :onload	=> Attribute.create( [ :texkeyval ] ), - niht definiert
+		#~ :onmousemove	=> Attribute.create( [ :texkeyval ] ),	nee, ghet nicht  
+  add_latex_output '#{linebreak(@crbefore)}\PushButton[#{texkeyval()}]{#{@content}}#{linebreak(@crafter)}'
+end #Pushbutton
+
+=begin rdoc
+Define Element :ChoiceMenu
+
+Create an instance with
+  element( :ChoiceMenu, [ attributes, [content]] )
+or
+  Choicemenu.new( [ attributes, [content]] )
+Attributes may be:
+* :name: 
+* :onblur: 
+* :default: 
+* :type: 
+* :width: 
+* :height: 
+* :borderstyle: 
+* :bordercolor: 
+* :color: 
+* :backgroundcolor: 
+=end
+class Choicemenu < Element
+  add_attribute :name, Attribute.create( [ :required ] )
+  add_attribute :onblur, Attribute.create( [ :texkeyval ] )
+  add_attribute :default, Attribute.create( [ :texkeyval ] )
+  add_attribute :type, Attribute.create( [], ['combo', 'radiobutton'] )
+  add_attribute :width, Attribute.create( [ :texkeyval ], nil, 5)#regexp not supported - CSS_WIDTH
+  add_attribute :height, Attribute.create( [ :texkeyval ], nil, 6)#regexp not supported - CSS_WIDTH
+  add_attribute :borderstyle, Attribute.create( [ :texkeyval ], ['S', 'D', 'B', 'I', 'U'], 10 )
+  add_attribute :bordercolor, Attribute.create( [ :texkeyval ], nil, 11 )
+  add_attribute :color, Attribute.create( [ :texkeyval ], nil, 15 )
+  add_attribute :backgroundcolor, Attribute.create( [ :texkeyval ], nil, 15 )
+  add_latex_output '#{linebreak(@crbefore)}\ChoiceMenu[#{@attr[:type]},#{texkeyval()}]{#{@attr[:name]}}{#{@content}}#{linebreak(@crafter)}'
+end #Choicemenu
+
+=begin rdoc
+Define Element :TextField
+
+Create an instance with
+  element( :TextField, [ attributes, [content]] )
+or
+  Textfield.new( [ attributes, [content]] )
+Attributes may be:
+* :onclick: 
+* :onblur: 
+* :name: 
+* :password: 
+* :width: 
+* :height: 
+* :align: 
+* :borderstyle: 
+* :bordercolor: 
+* :color: 
+* :backgroundcolor: 
+* :multiline: 
+* :readonly: 
+* :hidden: 
+* :value: 
+* :validate: 
+* :format: 
+=end
+class Textfield < Element
+  add_attribute :onclick, Attribute.create( [ :texkeyval ] )
+  add_attribute :onblur, Attribute.create( [ :texkeyval ] )	#Action, when value changed
+  add_attribute :name, Attribute.create( [ :texkeyval ], [String, Symbol], 1 )
+  add_attribute :password, Attribute.create( [ :texkeyval ], nil, 3)	#Ausgabe als *****
+  add_attribute :width, Attribute.create( [ :texkeyval ], nil, 5)
+  add_attribute :height, Attribute.create( [ :texkeyval ], nil, 6)
+  add_attribute :align, Attribute.create( [ :texkeyval ], [0,1,2], 7)	#0=links, 1= center, 2 = right
+  add_attribute :borderstyle, Attribute.create( [ :texkeyval ], ['S', 'D', 'B', 'I', 'U'], 10 )
+  add_attribute :bordercolor, Attribute.create( [ :texkeyval ], nil, 11 )
+  add_attribute :color, Attribute.create( [ :texkeyval ], nil, 15 )
+  add_attribute :backgroundcolor, Attribute.create( [ :texkeyval ], nil, 15 )
+  add_attribute :multiline, Attribute.create( [ :texkeyval ], [true,false], 30  )
+  add_attribute :readonly, Attribute.create( [ :texkeyval ], [true,false], 31  )
+  add_attribute :hidden, Attribute.create( [ :texkeyval ], [true,false], 31  )
+  add_attribute :value, Attribute.create( [ :texkeyval ], [String, Array], 40  )
+  add_attribute :validate, Attribute.create( [ :texkeyval ], [String, Array], 40  )#Validation rule
+  add_attribute :format, Attribute.create( [ :texkeyval ], [String, Array], 40  )#Format rule
+  add_latex_output '#{linebreak(@crbefore)}\TextField[#{texkeyval()}]{#{@content}}#{linebreak(@crafter)}'
+end #Textfield
+
+end #module Hyperref
+end #module Packages
+end #module Docgenerator
+__END__
+
+#~ \renewcommand{\LayoutCheckField}[2]{\mbox{#2}\,#1}
+
+\ChoiceMenu[popdown,name=mitlgiedsnr]{Mitgliedsnummer}%
+	{Kein Mitglied=N,}
+
+Acrobat-Funktionen:
+
+Zu TextField#validate:
+	AFRange_Validate(b1,w1,b2,w2)
+	
+b1:	Testen auf Minimum (true/false)
+w1:	Minimaler wert
+b2:	Testen auf Maximalwert (true/false)
+w2:	Maximaler wert
+
+Zu TextField#format:
+AFNumber_Format(nDec,0,0,0,0,"",true)
+nDec: Anzahl der Nachkommastellen.
+
+
+Paket insdljs (nach hyperref laden.
+\begin{insDLJS}{name}{titel}
+	Javascript
+\end{insDLJS}
+
+name ergint name.js und bei begin{document} geladen.

data/lib/docgenerator/packages/listings.rb

@@ -0,0 +1,179 @@
+module Docgenerator
+module Listings
+LSTSETTINGS = 	{
+		:language	=> Attribute.create( [ :texkeyval] ),
+		:style		=> Attribute.create( [ :texkeyval] ),
+		:basicstyle	=> Attribute.create( [ :texkeyval] ),
+		:emph	=> Attribute.create( [ :texkeyval] ),
+		:emphstyle	=> Attribute.create( [ :texkeyval] ),
+		:keywordstyle	=> Attribute.create( [ :texkeyval] ),
+		:commentstyle	=> Attribute.create( [ :texkeyval] ),
+		:style	=> Attribute.create( [ :texkeyval] ),
+		:breaklines	=> Attribute.create( [ :texkeyval], ['true', 'false'] ),
+		:mathescape	=> Attribute.create( [ :texkeyval], ['true', 'false'] ),
+		:prebreak	=> Attribute.create( [ :texkeyval] ),
+		:postbreak	=> Attribute.create( [ :texkeyval] ),
+		:tabsize	=> Attribute.create( [ :texkeyval], [ Integer ] ),
+		:firstline	=> Attribute.create( [ :texkeyval], [ Integer ] ),
+		:lastline	=> Attribute.create( [ :texkeyval], [ Integer ] ),
+#~ showspaces=true,
+#~ showtabs=true,
+#~ tab=\rightarrowfill}		
+		:numbers		=> Attribute.create( [ :texkeyval], [ 'none', 'left', 'right' ] ),
+		:numberstyle	=> Attribute.create( [ :texkeyval] ),
+		:firstnumber	=> Attribute.create( [ :texkeyval], [ Integer ] ),
+		:stepnumber	=> Attribute.create( [ :texkeyval], [ Integer ] ),
+		:numbersep		=> Attribute.create( [ :texkeyval], [ Integer ] ),
+		#
+		:morekeywords	=> Attribute.create( [ :texkeyval], [ String ] ),
+		:morecomment	=> Attribute.create( [ :texkeyval], [ String ] ),
+	}
+
+
+=begin rdoc
+Define Element :lstlistoflistings
+
+Create an instance with
+  element( :lstlistoflistings, [ attributes, [content]] )
+or
+  Lstlistoflistings.new( [ attributes, [content]] )
+Attributes are not defined for this element.
+=end
+class Lstlistoflistings < Element
+  has_no_content false
+end #Lstlistoflistings
+
+
+=begin rdoc
+Define Element :lstloadlanguages
+
+Create an instance with
+  element( :lstloadlanguages, [ attributes, [content]] )
+or
+  Lstloadlanguages.new( [ attributes, [content]] )
+Attributes are not defined for this element.
+=end
+class Lstloadlanguages < Element
+  add_latex_output '#{linebreak(@crbefore)}\lstloadlanguages{#{@content}}#{linebreak(@crafter)}'
+  add_html_output ''
+end #Lstloadlanguages
+
+=begin rdoc
+Define Element :lstset
+
+Create an instance with
+  element( :lstset, [ attributes, [content]] )
+or
+  Lstset.new( [ attributes, [content]] )
+Attributes may be:
+* LSTSETTINGS
+=end
+class Lstset < Element
+  has_no_content false
+  add_attributes LSTSETTINGS
+  add_latex_output '#{linebreak(@crbefore)}\lstset{#{texkeyval()}}#{linebreak(@crafter)}'
+  add_html_output ''
+end #Lstset
+
+=begin rdoc
+Define Element :lstdefinestyle
+
+Create an instance with
+  element( :lstdefinestyle, [ attributes, [content]] )
+or
+  Lstdefinestyle.new( [ attributes, [content]] )
+Attributes may be:
+* LSTSETTINGS
+=end
+class Lstdefinestyle < Element
+  add_attributes LSTSETTINGS
+  add_latex_output '#{linebreak(@crbefore)}\lstdefinestyle{#{@content}}{#{texkeyval()}}#{linebreak(@crafter)}'
+end #Lstdefinestyle
+=begin rdoc
+Define Element :lstinputlisting
+
+Create an instance with
+  element( :lstinputlisting, [ attributes, [content]] )
+or
+  Lstinputlisting.new( [ attributes, [content]] )
+Attributes may be:
+* 
+=end
+class Lstinputlisting < Element
+  add_attributes LSTSETTINGS
+  add_attributes HTML_ATTR_CORE
+  add_attributes HTML_ATTR_I18N
+  add_attributes HTML_ATTR_EVENTS
+  add_attribute :lang, ATTR_LANG
+  add_attribute :caption, Attribute.create( [ :texkeyval], nil, 1 )
+  add_html_tag 'pre'
+  add_latex_output '#{linebreak(@crbefore)}\lstinputlisting[#{texkeyval()}]{#{@content}}#{linebreak(@crafter)}'
+end #Lstinputlisting
+
+#~ lstlisting
+
+=begin rdoc
+Define Element :lstinline
+
+Create an instance with
+  element( :lstinline, [ attributes, [content]] )
+or
+  Lstinline.new( [ attributes, [content]] )
+Attributes are not defined for this element.
+=end
+class Lstinline < Element
+	add_attributes HTML_ATTR_ALL
+	add_attributes LSTSETTINGS
+	add_attribute :caption, Attribute.create( [ :latex ], nil, 1 )
+  add_html_tag 'pre'
+	#Redefine standard output. 
+	#Options are given, if an option is avalaible.
+	def to_latex(  options={}  )
+    o = set_option_defaults(options)    
+		if ! @content.include?( '!' );	sep = '!'
+		elsif ! @content.include?( '?' );	sep = '?'
+		else
+			o[:log].warn("lstinline: found no sep. for #{content}") if o[:log].warn?
+		end
+		cmd = linebreak(@crbefore)
+		cmd << '\lstinline'
+		cmd << "[#{texkeyval()}]"
+		cmd << sep
+		cmd << "#{@content.to_latex( options)}"
+		cmd << sep
+		cmd << linebreak(@crafter)
+		return cmd
+	end
+end
+
+=begin rdoc
+Define Environment :lstlisting
+
+Create an instance with
+  element( :lstlisting, [ attributes, [content]] )
+or
+  Lstlisting.new( [ attributes, [content]] )
+Attributes are not defined for this element.
+=end
+class Lstlisting < Environments::Environment
+	add_attributes HTML_ATTR_ALL 
+	add_attributes LSTSETTINGS
+	add_attribute :options, Attribute.create( [ :texkeyval], nil, 1 )
+
+	add_html_tag 'pre'
+=begin rdoc  
+Redefine standard output. 
+Options are given, if an option is avalaible.
+=end
+	def to_latex( options={} )
+		option	= "[#{texkeyval()}]"
+		option	= nil if option == '[]'
+		return to_latex_environment( 'lstlisting', option,  options )
+	end
+end
+end #module Listings
+end #module Docgenerator
+__END__
+doc.head	<< element(:usepackage,{ }, 'listings').cr
+doc.head	<< element(:lstloadlanguages,{}, 'ruby' ).cr
+doc.head	<< element(:lstset,{ :language => 'ruby' } ).cr