docgenerator 0.1.1 → 1.0.2

data/examples/docgenerator_example.rb

@@ -1,185 +1,101 @@
-#Create a test-document with docgenerator.rb.
 #
-#This program loads docgenerator.rb and 
-#use most of the features of the tool.
+#Create a test-document with docgenerator.rb.
 #
-#Start the tool and two documents
-#-	test.html and
-#-	test.tex
-#are created. 
 
 #~ require 'rubygems'
 $: << ".."  #for local tests with uninstalled gem
 require 'docgenerator'
-with_error  = false
-#~ with_error  = true  #Include some "wrong" statements. You will get a message from docgenerator
-
-##############
-## Test
-##############
-puts '='*40
-#~ puts Element.overview( [Element.get(:h1)] )
-#~ puts Element.overview( [Title] )
-#~ puts Element.overview( )
-#~ puts '='*40
-
-puts ">Create a test-document"
-doc = Document.new()
-doc.add_option('ngerman')
-
-doc.head	<< element( :usepackage, { }, 'longtable' )
-#~ doc.head	<< element( :usepackage, { :option => [] }, 'longtable' )
-doc.head	<< element( :sepline )	#Separator line
-
-
-#~ doc.head	<< element(:title, {}, 'Titel')
-#~ doc.head	<< element(:author, {}, 'Authorname')
-doc.title	='Titel'
-doc.author	= 'Authorname'
-doc.date	= 'Datum'
-doc.keywords	= 'Test, DocGenerator.rb'
-doc.description	= 'Testdokument f�r DocGenerator.rb'
-
-doc.head	<< element(:meta, {:name => 'xxx', :content => 'inhalt' } )
-if with_error
-  puts '!And at <save> an error: Meta-Tag without required attributes'
-  doc.head	<< element(:meta, {} )
-end
-
-doc.body	<< element(:maketitle)
-doc.body[:lang] << 'de'
 
-# ###############################
-def listen()
-	listen = []
-	listen	<< element(:h1, {}, 'Listen')
-	
-	listen	<< element(:h2, {}, 'Unnummerierte Liste')
-	listen	<< ul = element(:ul)
-	ul		<< element( :li, {}, 'Listitem 1' )
-	ul		<< element( :li, {}, 'Listitem 2' )
-	ul		<< element( :li, {}, 'Listitem 3' )
-	
-	listen	<< element(:h2, {}, 'Nummerierte Liste')
-	listen	<< ol = element(:ol)
-	ol		<< element( :li, {}, 'Listitem 1' )
-	ol		<< element( :li, {}, 'Listitem 2' )
-	ol		<< element( :li, {}, 'Listitem 3' )
-	return listen
-end
-doc.body	<< listen
+#
+#   Create a document
+#
+doc = Document.new(
+  :title => 'Testdocument for docgenerator.rb',
+  :language => 'english'
+  )
 
-# ###############################
-doc.body	<< element(:h1, {}, 'Absatzsteuerung').cr
-doc.body	<< 'Text'
-doc.body	<< element( :br ).cr
-doc.body	<< 'Text'
-if with_error
-  puts '!And now an error: Content added to makro without content'
-  doc.body	<< element( :br, {}, 'Text in br' ).cr
-end
+#
+#   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(:h1, {}, 'Links und Verweise').cr
-doc.body	<< element(:a,	{ :href => 'http://ruby.lickert.net/' }, 'Link zu meinen Skripten').cr
-doc.body	<< element(:url,{}, 'http://ruby.lickert.net/')
+#~ doc.add_option('ngerman')
 
+#
+doc.body	<< element(:maketitle)  #Only LaTeX
+doc.body[:lang] << 'de' #language flag for HTML
 
 # ###############################
-doc.body	<< element(:h1, {}, 'Relatives einf�gen').cr
-doc.body	<< par = element(:par, {}, 'Absatz')
+doc.body	<< element(:h1, {}, 'Sections and paragraphs').cr
+doc.body	<< element(:h2, {}, 'Paragraphs').cr
+#
+# Add content immediate
+#
+doc.body	<< element(:par, {}, 'This is a paragraph').cr
+doc.body	<< element(:par, {}, [
+    'This is another paragraph.',
+    'This paragraph contains a second phrase',
+    ]).cr
+
+#
+# Add content afterwords
+#
+doc.body	<< par = element(:par).cr
+par << 'This is also a paragraph.'
+par << 'This paragraph contains also second phrase'
+
+
+doc.body	<< element(:h2, {}, 'Paragraphs with linebreaks').cr
+doc.body	<< element(:par, {}, [ 'This is a paragraph with linebreaks',
+                  element( :br ).cr,  #Add a newline
+                  'This is text after a linebreak',
+                  element( :newline ).cr,  #Add a newline
+                  'Further text after another linebreak (newline in LaTeX)',
+  ]).cr
+
 
