RubyGems - docgenerator - Versions diffs - 2.1.1 → 3.0.0 - Mend

docgenerator 2.1.1 → 3.0.0

Files changed (324) hide show

@@ -1,81 +0,0 @@
-#encoding: cp1252
-=begin rdoc
-Example for creole/creole2doc
-=end
-require 'rubygems'
-$:.unshift("../lib")  #for local tests with uninstalled gem
-#~ require 'docgenerator'
-require 'creole/creole2doc'
-include 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')
-=begin
-Create document
-=end
-doc = Document.new(
-  :title	=>	'creole2doc_example.rb: Test for creole'
-)
-=begin
-Add creole-content.
-=end
-doc.body << Creole::Creole.new(:content => DATA)
-# ###############################
-# Save the files
-# ###############
-doc.save( __FILE__.sub(/\.rb/, ".html"))
-doc.save( __FILE__.sub(/\.rb/, ".tex"),
-  :runtex => [:statistic, :clean]
-  )
-__END__
-=creole/creole2doc.rb
-The Creole-class allows to analyse a text in creole format and
-transform it to a "docgenerator"-object.
-=Heading and paragraphs
-==Paragraphs
-Some text.
-Some more text in a new paragraph.
-==Text formatting
-//italic// and **bold** is possible.
-=Lists
-==Unnumbered list
-*		item
-*		item
-**	subitem
-***	subsubitem
-****	subsubsubitem
-***	subsubitem
-==Numbered lists
-#		liste 1
-#		liste 2
-##	liste 2-1
-#		liste 3
-===Mixed Lists
-#		Liste num
-#*	liste	num-*
-##	liste	num-num

data/examples/creole_example_footnote.rb DELETED

@@ -1,67 +0,0 @@
-#encoding: cp1252
-=begin rdoc
-Example how to use footnotes with creole/creole2doc.
-=end
-$:.unshift( '../lib' )
-require 'creole/creole2doc.rb'
-include Docgenerator
-begin
-  require 'rake4latex_pdflatex'
-rescue LoadError
-  puts "rake4latex not installed -> no translation of LaTeX-file"
-end
-#
-# Move all results to another folder
-#
-Dir.chdir('results')
-#Build document with usepackage{listings}...
-doc = Docgenerator::Document.new( :title => 'Creole with footnotes' )
-doc.body << Docgenerator::Creole::Creole.new(:content => DATA )
-# ###############################
-# Save the files
-# ###############
-doc.save( __FILE__.sub(/\.rb/, ".html"))
-#~ doc.save( __FILE__.sub(/\.rb/, ".tex"),
-  #~ :runtex => [:statistic, :clean]
-  #~ )
-__END__
-=Basic footnotes
-Add a footnote is easy<<footnote|This is a footnote>>,
-just use the plugin-technique of creole<<footnote|see http://www.wikicreole.org/wiki/Plugin>>.
-For HTML you may define your own label<<footnote|as you can see here|label=s>>
-Footnote must be in one line.
-==Writing the footnotes
-Writing footnotes makes only sense in HTML.
-LaTeX has it own footnote output routine.
-And now the footnotes:
-<<footnotes>>
-=Footnote groups
-You may define footnote groups<<footnote|just add a groupid|groupid=g1>>.
-//Inside italics you may define another group<<footnote|as here|groupid=g2>>.//
-Grouping is only supported for HTML<<footnote|in fact, you may use it with LaTeX, but there is no support of manyfoot, bigfoot or similar package.|groupid=g1>>.
-==Writing the footnotes
-===Footnotes for group1:
-<<footnotes|g1>>
-===Footnotes for group2:
-<<footnotes|g2>>

data/examples/creole_example_new_plugin.rb DELETED

@@ -1,51 +0,0 @@
-#encoding: cp1252
-=begin rdoc
-Example how to use self defined placeholders with creole/creole2doc.
-=end
-$:.unshift( '../lib' )
-require 'creole/creole2doc.rb'
-begin
-  require 'rake4latex_pdflatex'
-rescue LoadError
-  puts "rake4latex not installed -> no translation of LaTeX-file"
-end
-class PDFComment_html < Docgenerator::Creole::Creole_inclusion_and_plugin
-  set_plugin_key 'pdfcomment'
-  #~ Docgenerator::Creole::Plugins::Collection['pdfcomment'] = self
-  #~ def initialize( inclusionname, description, options, wiki )
-    #~ super
-  #~ end
-  #Return content as pdfcomment
-  def to_doc( target, options = {})
-    target == :latex ? "\\pdfcomment{%s}" % @description : ''
-  end
-end
-#
-# Move all results to another folder
-#
-Dir.chdir('results')
-#Build document with usepackage{listings}...
-doc = Docgenerator::Document.new( :title => 'Creole with placeholder' )
-doc.head << element(:usepackage,{},'pdfcomment').cr  #-> \pdfcomment
-doc.body << creole = Docgenerator::Creole::Creole.new(:content => DATA )
-# ###############################
-# Save the files
-# ###############
-#~ doc.save( __FILE__.sub(/\.rb/, ".html"))
-doc.save( __FILE__.sub(/\.rb/, ".tex"),
-  :runtex => [:statistic, :clean]
-  )
-__END__
-This is text with a PDF-comment<<pdfcomment|This is a comment>>
-<<<pdfcomment|This is a comment
-longtext
->>>

