docgenerator 1.2.1 → 2.0.0

data/examples/creole_example_struktex.rb

@@ -0,0 +1,169 @@
+#encoding: cp1252
+=begin rdoc
+Example how to define a structogramm with creole2doc.
+=end
+
+require 'rubygems'
+$:.unshift("../lib")  #for local tests with uninstalled gem
+require 'creole/creole2doc'
+require 'creole/plugins/struktex.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')
+
+doc = Docgenerator::Document.new(
+  :title => 'creole/plugins/struktex.rb - Structogramms with Creole2Doc',
+  #~ :shorttitle => 'struktex.rb',
+  :author => 'Knut Lickert',
+  :maketitle => true
+)  
+doc.head << Docgenerator::Packages::Struktex::USEPACKAGE_STRUKTEX
+doc.head << Docgenerator::Packages::Struktex::USEPACKAGE_STRUKTEX_PROOF
+
+
+#Redefinition to_latex for this documentation.
+#Result is structogramm and sourcecode.
+class Docgenerator::Packages::Struktex::Structogramm
+  alias :old_latex :to_latex
+	def to_latex(options={})
+		return [self.verbatim.to_latex, self.old_latex(options)].join
+	end
+end
+
+
+doc.body << (Docgenerator::Creole::Creole.new( :content => <<WIKI
+=Preamble=
+Code2Structgramm.rb translates a pseudo-code programm 
+to TeX-code for the \\StrukTeX-package. 
+\\StrukTeX\\ creates Nassi-Shneidermann-diagramms.
+
+There is no support by this generator for:
+*Interface description
+*Variables and Keywords
+*Comments
+
+=Example=
+An example, based on a German Saying 
+''Der Krug geht solange zum Brunnen bis er bricht''
+<<<structogramm|Krug;120;45
+    WHILE	Krug nicht zerbrochen
+        Krug geht zum Brunnen
+    ENDWHILE
+    Qualit�tspr�fung
+		-> Krug			Testgut
+		<- res_1			Pr�fergebnis
+    IF	Krug zerbrochen
+    THEN
+        Schade
+    ELSE
+		Stabiler Krug
+    ENDIF
+>>>
+
+=Statements=
+No support for:
+*Height
+
+<<<structogramm|Simple Statements;120;30
+			Statement
+			=>	Call procedure
+			<>	Return value
+			<=	Exit with return value
+>>>
+
+==Declarations==
+With declarations you can define interfaces of sub-routines.
+This declarations are part of the command
+<<<structogramm|Declarations/Interfaces;120;25
+			Statement
+			->	field1	description
+			<-	field2	description
+			<->	field3	description
+>>>
+
+==IF-Statement==
+		IF Condition
+		THEN	size	text
+		ELSE		size	text
+		ENDIF
+<<<structogramm|Test f�r IF;120;40
+			IF Bedingung?
+			THEN 6	Ja
+				IF Andere Frage?
+				THEN 
+					<= Ergebnis
+				ELSE
+					<= Anderes Ergebnis
+				ENDIF
+			ELSE	6	Nein
+				IF Andere Frage?
+				THEN 4
+					<= Ergebnis
+				ELSE	5
+					<= Anderes Ergebnis
+				ENDIF
+			ENDIF
+>>>
+
+==CASE-statements==
+The first number after CASE defines the degree of the case-line.
+
+The WHEN clause has an optional parameter:
+*c	centered
+*r right-aligned
+<<<structogramm|CASE Statements;120;40
+			CASE	5	variable
+			WHEN	value1
+				Statement 1-1
+				Statement 1-2
+			WHEN[r]	value2
+				Statement 2-1
+				Statement 2-2
+			WHEN[c]	value3
+				Statement 3-1
+				Statement 3-2
+			WHEN	value4
+				Statement 4-1
+				Statement 4-2
+			ENDCASE
+>>>
+==While-statements==
+<<<structogramm|While Statements;120;15
+			WHILE Condition
+				Statement
+			ENDWHILE
+>>>
+
+==Repeat-Until-statements==
+<<<structogramm|Repeat-Until Statements;120;15
+			REPEAT 
+				Statement
+			UNTIL	Condition
+>>>
+
+==FOREVER-Loop-statements==
+<<<structogramm|FOREVER-Loop Statements;120;30
+			FOREVER
+				Statement
+				<= Exit
+			ENDFOREVER
+>>>
+
+WIKI
+))
+
+# ###############################
+# Save the files
+# ###############
+#~ doc.save( __FILE__.sub(/\.rb/, ".html")) #makes no sense
+doc.save( __FILE__.sub(/\.rb/, ".tex"),
+  :runtex => [:statistic, :clean]
+  )

