docgenerator 1.1.1 → 1.2.1

data/examples/docgenerator_example.rb

@@ -1,29 +1,47 @@
-#
-#Create a test-document with docgenerator.rb.
-#
+=begin rdoc
+Create a test-document with docgenerator.rb.
+
+Result see 
+* examples/results_expected/docgenerator_example.html
+* examples/results_expected/docgenerator_example.tex
+* examples/results_expected/docgenerator_example.pdf
+=end
 
-#~ require 'rubygems'
-$: << ".."  #for local tests with uninstalled gem
+require 'rubygems'
+$:.unshift("../lib")  #for local tests with uninstalled gem
 require 'docgenerator'
+begin 
+  require 'rake4latex_pdflatex' 
+rescue LoadError 
+  puts "rake4latex not installed -> no translation of LaTeX-file"
+end
+
+#
+# Move all results to anothe folder
+#
+Dir.chdir('results')
 
 #
 #   Create a document
 #
 doc = Document.new(
   :title => 'Testdocument for docgenerator.rb',
-  :language => 'english'
+  :language => 'english',
+  :author => 'Authorname',
+  :date => 'Datum',
+  :keywords	=> 'Test, docgenerator.rb',
+  :description	=> 'Testdocument for docgenerator.rb'  
   )
 
 #
-#   Set some settings
-#
+#   Alternative psooibility to define settings:
 #~ doc.title	='Titel'
 #~ doc.author	= 'Authorname'
 #~ doc.date	= 'Datum'
 #~ doc.keywords	= 'Test, DocGenerator.rb'
-#~ doc.description	= 'Testdokument f�r DocGenerator.rb'
+#~ doc.description	= 'Testdokument for DocGenerator.rb'
 
-#~ doc.add_option('ngerman')
+doc.add_option('ngerman')
 
 #
 doc.body	<< element(:maketitle)  #Only LaTeX