-doc.body.insertbefore( par, 'Einschub vor dem Absatz' )
-doc.body.insertafter( par, 'Einschub nach dem Absatz' )
 
-if with_error
-  puts "!And now an error: insertbefore with a non-existing target"
-  doc.body.insertbefore( 'a', 'Before List' )
-end
 
 # ###############################
-doc.body	<< element(:h1, {}, 'Tabellen').cr
-columnnumber = 5
-doc.body	<< tab = element(:tabular, {
-				:columns => columnnumber,
-				:columndescription =>	'c' * columnnumber
-			} ).CR
-
-tab 	<< row = element( :row, {:add_vspace=>'1ex'}  ).cr
-row	<< element(:multicolumn, {
-			:columns	=> columnnumber,
-			:pos		=> 'c',
-		}, 'Titel' )
-row.hline
-
-'a'.upto('f'){|num|
-	tab 		<< row = element( :row ).cr
-	1.upto(columnnumber){|letter|
-		row		<< element(:column, {}, "#{num}#{letter}" )
-	}
-}
-
-
-def footnote( )
-	txt = []
-	
-	txt << element(:h1, {}, 'Fu�noten').cr
-	txt << element(:h2, {}, 'Standardfu�noten').cr
-	txt << 'a'
-	txt << f = element(:footnote,{}, 'eins')
-	txt << 'b'
-	txt << element(:footnote,{}, 'zwei')
-	txt << ' nochmal erste Fu�note'
-	txt << f
-	txt << 'z'
-	
-	txt << element(:h2, {}, 'Fu�noten in eigener Gruppe 1').cr
-	txt << 'a'
-	txt << f = element(:footnote,{:groupid=>1}, 'Fu�note eins/Gruppe 1')
-	txt << 'b'
-	txt << element(:footnote,{:groupid=>1}, 'Fu�note zwei/Gruppe 1')
-	txt << 'c'
-	txt << f
-	txt << 'z'
-	
-	txt << element(:h2, {}, 'Fortsetzung').cr
-	txt << 'a'
-	txt << f = element(:footnote,{}, 'drei')
-	txt << 'b'
-	txt << element(:footnote,{}, 'vier')
-	txt << 'c'
-	txt << f
-	txt << 'z'
-	
-	txt << element(:hr).cr
-	Footnotegroup.get.attr={:style=>'font-size: smaller'}
-	txt << Footnotegroup.get()
-	txt << element(:hr)
-	Footnotegroup.get( 1 ).html_link = false	#Footnote are not linked
-	txt << Footnotegroup.get(1)
-	return txt
-end
-doc.body << footnote
-
-# ##############
-#~ Element.log = true #Write Errors to stdout
-#~ doc.save( 'test.html',	true )
+doc.body	<< element(:h1, {}, 'Specific content').cr
 
-doc.body	<< element(:h1, {}, 'Restrict to different Output formats').cr
-doc.body << element(:p, {}, 'When you create simultanous output to LaTeX and HTML, perhaps you need some parts only in one output document.')
-doc.body << element(:p, {}, 'Only in HTML').restrict_to(:html)
-doc.body << element(:htmlonly, {}, 'Only in HTML')
-doc.body << element(:p, {}, 'Only in LaTeX').restrict_to(:latex)
-doc.body << element(:latexonly, {}, 'Only in LaTeX')
+doc.body	<< element(:h2, {}, 'Formatting').cr
+doc.body	<< element(:par, {}, [
+  'This is normal text, ',
+  element(:textbf, {}, 'this is bold, '),
+  element(:emph, {}, 'this is emphasized.'),  
+  ]).cr
+
+
+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,
+  ]).cr
 
 
 # ###############################