data/examples/docgenerator_example.rb

@@ -24,7 +24,7 @@ Dir.chdir('results')
 #
 #   Create a document
 #
-doc = Document.new(
+doc = Docgenerator::Document.new(
   :title => 'Testdocument for docgenerator.rb',
   :language => 'english',
   :author => 'Authorname',

data/examples/docgenerator_example_footnote.rb

@@ -13,6 +13,7 @@ link:examples/results_expected/docgenerator_example_footnote.pdf
 require 'rubygems'
 $:.unshift("../lib")  #for local tests with uninstalled gem
 require 'docgenerator'
+include Docgenerator
 begin 
   require 'rake4latex_pdflatex' 
 rescue LoadError 

data/examples/docgenerator_example_list.rb

@@ -5,6 +5,9 @@
 require 'rubygems'
 $:.unshift("../lib")  #for local tests with uninstalled gem
 require 'docgenerator'
+include Docgenerator
+#~ DOCGENERATOR_LOGGER.level = Log4r::DEBUG
+
 begin 
   require 'rake4latex_pdflatex' 
 rescue LoadError 

data/examples/docgenerator_example_restrictions.rb

@@ -18,7 +18,7 @@ Dir.chdir('results')
 #
 #   Create a document
 #
-doc = Document.new(
+doc = Docgenerator::Document.new(
   :title => 'Testdocument with restrictions to output format'
   )
 

data/examples/docgenerator_example_tabular.rb

@@ -18,7 +18,7 @@ Dir.chdir('results')
 #
 #   Create a document
 #
-doc = Document.new(
+doc = Docgenerator::Document.new(
   :title => 'Testdocument with tabulars'
   )
 

data/examples/docgenerator_example_tripfalls.rb

@@ -19,12 +19,12 @@ Dir.chdir('results')
 #
 #Set level of gloabl error messages.
 #
-DOCGENERATOR_LOGGER.level = Log4r::WARN
+Docgenerator::DOCGENERATOR_LOGGER.level = Log4r::WARN
 
 #
 #   Create a document
 #
-doc = Document.new(
+doc = Docgenerator::Document.new(
   :title => 'Testdocument with tripfalls'
   )
 #~ doc.log.level = Log4r::WARN

data/examples/results/readme

@@ -1 +1,2 @@
-Target folder for test examples
+Target folder for test examples.
+

data/examples/wiki2docgenerator_example.rb

@@ -1,32 +1,62 @@
-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
+#encoding: cp1252
+=begin rdoc
+Example for wiki2doc/wiki2docgenerator
 
-#~ Element.log(true)
-#~ Element.trace==true
+==Obsolete!!
+There is no support for the wikimedia-syntax in docgenerator.
 
-wiki	= Wikitext.new( :parsetext => true )
+Please use creole/creole2doc.
+=end
+require 'rubygems'
+$:.unshift("../lib")  #for local tests with uninstalled gem
+#~ require 'docgenerator'
+require 'wiki2doc/wiki2docgenerator'	if ! defined? Wikitext
+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
+Define the wiki-container
+=end
+wiki	= Docgenerator::Wikimedia::Wikitext.new( :parsetext => true )
 wiki	<< DATA#.readlines.to_s
-#~ wiki	<< %q|
-#~ |
 
-doc = Document.new()
-doc.title	=	'wiki2docgenerator_example.rb: Test for wiki2docgenerator'
+
+=begin
+Create document
+=end
+doc = Docgenerator::Document.new(
+  :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.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)
+doc.body << wiki.footnotes	#include the footnotes (only html)
+
+# ###############################
+# Save the files
+# ###############
+doc.save( __FILE__.sub(/\.rb/, ".html"))
+doc.save( __FILE__.sub(/\.rb/, ".tex"),
+  :runtex => [:statistic, :clean]
+  )
+
 
 __END__
 ==Wiki2docgenerator.rb==
@@ -48,10 +78,10 @@ Example-Programm:
 	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)
+	doc.save('test.html')
+	doc.save('test.wiki')
+	doc.save('test.txt')
+	doc.save('test.tex')
 
 ==Titel 1==
 ===Titel 2===
@@ -95,7 +125,7 @@ text in neuem Absatz
 ===Wilde Mischung Punkte- und Nummerierte Liste nacheinander===
 *list	(*)
 **list	(**)
-#*list (#*) Hier Wechsel auf erster Ebene
+#*list (\#*) Hier Wechsel auf erster Ebene
 
 ===Definitionsliste ===
 ;Definitionsliste
@@ -178,7 +208,7 @@ Besonderheiten:
 ==Tabellen==
 Die Syntax:
 *{|	beginnt eine Tabelle. Hier k�nnen zus�tzliche Formatierungseigenschaften kommen.
-**Zumindest columns==__ sollte gesetzt sein
+**Zumindest columns==?? sollte gesetzt sein
 *!		beginnt eine neue Zelle einer Titelzeile
 *|		beginnt eine neue Zelle
 *||	trennt zwei Zellen	(nicht unterst�tzt)
@@ -193,7 +223,7 @@ Die Syntax:
 *|}	beendet eine Tabelle
 
 Beispiel 1:
-{|columns=2
+{|columns=2|columndescription=cc
 |Zelle 1
 |Zelle 2
 |-
@@ -205,9 +235,9 @@ Beispiel 1:
 |}
 
 Beispiel 2:
-{| border=1|columns=6
+{| border=1|columns=6|columndescription=cccccc
 |Zelle 1
-|colspan=5|text-align=center| Zelle 2 �ber zwei Spalten
+|colspan=5|text-align=center| Zelle 2 �ber f�nf Spalten
 |-
 |Zelle 3
 |Zelle 4
@@ -259,7 +289,6 @@ Mit
 	<<<
 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
 

data/lib/creole/creole2doc.rb

@@ -1,4 +1,4 @@
-# encoding: utf-8
+#encoding: cp1252
 =begin rdoc
 This is a Creole-to-Docgenerator converter.
 The Docgenerator-data can be exported as
@@ -14,16 +14,17 @@ https://rubyforge.org/projects/wikicreole/
 More about creole at http://www.wikicreole.org/
 =end
 
-class Creole
-  VERSION = '1.2.1'
-end
-#~ $:.unshift("../") #for test purposes.
-#Load the same version of docgenerator 
+$:.unshift("..") if $0 == __FILE__ #for test purposes.
 require 'docgenerator'
-if Creole::VERSION != Docgenerator::VERSION
-  raise LoadError, "Creole V#{Creole::VERSION} needs Docgenerator #{Creole::VERSION}, but gets #{Docgenerator::VERSION}" 
-end
 
+module Docgenerator
+
+=begin rdoc
+Collect the classes to handle Creole-input.
+
+More about creole at http://www.wikicreole.org/
+=end
+module Creole
 
 =begin rdoc
 Some class definitions for the Creole-class.
@@ -32,17 +33,6 @@ class Creole
 
   #Little structure to store the parsing result.
   Creole_line = Struct.new('Creole_line', :type, :content, :add_info)
-  #Define Placeholders
-  #Placeholders are used via <<<...>>>
-  #Default: Creole_dummy_placeholder (set in class definition Creole_dummy_placeholder)
-  Placeholders = Hash.new()
-  #Define Inclusions
-  #Inclusions are used via {{...}}
-  #Default: Creole_inclusion_img (defined in class definition Creole_inclusion_img)
-  Inclusions = Hash.new()
-  #Define Plugins
-  #Plugins are used via <<...>>
-  Plugins = Hash.new()
   
   #Hash with Characters. 
   #This characters will be converted into elements.
@@ -55,13 +45,13 @@ class Creole
     '<-' => element(:leftarrow),
     '<=' => element(:Leftarrow),
     '_' => element(:underscore),
-    '…' => element(:ldots),  
-    '‚' => element(:sbquo),   #	einfaches low-9-Zeichen, U+201A , &#8218;
-    '’' => element(:rsquo),   #'zu &#8217;
-    '„' => element(:bdquo),   #"auf  &#8222;
-    '“' => element(:ldquo),    #"zu 	&#8220;
-    '–' => element(:ndash),  #	&#8211;
-    '—' => element(:mdash),  #	&#8211;
+    '�' => element(:ldots),  
+    '�' => element(:sbquo),   #	einfaches low-9-Zeichen, U+201A , &#8218;
+    '�' => element(:rsquo),   #'zu &#8217;
+    '�' => element(:bdquo),   #"auf  &#8222;
+    '�' => element(:ldquo),    #"zu 	&#8220;
+    '�' => element(:ndash),  #	&#8211;
+    '�' => element(:mdash),  #	&#8211;
   }
   
 =begin rdoc
@@ -164,7 +154,7 @@ end #Creole
 require_relative 'creole_placeholder.rb'
 require_relative 'creole_tabular.rb'
 require_relative 'creole_inclusion_and_plugins.rb'
-begin require 'privat/creole_affiliate.rb'; rescue LoadError; end #Just some privat extension
+#~ begin require 'privat/creole_affiliate.rb'; rescue LoadError; end #Just some privat extension
 
 require 'log4r'
 
@@ -178,7 +168,6 @@ multiple HTML (corresponding to pages).
 HTML-pagebreak could be forced with ======== or something similar.
 =end
 class Creole_document
-  include Docgenerator  #get VERSION
 
 =begin rdoc
 Define a creole document. The settings are forwarded to Document#new()
@@ -261,7 +250,8 @@ Example:
  =Test document
  This is a little test text with **bold** and //italic// text.
  txt
- puts wiki.to_latex()
+ wiki.to_latex()
+ 
 Often I use it in combination with "Here"-Documents with __END__:
 
  require 'creole/creole2doc'
@@ -305,9 +295,9 @@ Options:
       :ignore => nil, #Define a "local" comment, e.g /^#~.*$/ 
       :encoding => __ENCODING__,
     }.update(options)
-    @placeholders = Placeholders.dup
-    @inclusions     = Inclusions.dup
-    @plugins        = Plugins.dup
+    @placeholders = Placeholders::Collection.dup
+    @inclusions     = Inclusions::Collection.dup
+    @plugins        = Plugins::Collection.dup
     
     #Store the given source text
     @source  = []
@@ -316,12 +306,13 @@ Options:
     @toc  = []  #Collection of all heading lines
     @footnotegroups = {}  #Collection of footnote groups
     
-    
     @targetdir  = @options[:targetdir] if @options[:targetdir]
+    
     @log  = @options[:log]
     @log = Log4r::Logger.new(@options[:name], Log4r::INFO) unless @log
     @log.outputters = Log4r::StdoutOutputter.new('log_stdout') if  @log.outputters.empty?
 
+    @creation_caller = caller.first
     self  <<  @options[:content]  if @options[:content]
   end
   
@@ -479,7 +470,7 @@ Parse the given creole code and build a "normalized source"
           normsource << Creole_line.new(:placeholder, 
                                         @placeholders['creole_tabular'].new(self),
                                         :start => lineno
-                                      ) unless normsource.last.content.is_a?(Creole_creoletab)
+                                      ) unless normsource.last.content.is_a?(Creole_tab)
           normsource.last.content << line
         #http://www.wikicreole.org/wiki/PreformattedAndNowiki
         when /^\{\{\{\s*$/  #Kind of verbatim
@@ -489,7 +480,7 @@ Parse the given creole code and build a "normalized source"
         when /^<<<(.*)/
           ph, par = $1.split(/\|/,2)
           placeholder = @placeholders[ph].new(self, par)
-          if placeholder.is_a?(Creole_dummy_placeholder)
+          if placeholder.instance_of?(Placeholders::Dummy)
             @log.warn("Unknown placeholder #{ph.inspect} used in line #{lineno}" ) if @log.warn?
           end
           normsource << Creole_line.new(:placeholder, placeholder, :start => lineno )
@@ -529,7 +520,7 @@ Parse the given creole code and build a "normalized source"
   #
   
 =begin rdoc
-Return a table of contents as a list
+Return a table of contents as a list.
 =end
   def toc( i_options = {})
     options = {
@@ -571,6 +562,10 @@ Return a table of contents as a list
         elsif level < toclabel.size
           toclabel.pop
         end
+        if ! toclabel[level-1]
+          @log.fatal("toclevel error: #{__FILE__}##{__LINE__}")
+          return nil
+        end
         toclabel[level-1] = toclabel[level-1] + 1 
 
         #Check if there was already a label.
@@ -650,7 +645,6 @@ Used by
                               }, line.content ).cr          
                               #~ }, inline(line.content, options ) ).cr          
         when :list
-          #~ puts line[:add_info].inspect
           key = line.add_info[:listtype]
           if ! elements[key]
             case key[-1,1]
@@ -771,7 +765,7 @@ Options is a Hash and may contain:
             else  #internal link
               #This is normally the wiki-links.
               #But this is no wiki, it's a documentgenerator with wiki syntax.
-              options[:log].warn("Unclear link <#{el}>") if options[:log].warn?
+              options[:log].warn("Unclear link <#{el}> #{self.inspect}") if options[:log].warn?
               link = link
           end
           if link == linktext #Avoid replacement of // inside linktext
@@ -832,7 +826,7 @@ Options is a Hash and may contain:
         else  #text to add
           #Replace characters.
           if CHARACTERS[el]
-            insertion = CHARACTERS[el] if CHARACTERS[el]
+            insertion = CHARACTERS[el]
             startspace = endspace = nil
           else
             startspace = ( el[0,1] =~ /\s/ )
@@ -871,7 +865,8 @@ The last paramter contains a hash with the supported inclusions/plugins.
 
     inclusion = inclusions[link]
     #check inclusion.ancestors?
-    if inclusion.superclass != Creole_inclusion_and_plugin
+    #~ if inclusion.superclass != Creole_inclusion_and_plugin
+    if inclusion.is_a?(Creole_inclusion_and_plugin)
       @log.error( "Wrong inclusion/plugin definition for #{link} (#{inclusion.inspect}, expected #{inclusions.default.superclass})") if @log.error?
       return nil
     end
@@ -898,28 +893,32 @@ Relative pathes are searched from @options[:targetdir] (default '.').
       fpath = File.expand_path("#{Dir.pwd}/#{path}")
       log.debug("Reference not found: <#{fpath}>") if log.debug?
     end
-end #check_link_existence
+  end #check_link_existence
+
+  def inspect()
+    "<#{self.class} (created #{@creation_caller})>"
+  end
 end #Creole 
+end #module Creole
+end #module Docgenerator
+
 
 if [__FILE__ ].include?($0)
   
-  #~ [
-  #~ :syntax,
-  #~ :creole,
-  #~ :wikimedia,
-  #~ :trippfall,
-  #~ :headings,
-  #~ :links,
-  #~ ].each{|key| 
-    #~ puts '='*50
-    #~ puts Creole.help(key) 
-    #~ puts '='*50
-  #~ }
-  
-  #~ puts `call "../../unittest/unittest_creole2doc.rb"`
-  #~ require 'quicktest'
+  [
+  :syntax,
+  :creole,
+  :wikimedia,
+  :trippfall,
+  :headings,
+  :links,
+  ].each{|key| 
+    puts '='*50
+    puts Docgenerator::Creole::Creole.help(key) 
+    puts '='*50
+  }
   
-  creole = Creole.new
+  creole = Docgenerator::Creole::Creole.new
   creole << 'x{{-}}y{{-}}z'
   creole << 'x{{shy}}y{{shy}}z'
   creole << ''