data/examples/creole_example_placeholder.rb DELETED

@@ -1,77 +0,0 @@
-#encoding: cp1252
-=begin rdoc
-Example how to use HTML with creole/creole2doc.
-=end
-$:.unshift( '../lib' )
-require 'creole/creole2doc.rb'
-begin
-  require 'rake4latex_pdflatex'
-rescue LoadError
-  puts "rake4latex not installed -> no translation of LaTeX-file"
-end
-#
-# Move all results to another folder
-#
-Dir.chdir('results')
-#Build document with usepackage{listings}...
-doc = Docgenerator::Document.new( :title => 'Creole with raw data' )
-doc.body << Docgenerator::Creole::Creole.new(:content => DATA )
-# ###############################
-# Save the files
-# ###############
-doc.save( __FILE__.sub(/\.rb/, ".html"))
-doc.save( __FILE__.sub(/\.rb/, ".tex"),
-  :runtex => [:statistic, :clean]
-  )
-__END__
-=Raw HTML
-HTML can be added via placeholders.
-In LaTeX it will be ignored.
-<<<html
-<p style = 'color: red'>red paragraph</p>
->>>
-=Raw LaTeX
-LaTeX-Code can be added via placeholders.
-In HTML it will be ignored.
-So you can add math.
-<<<latex
-$$\sum_{i=1}^5 = 15$$
->>>
-=Raw text
-{{{
-Some raw text.
-The text formatting is unchanged
-}}}
-=Add some ruby
-You can eval ruby code in your creole-text.
-The following Rubycode is executed (eval), the result is added as raw text.
-1 + 1 = <<ruby_raw|1+1>>
-The following Rubycode is executed (eval), the result is added as wiki text.
-1 + 1 = <<ruby_raw|1+1>>
-==Countdown
-Countdown: <<ruby_raw|(1..10).to_a.reverse.join("-")>>
-Countdown: <<ruby|(1..10).to_a.reverse.join("-")>>
-Countdown as raw data: <<ruby_raw|(1..10).to_a.reverse.map{|i| "*%i" % i}.join("\n")>>
-Countdown as wiki data: <<ruby|(1..10).to_a.reverse.map{|i| "*%i" % i}.join("\n")>>

data/examples/creole_example_rail.rb DELETED

