docgenerator 0.1.1 → 1.0.2

data/examples/docgenerator_example_tabular.rb

@@ -0,0 +1,68 @@
+#
+#Create a test-document with docgenerator.rb.
+#
+
+#~ require 'rubygems'
+$: << ".."  #for local tests with uninstalled gem
+require 'docgenerator'
+
+#
+#   Create a document
+#
+doc = Document.new(
+  :title => 'Testdocument with tabulars'
+  )
+
+#~ doc.head	<< element( :usepackage, { }, 'longtable' )
+#~ doc.head	<< element( :usepackage, { :option => [] }, 'longtable' )
+
+#
+#   Set some settings
+#
+#~ doc.title	='Titel'
+#~ doc.author	= 'Authorname'
+#~ doc.date	= 'Datum'
+#~ doc.keywords	= 'Test, DocGenerator.rb'
+#~ doc.description	= 'Testdokument f�r DocGenerator.rb'
+
+#
+doc.body	<< element(:maketitle)  #Only LaTeX
+doc.body[:lang] << 'de' #language flag for HTML
+
+doc.body	<< element(:h1, {}, 'Tabellen').cr
+
+def mk_tabular( columns, lines )
+  
+  tab = element(:tabular, {
+          :columns => columns.size, #for HTML
+          :columndescription =>	'c' * columns.size  #for LaTeX
+        } ).CR
+
+  tab 	<< row = element( :row, {:add_vspace=>'1ex'}  ).cr
+  row	<< element(:multicolumn, {
+        :columns	=> columns.size,
+        :pos		=> 'c', #LaTeX
+      }, 'Titel' )
+  row.hline #Only LaTeX
+  
+  lines.each{|line|
+    tab 		<< row = element( :row ).cr
+    columns.each{|column|
+      row		<< element(:column, {}, "#{line}#{column}" )
+    }
+  }
+  return tab
+end
+
+doc.body	<< mk_tabular( Array('A'..'D'), Array(1..5) )
+doc.body	<< mk_tabular( Array('A'..'F'), Array(1..5) )
+
+
+# ###############################
+# �Save the files
+# ###############
+
+#~ Element.log = true #Write Errors to stdout
+doc.save( __FILE__.sub(/\.rb/, ".html"),	true )
+doc.runtex = true
+doc.save( __FILE__.sub(/\.rb/, ".tex"),	true )

data/examples/docgenerator_example_tripfalls.rb

@@ -0,0 +1,57 @@
+#
+#Create a test-document with docgenerator.rb.
+#
+
+#~ require 'rubygems'
+$: << ".."  #for local tests with uninstalled gem
+require 'docgenerator'
+
+#
+#   Create a document
+#
+doc = Document.new(
+  :title => 'Testdocument with tripfalls'
+  )
+
+#~ doc.head	<< element( :usepackage, { }, 'longtable' )
+#~ doc.head	<< element( :usepackage, { :option => [] }, 'longtable' )
+
+#
+#   Set some settings
+#
+#~ doc.title	='Titel'
+#~ doc.author	= 'Authorname'
+#~ doc.date	= 'Datum'
+#~ doc.keywords	= 'Test, DocGenerator.rb'
+#~ doc.description	= 'Testdokument f�r DocGenerator.rb'
+
+#
+doc.body	<< element(:maketitle)  #Only LaTeX
+doc.body[:lang] << 'de' #language flag for HTML
+
+doc.body	<< element(:h1, {}, 'Generell Tripfalls').cr
+puts '!And now an error: Content added to makro without content'
+doc.body	<< element( :br, {}, 'Text in br' ).cr
+
+
+doc.body	<< element(:h1, {}, 'Tripfalls with HTML').cr
+doc.body	<< element(:h2, {}, 'Paragraph forgotten?').cr
+doc.body	<< <<txt
+When you use CSS, you define a layout for 
+txt
+
+doc.body	<< element(:h1, {}, 'Tripfalls with LaTeX').cr
+doc.body	<< element(:h2, {}, 'Tabulars').cr
+
+
+
+
+
+# ###############################
+# �Save the files
+# ###############
+
+#~ Element.log = true #Write Errors to stdout
+doc.save( __FILE__.sub(/\.rb/, ".html"),	true )
+doc.runtex = true
+doc.save( __FILE__.sub(/\.rb/, ".tex"),	true )