-doc.body	<< element(:h1, {}, 'Ende').cr
+doc.body	<< element(:h1, {}, 'Insert content').cr
+doc.body	<< par = element(:par, {}, 'This is a paragraph')
+
+doc.body.insertbefore( par, 'This is inserted before the paragraph.' )
+doc.body.insertafter( par, 'This is inserted after the paragraph.' )
+
+#
+# This would give yo an error
+#
+#~ puts "!And now an error: insertbefore with a non-existing target"
+#~ doc.body.insertbefore( 'a', 'Before List' )
 
 # ###############################
-puts ">Save the files"
+# �Save the files
+# ###############
 
 #~ Element.log = true #Write Errors to stdout
-doc.save( 'test_docgenerator.html',	true )
+doc.save( __FILE__.sub(/\.rb/, ".html"),	true )
 doc.runtex = true
-doc.save( 'test_docgenerator.tex',	true )
+doc.save( __FILE__.sub(/\.rb/, ".tex"),	true )

data/examples/docgenerator_example_footnote.rb

@@ -0,0 +1,98 @@
+#
+#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, {}, 'Normal Footnotes').cr
+
+doc.body <<  element(:h2, {}, 'Standardfu�noten').cr
+doc.body <<  'a'
+doc.body <<  f = element(:footnote,{}, 'one')
+doc.body <<  'b'
+doc.body <<  element(:footnote,{}, 'two')
+doc.body <<  ' nochmal erste Fu�note'
+doc.body <<  f
+doc.body <<  'z'
+
+
+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 <<  f
+doc.body <<  'z'
+
+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 <<  f
+doc.body <<  'z'
+
+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 <<  element(:h1, {}, 'Normal Footnotes - Continued').cr
+doc.body <<  'a'
+doc.body <<  f = element(:footnote,{}, 'three')
+doc.body <<  'b'
+doc.body <<  element(:footnote,{}, 'four')
+doc.body <<  'c'
+doc.body <<  f
+doc.body <<  'z'
+
+
+doc.body <<  element(:hr).cr
+doc.body <<  element(:h1, {}, 'Footnotes').cr
+Footnotegroup.get.attr={:style=>'font-size: smaller'}
+doc.body <<  Footnotegroup.get()
+doc.body <<  element(:hr)
+
+
+
+# ###############################
+# �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_list.rb

@@ -0,0 +1,62 @@
+#
+#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 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(:h2, {}, 'Unnummerierte Liste')
+doc.body  <<  ul = element(:ul)
+ul		<< element( :li, {}, 'Listitem 1' )
+ul		<< element( :li, {}, 'Listitem 2' )
+ul		<< element( :li, {}, 'Listitem 3' )
+
+
+doc.body  <<  itemize = element(:itemize)
+itemize		<< element( :item, {}, 'Listitem 1' )
+itemize		<< element( :item, {}, 'Listitem 2' )
+itemize		<< element( :item, {}, 'Listitem 3' )
+
+
+doc.body  <<  element(:h2, {}, 'Nummerierte Liste')
+doc.body  <<  ol = element(:ol)
+ol		<< element( :li, {}, 'Listitem 1' )
+ol		<< element( :li, {}, 'Listitem 2' )
+ol		<< element( :li, {}, 'Listitem 3' )
+
+doc.body  <<  enumerate = element(:enumerate)
+enumerate		<< element( :item, {}, 'Listitem 1' )
+enumerate		<< element( :item, {}, 'Listitem 2' )
+enumerate		<< element( :item, {}, 'Listitem 3' )
+
+# ###############################
+# �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_restrictions.rb

@@ -0,0 +1,59 @@
+#
+#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 retsrictions 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
+
+doc.body	<< element(:h1, {}, 'Restrict to different Output formats').cr
+doc.body << element(:p, {}, <<txt
+When you create simultanous output to LaTeX and HTML, perhaps you need some parts only in one output document.
+txt
+)
+
+doc.body	<< element(:h2, {}, 'Content only in HTML').cr
+doc.body << element(:p, {}, 'Only in HTML').restrict_to(:html)
+doc.body << element(:htmlonly, {}, 'Only in HTML')
+
+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
+# ###############
+
+#~ Element.log = true #Write Errors to stdout
+doc.save( __FILE__.sub(/\.rb/, ".html"),	true )
+doc.runtex = true
+doc.save( __FILE__.sub(/\.rb/, ".tex"),	true )