docgenerator-creole 3.0.0

data/examples/creole_example_struktex.rb

@@ -0,0 +1,170 @@
+#encoding: cp1252
+=begin rdoc
+Example how to define a structogramm with creole2doc.
+=end
+
+require 'rubygems'
+$:.unshift("../lib")  #for local tests with uninstalled gem
+require 'docgenerator-creole.rb'
+require 'docgenerator/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/creole_example_tabular.rb

@@ -0,0 +1,96 @@
+#encoding: cp1252
+=begin rdoc
+Example for creole/creole2doc
+=end
+
+
+require 'rubygems'
+$:.unshift("../lib")  #for local tests with uninstalled gem
+#~ require 'docgenerator'
+require 'docgenerator/creole'	
+
+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 = Docgenerator::Document.new(
+  :title	=>	'creole2doc_example_tabular.rb: Test for tabulars with creole'
+)
+
+=begin
+Add creole-content.
+=end
+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__
+=Normal tabular
+
+|one | two
+|1 | 2
+|1.0 | 2.0
+
+==tabular with heading
+|=header col1|=header col2| 
+|col1|col2| 
+|you         |can         | 
+|also        |align\\ it. | 
+
+
+=tabular as placeholder
+<<<tabular
+|!columns=3
+|!columndescription=ccc
+|=1
+|=2
+|=3
+|-|hline
+|eins
+|zwei
+|drei
+|-
+|one
+|two
+|three
+>>>
+
+=tabular with cell option
+
+After || you may define special data
+
+<<<tabular
+|!columns=3
+|!columndescription=ccc
+|eins||css=color: red
+|css = zwei
+|||class=empty
+|-
+|normal
+|//italic//
+|//italic//||class=it
+|-
+|text with | nice! ||class = it
+|||css = 
+|
+>>>
+
+

data/examples/creole_example_tikz.rb

@@ -0,0 +1,47 @@
+=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 'docgenerator/creole'
+require 'docgenerator/creole/plugins/tikz.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 => 'Tikz-images in Creole'
+)
+doc.doc.head << element(:usepackage,{}, 'tikz').cr
+
+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__
+<<<tikz_img|../../unittest/Red_Flower.jpg|remember picture|width=\textwidth
+\node[red,rounded corners,draw] at (.8,.7) (source) {1};
+>>>
+* (1) Blossom<<tikz|\draw[<-,red,ultra thick] (0,0) -- (source);>>
+

data/lib/docgenerator-creole.rb

@@ -0,0 +1,5 @@
+#encoding: utf-8
+=begin rdoc
+=end
+
+require_relative 'docgenerator/creole.rb'

data/lib/docgenerator/creole.rb