@@ -74,7 +92,7 @@ doc.body	<< element(:par, {}, [
 doc.body	<< element(:h2, {}, 'Links and URLs').cr
 doc.body	<< element(:par,{}, [
   element(:url,{}, 'http://ruby.lickert.net/').cr,
-  element(:a,	{ :href => 'http://ruby.lickert.net/' }, 'Link zu meinen Skripten').cr,
+  element(:a,	{ :href => 'http://ruby.lickert.net/' }, 'link to my scripts').cr,
   ]).cr
 
 
@@ -92,10 +110,9 @@ doc.body.insertafter( par, 'This is inserted after the paragraph.' )
 #~ doc.body.insertbefore( 'a', 'Before List' )
 
 # ###############################
-# �Save the files
+# 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 )
+doc.save( __FILE__.sub(/\.rb/, ".html"))
+doc.save( __FILE__.sub(/\.rb/, ".tex"),
+  :runtex => [:statistic, :clean]
+  )

data/examples/docgenerator_example_footnote.rb

@@ -1,98 +1,119 @@
-#
-#Create a test-document with docgenerator.rb.
-#
+=begin rdoc
+Create a test-document with docgenerator.rb.
+
+Result see 
+* examples/results_expected/docgenerator_example_footnote.html
+* examples/results_expected/docgenerator_example_footnote.tex
+* examples/results_expected/docgenerator_example_footnote.pdf
+
+link:examples/results_expected/docgenerator_example_footnote.pdf
 
-#~ require 'rubygems'
-$: << ".."  #for local tests with uninstalled gem
+=end
+
+require 'rubygems'
+$:.unshift("../lib")  #for local tests with uninstalled gem
 require 'docgenerator'
+begin 
+  require 'rake4latex_pdflatex' 
+rescue LoadError 
+  puts "rake4latex not installed -> no translation of LaTeX-file"
+end
 
+#
+# Move all results to anothe folder
+#
+Dir.chdir('results')
 #
 #   Create a document
 #
 doc = Document.new(
-  :title => 'Testdocument with tabulars'
+  :title => 'Testdocument with footnotes'
   )
 
-#~ 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, {}, 'Normal Footnotes').cr
+doc.body	<< element(:h1, {}, 'Standard Footnotes').cr
 
-doc.body <<  element(:h2, {}, 'Standardfu�noten').cr
-doc.body <<  'a'
-doc.body <<  f = element(:footnote,{}, 'one')
-doc.body <<  'b'
+doc.body <<  element(:h2, {}, 'Standard footnote').cr
+doc.body <<  'Some text in front'
+doc.body <<  foot1 = element(:footnote,{}, 'one')
+doc.body <<  'and some text between.'
 doc.body <<  element(:footnote,{}, 'two')
-doc.body <<  ' nochmal erste Fu�note'
-doc.body <<  f
-doc.body <<  'z'
+doc.body <<  ' repeat first footnote'
+doc.body <<  foot1  #makes not really sense, but it is possible
+doc.body <<  ' and finish the text.'
 
+=begin
+Grouped footnotes (only HTML)
 
+For LaTeX ledmac, manyfoot or bigfoot could be a solution.
+But yet, there is no support for it.
+=end
 doc.body	<< element(:h1, {}, 'Footnotes in their own groups (only HTML)').cr
-doc.body <<  element(:h2, {}, 'Footnotes in a Group 1').cr
-doc.body <<  'a'
-doc.body <<  f = element(:footnote,{:groupid=>1}, 'Footnote one/Group 1')
-doc.body <<  'b'
-doc.body <<  element(:footnote,{:groupid=>1}, 'Footnote two/Group 1')
-doc.body <<  'c'
+doc.body <<  element(:par, {}, 'Footnote groups not supported for LaTeX.').cr
+
+footnotegroup1 = Footnotegroup.new('g1')
+footnotegroup1.attr={:style=>'font-size: smaller'}
+
+footnotegroup2 = Footnotegroup.new('g2')
+footnotegroup2.attr={:style=>'font-size: smaller'}
+footnotegroup2.html_link = false	#Footnotes are not linked
+
+###############################
+doc.body <<  element(:h2, {}, 'Footnotes in Group 1').cr
+doc.body <<  'Some text in front'
+doc.body <<  f = element(:footnote,{:group => footnotegroup1}, 'Footnote one/Group 1')
+doc.body <<  'and some text between.'
+doc.body <<  element(:footnote,{:group => footnotegroup1}, 'Footnote two/Group 1')
+doc.body <<  ' repeat first footnote'
 doc.body <<  f
-doc.body <<  'z'
+doc.body <<  ' and finish the text.'
 
 doc.body <<  element(:h3, {}, 'Footnotes of the Group 1').cr
-Footnotegroup.get(1).attr={:style=>'font-size: smaller'}
-doc.body <<  Footnotegroup.get(1)
-
-doc.body <<  element(:h2, {}, 'Footnotes in a Group 2').cr
-doc.body <<  'a'
-doc.body <<  f = element(:footnote,{:groupid=>2}, 'Footnote one/Group 2')
-doc.body <<  'b'
-doc.body <<  element(:footnote,{:groupid=>2}, 'Footnote two/Group 2')
-doc.body <<  'c'
+doc.body <<  footnotegroup1 #makes no sense for LaTeX
+
+###############################
+doc.body <<  element(:h2, {}, 'Footnotes in Group 2').cr
+doc.body <<  'Some text in front'
+doc.body <<  f = element(:footnote,{:group=>footnotegroup2}, 'Footnote one/Group 2')
+doc.body <<  'and some text between.'
+doc.body <<  element(:footnote,{:group=>footnotegroup2}, 'Footnote two/Group 2')
+doc.body <<  ' repeat first footnote'
 doc.body <<  f
-doc.body <<  'z'
+doc.body <<  ' and finish the text.'
 
 doc.body <<  element(:h3, {}, 'Footnotes of the Group 2 - without links').cr
-Footnotegroup.get( 2 ).html_link = false	#Footnote are not linked
-Footnotegroup.get(2).attr={:style=>'font-size: smaller'}
-doc.body <<  Footnotegroup.get(2)
+doc.body <<  footnotegroup2 #makes no sense for LaTeX
 
-
-doc.body <<  element(:h1, {}, 'Normal Footnotes - Continued').cr
-doc.body <<  'a'
+###############################
+doc.body <<  element(:h1, {}, 'Standard Footnotes - Continued').cr
+doc.body <<  'Some text in front'
 doc.body <<  f = element(:footnote,{}, 'three')
-doc.body <<  'b'
+doc.body <<  'and some text between.'
 doc.body <<  element(:footnote,{}, 'four')
-doc.body <<  'c'
+doc.body <<  ' repeat first footnote'
 doc.body <<  f
-doc.body <<  'z'
+doc.body <<  ' and finish the text.'
 
 
-doc.body <<  element(:hr).cr
-doc.body <<  element(:h1, {}, 'Footnotes').cr
-Footnotegroup.get.attr={:style=>'font-size: smaller'}
-doc.body <<  Footnotegroup.get()
+=begin
+Back to standard footnotes
+=end
+doc.body <<  element(:h2, {}, 'Print Footnotes').cr
+doc.body <<  element(:par, {}, 'makes only sense in HTML. LaTeX has it''s own output routine for footnotes.').cr
+Footnotegroup[].attr={:style=>'font-size: smaller'}
+doc.body <<  Footnotegroup[]  #makes no sense for LaTeX
 doc.body <<  element(:hr)
 
 
 
 # ###############################
-# �Save the files
+# 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 )
+doc.save( __FILE__.sub(/\.rb/, ".html"))
+doc.save( __FILE__.sub(/\.rb/, ".tex"),
+  :runtex => [:statistic, :clean]
+  )

data/examples/docgenerator_example_list.rb

@@ -2,9 +2,19 @@
 #Create a test-document with docgenerator.rb.
 #
 
-#~ require 'rubygems'
-$: << ".."  #for local tests with uninstalled gem
+require 'rubygems'
+$:.unshift("../lib")  #for local tests with uninstalled gem
 require 'docgenerator'
+begin 
+  require 'rake4latex_pdflatex' 
+rescue LoadError 
+  puts "rake4latex not installed -> no translation of LaTeX-file"
+end
+
+#
+# Move all results to anothe folder
+#
+Dir.chdir('results')
 
 #
 #   Create a document
@@ -13,27 +23,20 @@ doc = Document.new(
   :title => 'Testdocument with lists'
   )
 
-#
-#   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, {}, 'Listen')
+doc.body  <<  element(:h1, {}, 'Lists')
 
-doc.body  <<  element(:h2, {}, 'Unnummerierte Liste')
+doc.body  <<  element(:h2, {}, 'Unnumbered Lists')
 doc.body  <<  ul = element(:ul)
 ul		<< element( :li, {}, 'Listitem 1' )
 ul		<< element( :li, {}, 'Listitem 2' )
 ul		<< element( :li, {}, 'Listitem 3' )
 
+doc.body  <<  element(:par,{}, 'Next list')
 
 doc.body  <<  itemize = element(:itemize)
 itemize		<< element( :item, {}, 'Listitem 1' )
@@ -41,22 +44,25 @@ itemize		<< element( :item, {}, 'Listitem 2' )
 itemize		<< element( :item, {}, 'Listitem 3' )
 
 
-doc.body  <<  element(:h2, {}, 'Nummerierte Liste')
+doc.body  <<  element(:h2, {}, 'Numbered Lists')
 doc.body  <<  ol = element(:ol)
 ol		<< element( :li, {}, 'Listitem 1' )
 ol		<< element( :li, {}, 'Listitem 2' )
 ol		<< element( :li, {}, 'Listitem 3' )
 
+doc.body  <<  element(:par,{}, 'Next list')
+
 doc.body  <<  enumerate = element(:enumerate)
 enumerate		<< element( :item, {}, 'Listitem 1' )
 enumerate		<< element( :item, {}, 'Listitem 2' )
 enumerate		<< element( :item, {}, 'Listitem 3' )
 
 # ###############################
-# �Save the files
+# 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 )
+doc.save( __FILE__.sub(/\.rb/, ".html"))
+doc.save( __FILE__.sub(/\.rb/, ".tex"),
+  :runtex => [:statistic, :clean]
+  )
+

data/examples/docgenerator_example_restrictions.rb

@@ -2,29 +2,26 @@
 #Create a test-document with docgenerator.rb.
 #
 
-#~ require 'rubygems'
-$: << ".."  #for local tests with uninstalled gem
+require 'rubygems'
+$:.unshift("../lib")  #for local tests with uninstalled gem
 require 'docgenerator'
+begin 
+  require 'rake4latex_pdflatex' 
+rescue LoadError 
+  puts "rake4latex not installed -> no translation of LaTeX-file"
+end
 
+#
+# Move all results to anothe folder
+#
+Dir.chdir('results')
 #
 #   Create a document
 #
 doc = Document.new(
-  :title => 'Testdocument with retsrictions to output format'
+  :title => 'Testdocument with restrictions to output format'
   )
 
-#~ 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] << 'en' #language flag for HTML
@@ -43,17 +40,10 @@ doc.body	<< element(:h2, {}, 'Content only in LaTeX').cr
 doc.body << element(:p, {}, 'Only in LaTeX').restrict_to(:latex)
 doc.body << element(:latexonly, {}, 'Only in LaTeX')
 
-
-
-
-
-
-
 # ###############################
-# �Save the files
+# 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 )
+doc.save( __FILE__.sub(/\.rb/, ".html"))
+doc.save( __FILE__.sub(/\.rb/, ".tex"),
+  :runtex => [:statistic, :clean]
+  )

data/examples/docgenerator_example_tabular.rb

@@ -1,10 +1,19 @@
 #
 #Create a test-document with docgenerator.rb.
 #
-
-#~ require 'rubygems'
-$: << ".."  #for local tests with uninstalled gem
+require 'rubygems'
+$:.unshift("../lib")  #for local tests with uninstalled gem
 require 'docgenerator'
+begin 
+  require 'rake4latex_pdflatex' 
+rescue LoadError 
+  puts "rake4latex not installed -> no translation of LaTeX-file"
+end
+
+#
+# Move all results to anothe folder
+#
+Dir.chdir('results')
 
 #
 #   Create a document
@@ -16,20 +25,11 @@ doc = Document.new(
 #~ 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[:lang] << 'en' #language flag for HTML
 
-doc.body	<< element(:h1, {}, 'Tabellen').cr
+doc.body	<< element(:h1, {}, 'Tabulars').cr
 
 def mk_tabular( columns, lines )
   
@@ -42,7 +42,7 @@ def mk_tabular( columns, lines )
   row	<< element(:multicolumn, {
         :columns	=> columns.size,
         :pos		=> 'c', #LaTeX
-      }, 'Titel' )
+      }, 'Title' )
   row.hline #Only LaTeX
   
   lines.each{|line|
@@ -59,10 +59,10 @@ doc.body	<< mk_tabular( Array('A'..'F'), Array(1..5) )
 
 
 # ###############################
-# �Save the files
+# 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 )
+doc.save( __FILE__.sub(/\.rb/, ".html"))
+doc.save( __FILE__.sub(/\.rb/, ".tex"),
+  :runtex => [:statistic, :clean]
+  )