data/examples/wiki2docgenerator_example.rb

@@ -0,0 +1,270 @@
+require 'C:/usr/Script/MyScripts' if File.exist?('C:/usr/Script/MyScripts.rb')
+#~ require 'docgenerator'
+require 'wiki2docgenerator'	if ! defined? Wikitext
+#~ require '20070622_wiki2docgenerator'	if ! defined? Wikitext
+
+#~ Element.log(true)
+#~ Element.trace==true
+
+wiki	= Wikitext.new( :parsetext => true )
+wiki	<< DATA#.readlines.to_s
+#~ wiki	<< %q|
+#~ |
+
+doc = Document.new()
+doc.title	=	'wiki2docgenerator_example.rb: Test for wiki2docgenerator'
+#For TeX you can use element(:tableofcontent),
+#in HTML you can use element( :toc, :h3) in combination with sitegenerator
+doc.body << wiki.toc(	#include the toc
+		:listtype	=> :ul,
+		:level		=> 2,
+		:startlevel	=> 1,
+		:addlinks	=> false
+	)
+doc.body << wiki
+doc.body << wiki.footnotes	#include the footnotes
+doc.save('test_wiki2docgenerator.html', true)
+doc.save('test_wiki2docgenerator.wiki', true)
+doc.save('test_wiki2docgenerator.txt', true)
+doc.save('test_wiki2docgenerator.tex', true)
+
+__END__
+==Wiki2docgenerator.rb==
+The class Wiki2docgenerator allows to analyse a text in Wiki-format and
+transform it to a "docgenerator"-object.
+
+This object can be saved as HTML or TeX (or Wiki again - in preparation).
+
+The wiki-syntax is defined at:
+*http://de.wikipedia.org/wiki/WikiSyntax
+*http://de.wikipedia.org/wiki/Hilfe:Textgestaltung
+
+Not the complete Syntax is used or supported.
+Please check the following example coding for the features.
+
+Example-Programm:
+	doc == Document.new()
+	doc.title	==	'Test'
+	doc.body << wiki.toc	#include the table of content
+	doc.body << wiki.to_element
+	doc.body << wiki.footnotes	#include the footnotes
+	doc.save('test.html', true)
+	doc.save('test.wiki', true)
+	doc.save('test.txt', true)
+	doc.save('test.tex', true)
+
+==Titel 1==
+===Titel 2===
+#~ =====Titel 4 ohne 3=====
+====Titel 3====
+=====Titel 4=====
+=====[label]Titel 4 mit label=====
+
+text text.
+Mehr text im gleichen Absatz.
+
+text in neuem Absatz
+
+
+==Listen==
+===Normale Punkt-Liste===
+*		liste	*
+*		liste	*
+**	liste	**
+**	liste	**
+***	liste	***
+****	liste	****
+***	liste	***
+*		liste	*
+
+===Nummerierte Liste===
+#		liste 1
+#		liste 2
+##	liste 2-1
+#		liste 3
+
+===Gemischte Liste===
+#		Liste num
+#*	liste	num-*
+##	liste	num-num
+
+===Punkte- und Nummerierte Liste nacheinander===
+*list	*
+#list 1
+
+===Wilde Mischung Punkte- und Nummerierte Liste nacheinander===
+*list	(*)
+**list	(**)
+#*list (#*) Hier Wechsel auf erster Ebene
+
+===Definitionsliste ===
+;Definitionsliste
+:Liste von Definitionen
+:Liste von Definitionen
+;Begriff
+:Definition des Begriffs
+
+===Mehrzeilige Listen===
+*	vorher
+*	text
+	mehr text zum item
+*	nachher und vorher
+*	text
+	mehr text zum item
+	
+	neuer Absatz im Item funktioniert auch.
+*	nachher
+
+===Einr�ckungen===
+Nicht realisiert, macht implizit Definitionsliste	(fixme)
+: Text	macht implizit Definitionsliste	(fixme)
+::  Noch tiefer
+
+===Fu�noten===
+Einf�gen mit {{footnote|Fu�notentext}}
+	{{footnote|Fu�notentext}}
+
+Ausgegeben werden die Fu�noten mit 
+	{{footnotes}}
+	{{footnotes|groupid}}
+
+Die groupid-Variante erm�glicht verschiedene Fu�notenk�rper.
+(Nur bei HTML-Ausgabe, die Fu�notendefinition erlaubt noch keine Gruppen)
+
+Und jetzt die Fu�noten:
+{{footnotes}}
+#~ Im verarbeitenden Ruby-Programm k�nnen die Fu�noten extra eingef�gt werden.
+	#~ doc.body << wiki.footnotes	#include the footnotes
+
+
+===Allgemeine Formatierungen===
+Eine 
+----
+Linie
+
+==Inline-Formatierungen==
+===Textformatierungen=== 
+Inline-Tags ''kursiv'', '''fett''', ''''kursiv und fett''''
+
+''kursiv'', 
+'''fett''', 
+''''kursiv und fett''''
+
+=== Verbatim ===
+Text vor Verbatim
+ pretext
+ pretext sss
+Jetzt kein Verbatim mehr
+
+==Bilder==
+Details siehe http://de.wikipedia.org/wiki/Hilfe:Bilder
+
+Bilder lassen sich mit [ [Bild:Dateiname|Beschreibung]] in Artikel einf�gen. 
+Das Bild wird dann in Originalgr��e links im Artikel angezeigt. 
+
+Parameter sind optional mit [ [Bild:Dateiname|parameter|Beschreibung]] anzugeben.
+Es sind beliebig viele, mit | getrennte Parameter m�glich.
+
+Unterst�tzt sind:
+*left, right:	Ausgabe als Float
+*123px:	width wird gesetzt
+*thumb:	noch keine Auswertung
+#~ Mit der Option �framed�, z. B. [[Bild:Dateiname|framed|Beschreibung]] wird das Bild mit einem Rahmen umgeben.
+*par==val:	Der CSS-Parameter ''par'' wird mit dem Wert ''val'' versorgt. (Kein Wiki-Standard, sondern eine Spezialit�t von wiki2docgenerator)
+
+Besonderheiten:
+*Die Beschreibung wird in einen ''alt''-Tag verwendet.
+
+==Tabellen==
+Die Syntax:
+*{|	beginnt eine Tabelle. Hier k�nnen zus�tzliche Formatierungseigenschaften kommen.
+**Zumindest columns==__ sollte gesetzt sein
+*!		beginnt eine neue Zelle einer Titelzeile
+*|		beginnt eine neue Zelle
+*||	trennt zwei Zellen	(nicht unterst�tzt)
+*|format|	z.B. rowspan...
+*|format||	Zwei || beenden die Parameter der Zelle.
+	Dann sinnvoll, wenn im Text selbst ein | vorkommt
+	(z.B. ein Macro verwendet wird)
+
+*|-	trennt zwei Zeilen der Tabelle
+**hline:	Zus�tzlicher Trennstrich �ber der Zeile
+**toprule, midrule, bottomrule:	Zus�tzlicher Trennstrich �ber der Zeile (erfordert booktabs.sty)
+*|}	beendet eine Tabelle
+
+Beispiel 1:
+{|columns=2
+|Zelle 1
+|Zelle 2
+|-
+|Zelle 3
+|Zelle 4
+|-
+|Zelle 5
+|Zelle 6
+|}
+
+Beispiel 2:
+{| border=1|columns=6
+|Zelle 1
+|colspan=5|text-align=center| Zelle 2 �ber zwei Spalten
+|-
+|Zelle 3
+|Zelle 4
+|Zelle 5
+|Zelle 6
+|Zelle 7
+|Zelle 8
+|}
+
+
+#~ Beispiel 3 mit Titelzeile:
+#~ {| border=1
+#~ !A
+#~ !B
+#~ !C
+#~ |-
+#~ |Zelle 1
+#~ | colspan="2" align="center" | Zelle 2
+#~ |-
+#~ |Zelle 3
+#~ |Zelle 4
+#~ |Zelle 5
+#~ |}
+
+----
+
+==Makros==
+Makros sind eingeleitet mit {{.
+nach dem Makronamen sind Parameter mit | getrennt.
+
+===Link ins ODP===
+*{{dmoz|World/Deutsch}}
+*{{dmoz|World/Deutsch|Deutschsprachige Inhalte}}
+
+===Neue Zeile===
+	{{newline|clear}}
+vorher
+{{newline|clear}}
+nachher
+
+Das Makro newline erfordert den Parameter ''clear''.
+Kann insbesonders genutzt werden um nach floatenden Bildern 
+die Folgezeile unter den float zu setzen.
+
+==Auspr�nge==
+Mit
+	>>>key{}
+	...
+	<<<
+wird eine externe Aufbereitung gerufen.
+key wird von WikiCollector genutzt um den Aufbereiter (Klasse) zu rufen.
+Der Aufbereiter muss die Methoden << und to_element unterst�tzen.
+
+html ist bereits definiert und erlaubt die Verwednung von Original-Htlm
+
+Beispiel:
+>>>html{}
+<strong>Fett</strong>
+<<<
+Ende Beispiel

data/lib/docgenerator.rb

@@ -0,0 +1,159 @@
+#Generic methods to create documents.
+#The target format is generic, supported are LaTeX and HTML.
+#Plain text and a Wiki-version exist also, but they are not well maintained.
+#
+#==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 will not occur in this generated documentation).
+#
+#==	Examples
+#See the unit tests and the examples-folder of the docgenerator distribution.
+#
+
+#Version information.
+begin
+  if Gem.loaded_specs['docgenerator']
+    DOCGENERATOR_VERSION = Gem.loaded_specs['docgenerator'].version
+  else
+    DOCGENERATOR_VERSION = "#{File.expand_path('docgenerator')} (no Gem)"
+  end
+rescue  NameError #No gems?
+    DOCGENERATOR_VERSION = "#{File.expand_path('docgenerator')} (no Gem)"
+end
+require 'log4r'
+
+#How to handle the End-Tag for br/hr...
+#- false:	set <br />	(XHTML)
+#- nil:	set <br>	(HTML)
+#Problem:
+#HTML may have no endtags, XHTML requires it.
+#~ 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 )
+
+
+
+#The docgenetor own log-formatter.
+#
+#Reason:
+#docgenerator throws logging information.
+#The trace would inform, where the problems come from (a docgenerator-tool)
+#but normally the problems are document problems,
+#so we need the first step outside the docgenerator-path
+class LogFormatter < Log4r::BasicFormatter
+    #Use another format for the logger.
+    #
+    #Based on BasicFormatter. 
+    #When used with trace on, return the location from docgenerator and the first non-docgenerator position.
+    def format(event)
+      buff = sprintf(@@basicformat, Log4r::MaxLevelLength, Log4r::LNAMES[event.level],
+             event.name)
+      mytrace = []
+      #~ buff += (event.tracer.nil? ? "" : "(#{event.tracer[0]})") + ": "
+      if event.tracer.nil?
+      else
+        event.tracer.each{|trace|
+          if trace !~ /lib\/docgenerator/
+            mytrace << trace
+            break
+          end          
+        }
+        mytrace << event.tracer[0]
+      end
+      buff += ": "
+      buff += format_object(event.data) 
+      #~ buff += (event.tracer.nil? ? "" : " (#{event.tracer.join('/')})")
+      buff += (event.tracer.nil? ? "" : " (#{mytrace.join('|')})")
+      buff += "\n"
+      buff
+    end
+  end
+
+  
+#Default Logger
+DOCGENERATOR_LOGGER = Log4r::Logger.new( 'docgenerator')
+DOCGENERATOR_LOGGER.level = Log4r::FATAL
+DOCGENERATOR_LOGGER.outputters = Log4r::StdoutOutputter.new('log_stdout',
+        :formatter => LogFormatter 
+        )
+
+
+#
+#A 'global' parameter setting
+#
+#For usage of
+#    o = Docgenerator_logger.set_option_defaults(options)
+#    o[:log].debug("Enter ...") if o[:log].debug?
+module Docgenerator_logger
+  #Each to_doc, to_html, to_latex, to_wiki, to_text has an option-parameter.
+  #This option-hash should contain at least a :log-value. 
+  #This method completes the option hash with a default logger if no logger is given.
+  def self.set_option_defaults(options)
+    return {
+        :log  => DOCGENERATOR_LOGGER
+        #Added from Document:
+        # :document   useable for documentation
+        # :filename   useable for documentation
+        # :template  only Document-internal
+        # :replacements only Document-internal
+        #to think about:
+        #- parent - actually used in list to detect */# for wiki-items.
+      }.update(options)
+  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 'templates/docgenerator_template'
+require 'docgenerator_css'
+require 'docgenerator_attribute'
+require 'docgenerator_document'
+
+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?