@@ -0,0 +1,15 @@
+#encoding: utf-8
+=begin rdoc
+=Background
+The docgenerator-gem create documents with export feature as
+LaTeX, HTML, Creole (a common wiki markup, see http://www.wikicreole.org ),
+conTeXt (only rudimentory),
+plain text (not very good supported).
+
+This gem extends the docgenerator-gem with a Creole-parser.
+
+=end
+
+#~ gem 'docgenerator', '~> 3'
+require 'docgenerator' #unless defined? Docgenerator
+require_relative 'creole/base.rb'

data/lib/docgenerator/creole/base.rb

@@ -0,0 +1,170 @@
+#encoding: utf-8
+=begin rdoc
+This is a Creole-to-Docgenerator converter.
+The Docgenerator-data can be exported as
+- HTML
+- LaTeX
+- Creole
+- Plain text
+
+For another Creole-to-XHTML converter see 
+https://rubyforge.org/projects/wikicreole/
+
+More about creole at http://www.wikicreole.org/
+=end
+
+module Docgenerator
+
+=begin rdoc
+Collect the classes to handle Creole-input.
+
+More about creole at http://www.wikicreole.org/
+=end
+  module Creole
+    VERSION = '3.0.0'
+
+      #Little structure to store the parsing result.
+      Creole_line = Struct.new('Creole_line', :type, :content, :add_info)
+      
+      #Hash with Characters. 
+      #This characters will be converted into elements.
+      CHARACTERS = {
+        '%' => element(:'%'),
+        '$' => element(:'$'),
+        '&' => element(:ampersand),
+        '->' => element(:rightarrow),
+        '=>' => element(:Rightarrow),
+        '<-' => 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;  #bottom double quote
+        '“' => element(:ldquo),    #"zu 	&#8220; #left double quote
+        '”' => element(:rdquo),    #right double quote
+        '–' => element(:ndash),  #	&#8211;
+        '—' => element(:mdash),  #	&#8211;
+      }
+  
+=begin rdoc
+Add a quick online-help.
+=end
+      def self.help( option = :syntax)
+        hlp = []
+        hlp << "==Creole help #{option}"
+        case option
+          when :syntax
+            hlp << <<Syntax
+Headings:
+  = Level 1 (largest) =
+  == Level 2 ==
+see also Creole.help(:headings)
+
+Bold And Italics:
+** Bold
+// Italics
+You can close them. If not, the markup end with the paragraph.
+
+Links: See Creole.help(:links)
+Syntax
+          when :creole
+            hlp << <<creole
+docgenerator/creole has some special features:
+*headings allows labels ([key] direct after the =)
+*line breaks are ignored, the text is wrapped.
+  (you can set it off with option :wrap_at => 0)
+creole
+         when :headings
+            hlp << <<headings
+Headings:
+  = Level 1 (largest) =
+  == Level 2 ==
+  === Level 3 ===
+  ==== Level 4 ====
+  ===== Level 5 =====
+  ====== Level 6 ======
+  === Also level 3
+  === Also level 3 =
+  === Also level 3 ==
+  === **not** //parsed// ===
+Headings with label:  
+  =[lev1] Level 1 (largest) =
+  ==[lev1.1] Level 2 ==
+
+The content is not parsed.
+Details see http://www.wikicreole.org/wiki/Headings
+headings
+        when :links
+          hlp << <<links
+Explicit:
+* [[http://ruby.lickert.net/docgenerator]]
+* [[http://ruby.lickert.net/docgenerator|Details on docgenerator.rb]]
+
+Implicit:
+* http://ruby.lickert.net/docgenerator
+links
+        when :tabular
+          hlp << <<tabular
+Wikimedia-like syntax:
+  <<<tabular
+  |!columns=3
+  |!columndescription=ccc
+  |=1
+  |=2
+  |=3
+  |-
+  |eins
+  |zwei
+  |drei
+  |-
+  |one
+  |two
+  |three
+  >>>
+tabular
+          else
+            hlp << "Undefined help for #{option.inspect}"
+        end
+        return hlp.join("\n")
+      end #self.help
+
+=begin
+Load sub-classes.
+=end
+    require_relative 'placeholder.rb'
+    require_relative 'tabular.rb'
+    require_relative 'inclusion_and_plugins.rb'
+    require_relative 'inclusions.rb'
+    require_relative 'characters.rb' #defined as inclusions
+    require_relative 'plugins.rb'
+    
+    require_relative 'document.rb'
+    require_relative 'creole.rb'
+
+  end #module Creole
+end #module Docgenerator
+
+
+if [__FILE__ ].include?($0)
+  
+  [
+  :syntax,
+  :creole,
+  :wikimedia,
+  :trippfall,
+  :headings,
+  :links,
+  ].each{|key| 
+    puts '='*50
+    puts Docgenerator::Creole::Creole.help(key) 
+    puts '='*50
+  }
+  
+  creole = Docgenerator::Creole::Creole.new
+  creole << 'x{{-}}y{{-}}z'
+  creole << 'x{{shy}}y{{shy}}z'
+  creole << ''
+  creole << '{{../index.html#aa}}'
+  puts creole.to_html
+end