@@ -1,154 +0,0 @@
-=begin rdoc
-Example how to create rail-diagramms (syntax diagrams specified in EBNF)
-with creole2doc.
-This examples needs _rail_:
-* http://texcatalogue.sarovar.org/entries/rail.html
-* http://www.dante.ctan.org/tex-archive/support/rail/
-* http://tex.lickert.net/tipps/rail/index.html
-=end
-$:.unshift '../lib'
-require 'creole/plugins/rail.rb'
-include Docgenerator
-begin
-  require 'rake4latex_pdflatex'
-rescue LoadError
-  puts "rake4latex not installed -> no translation of LaTeX-file"
-end
-#
-# Move all results to another folder
-#7
-Dir.chdir('results')
-doc = Creole::Creole_document.new(
-  :title => 'Rail-Diagramms in Creole'
-)
-doc.doc.head << Creole::Rail::Rail_diagramm::TEX_PACKAGE_RAIL
-doc.doc.head << element(:latexonly,{}, [
-  Creole::Rail::Rail_diagramm::RAIL_ALIAS,
-  '\railterm{lowcharacter,uppercharacter}',
-  ])
-doc  << DATA
-# ###############################
-# Save the files
-# ###############
-#~ doc.save( __FILE__.sub(/\.rb/, ".html")) --> makes no sense
-doc.save( __FILE__.sub(/\.rb/, ".tex"),
-  :runtex => [:statistic, :clean]
-  #~ :runtex => [:statistic] #keep log...
-  )
-__END__
-=Rail-Diagramms
-Rail-diagramms are specifiv Syntax-diagramms.
-[[http://en.wikipedia.org/wiki/Syntax_diagram|Syntax diagramms at Wikipedia]]
-They represent a graphical alternative to Backus-Naur Form or EBNF.
-More about the rail-programm at:
-* http://texcatalogue.sarovar.org/entries/rail.html
-* http://www.dante.ctan.org/tex-archive/support/rail/
-* http://tex.lickert.net/tipps/rail/index.html
-==Main elements
-Non-finite elements (squared text):
-//test//
-<<<rail|nofinite
-test
->>>
-Finite element (circled text)
-Just put the text in '':
-//'final'//
-<<<rail|finite
-'final'
->>>
-==Path descriptions
-//[Text before] 'final' //
-<<<rail|textbefore
-[Text before] 'final'
->>>
-To put text after an element, you have to put the text in braces
-//'final' ( [Text after] )//
-<<<rail|textafter
-'final' ( [Text after] )
->>>
-==Alternatives
-//A | B //
-<<<rail|alternative
-A | B
->>>
-==Optional pathes
-Optional: //'final' ?//
-<<<rail|optional
-'final' ?
->>>
-==Loops with +
-Simple loop: //'final' +//
-<<<rail|loop
-'final' +
->>>
-Loop with an additional part:
-// A + B//
-<<<rail|loop2
-A + B
->>>
-The part before the + must be visited during a walk through the rails.
-The part after the + is only visited if you enter the loop.
-With braces you can define your own ways through the diagramm.
-//( A + B )//
-<<<rail|loop3
-( A +  B )
->>>
-//( A + ) B//
-<<<rail|loop4
-( A + ) B
->>>
-//( A B + )//
-<<<rail|loop5
-( A B + )
->>>
-//( A + ';' ) B//
-<<<rail|loop6
-( A + ';' ) B
->>>
-==A complex example
-<<<rail|complex
-      [1] (
-            ( '[' string ']' )
-           ? body[2--6] + '|'
-           )
-    | [2] body[3--6] '*' body[5--6]
-    | [2] body[3--6] '+' body[5--6]
-    | [3] ( body[4--5] + )
-    | [4] body[5] '?'
-    | [5] identifier ( '[' string ']' ) ?
-    | [5] quote string quote
-    | [5] dquote string dquote
-    | [5] '(' body[1--6] ')'
-    | [5] cr
-    | [6]
-    ;
->>>

data/examples/creole_example_rubycode.rb DELETED

@@ -1,144 +0,0 @@
-#encoding: cp1252
-=begin rdoc
-Example how to use inline-ruby with creole/creole2doc.
-=end
-$:.unshift( '../lib' )
-require 'creole/plugins/rubycode4creole.rb'
-begin
-  require 'rake4latex_pdflatex'
-rescue LoadError
-  puts "rake4latex not installed -> no translation of LaTeX-file"
-end
-#
-# Move all results to another folder
-#
-Dir.chdir('results')
-#Build document with usepackage{listings}...
-doc = Docgenerator::Rubycode::CodeTest.mk_document( 'Rubycode4doc-Test' )
-doc.head << Docgenerator::Tables::TEX_PACKAGE_TABULARX
-doc.body << Docgenerator::Creole::Creole.new(:content => DATA )
-# ###############################
-# Save the files
-# ###############
-doc.save( __FILE__.sub(/\.rb/, ".html"))
-doc.save( __FILE__.sub(/\.rb/, ".tex"),
-  :runtex => [:statistic, :clean]
-  )
-__END__
-=Easy example
-rubycode
-<<<rubycode
-1 + 1
->>>
-----
-rubycode_output
-<<<rubycode_output
-puts 1 + 1
->>>
-----
-rubycode_evaluated
-<<<rubycode_evaluated
-1 + 1
->>>
-----
-rubycode_in_tab
-<<<rubycode_in_tab
-1 + 1
->>>
-=More examples
-==Variables and output==
-===Sourcecode===
-<<<rubycode
-a = 5
-b = a * 5
-puts b
-puts b + 3
->>>
-===Output===
-<<<rubycode_output
-a = 5
-b = a * 5
-puts b
-puts b + 3
->>>
-===Evaluation
-<<<rubycode_evaluated
-a = 5
-b = a * 5
-puts b
-puts b + 3
->>>
-===Evaluation in tabular===
-<<<rubycode_in_tab
-a = 5
-b = a * 5
-puts b
-puts b + 3
->>>
-==Strings and Here-Docs==
-===Sourcecode===
-<<<rubycode
-b	= 'Booo'
-puts "#{b}"
-puts '#{b}'
-puts %Q{#{b}}
-puts %q{#{b}}
->>>
-===Evaluation
-<<<rubycode_evaluated
-b	= 'Booo'
-puts "#{b}"
-puts '#{b}'
-puts %Q{#{b}}
-puts %q{#{b}}
->>>
-===Evaluation in tabular===
-<<<rubycode_in_tab
-b	= 'Booo'
-puts "#{b}"
-puts '#{b}'
-puts %Q{#{b}}
-puts %q{#{b}}
->>>
-==Loops==
-===Sourcecode===
-<<<rubycode
-3.times{ puts 11 }
-1.upto(3){|i| puts i}
-1.upto(3){|i| puts "run #{i}"}
->>>
-===Output===
-<<<rubycode_output
-3.times{ puts 11 }
-1.upto(3){|i| puts i}
-1.upto(3){|i| puts "run #{i}"}
->>>
-===Evaluated
-<<<rubycode_evaluated
-3.times{ puts 11 }
-1.upto(3){|i| puts i}
-1.upto(3){|i| puts "run #{i}"}
->>>
-===Evaluation in tab
-<<<rubycode_in_tab
-3.times{ puts 11 }
-1.upto(3){|i| puts i}
-1.upto(3){|i| puts "run #{i}"}
->>>