docgenerator 2.1.1 → 3.0.0

data/examples/creole_example_struktex.rb

@@ -1,169 +0,0 @@
-#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/creole_example_tabular.rb

@@ -1,97 +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_tabular.rb: Test for tabulars with 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__
-=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/wiki2docgenerator_example.rb

@@ -1,299 +0,0 @@
-#encoding: cp1252
-=begin rdoc
-Example for wiki2doc/wiki2docgenerator
-
-==Obsolete!!
-There is no support for the wikimedia-syntax in docgenerator.
-
-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
-
-
-=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
-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==
-The class Wiki2docgenerator allows to analyse a text in Wiki-format and
-transform it to a "docgenerator"-object.
-
-This object can be saved as HTML or TeX (or Wiki again - in preparation).
-
-The wiki-syntax is defined at:
-*http://de.wikipedia.org/wiki/WikiSyntax
-*http://de.wikipedia.org/wiki/Hilfe:Textgestaltung
-
-Not the complete Syntax is used or supported.
-Please check the following example coding for the features.
-
-Example-Programm:
-	doc == Document.new()
-	doc.title	==	'Test'
-	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')
-	doc.save('test.wiki')
-	doc.save('test.txt')
-	doc.save('test.tex')
-
-==Titel 1==
-===Titel 2===
-#~ =====Titel 4 ohne 3=====
-====Titel 3====
-=====Titel 4=====
-=====[label]Titel 4 mit label=====
-
-text text.
-Mehr text im gleichen Absatz.
-
-text in neuem Absatz
-
-
-==Listen==
-===Normale Punkt-Liste===
-*		liste	*
-*		liste	*
-**	liste	**
-**	liste	**
-***	liste	***
-****	liste	****
-***	liste	***
-*		liste	*
-
-===Nummerierte Liste===
-#		liste 1
-#		liste 2
-##	liste 2-1
-#		liste 3
-
-===Gemischte Liste===
-#		Liste num
-#*	liste	num-*
-##	liste	num-num
-
-===Punkte- und Nummerierte Liste nacheinander===
-*list	*
-#list 1
-
-===Wilde Mischung Punkte- und Nummerierte Liste nacheinander===
-*list	(*)
-**list	(**)
-#*list (\#*) Hier Wechsel auf erster Ebene
-
-===Definitionsliste ===
-;Definitionsliste
-:Liste von Definitionen
-:Liste von Definitionen
-;Begriff
-:Definition des Begriffs
-
-===Mehrzeilige Listen===
-*	vorher
-*	text
-	mehr text zum item
-*	nachher und vorher
-*	text
-	mehr text zum item
-	
-	neuer Absatz im Item funktioniert auch.
-*	nachher
-
-===Einr�ckungen===
-Nicht realisiert, macht implizit Definitionsliste
-: Text	macht implizit Definitionsliste
-::  Noch tiefer
-
-===Fu�noten===
-Einf�gen mit {{footnote|Fu�notentext}}
-	{{footnote|Fu�notentext}}
-
-Ausgegeben werden die Fu�noten mit 
-	{{footnotes}}
-	{{footnotes|groupid}}
-
-Die groupid-Variante erm�glicht verschiedene Fu�notenk�rper.
-(Nur bei HTML-Ausgabe, die Fu�notendefinition erlaubt noch keine Gruppen)
-
-Und jetzt die Fu�noten:
-{{footnotes}}
-#~ Im verarbeitenden Ruby-Programm k�nnen die Fu�noten extra eingef�gt werden.
-	#~ doc.body << wiki.footnotes	#include the footnotes
-
-
-===Allgemeine Formatierungen===
-Eine 
-----
-Linie
-
-==Inline-Formatierungen==
-===Textformatierungen=== 
-Inline-Tags ''kursiv'', '''fett''', ''''kursiv und fett''''
-
-''kursiv'', 
-'''fett''', 
-''''kursiv und fett''''
-
-=== Verbatim ===
-Text vor Verbatim
- pretext
- pretext sss
-Jetzt kein Verbatim mehr
-
-==Bilder==
-Details siehe http://de.wikipedia.org/wiki/Hilfe:Bilder
-
-Bilder lassen sich mit [ [Bild:Dateiname|Beschreibung]] in Artikel einf�gen. 
-Das Bild wird dann in Originalgr��e links im Artikel angezeigt. 
-
-Parameter sind optional mit [ [Bild:Dateiname|parameter|Beschreibung]] anzugeben.
-Es sind beliebig viele, mit | getrennte Parameter m�glich.
-
-Unterst�tzt sind:
-*left, right:	Ausgabe als Float
-*123px:	width wird gesetzt
-*thumb:	noch keine Auswertung
-#~ Mit der Option �framed�, z. B. [[Bild:Dateiname|framed|Beschreibung]] wird das Bild mit einem Rahmen umgeben.
-*par==val:	Der CSS-Parameter ''par'' wird mit dem Wert ''val'' versorgt. (Kein Wiki-Standard, sondern eine Spezialit�t von wiki2docgenerator)
-
-Besonderheiten:
-*Die Beschreibung wird in einen ''alt''-Tag verwendet.
-
-==Tabellen==
-Die Syntax:
-*{|	beginnt eine Tabelle. Hier k�nnen zus�tzliche Formatierungseigenschaften kommen.
-**Zumindest columns==?? sollte gesetzt sein
-*!		beginnt eine neue Zelle einer Titelzeile
-*|		beginnt eine neue Zelle
-*||	trennt zwei Zellen	(nicht unterst�tzt)
-*|format|	z.B. rowspan...
-*|format||	Zwei || beenden die Parameter der Zelle.
-	Dann sinnvoll, wenn im Text selbst ein | vorkommt
-	(z.B. ein Macro verwendet wird)
-
-*|-	trennt zwei Zeilen der Tabelle
-**hline:	Zus�tzlicher Trennstrich �ber der Zeile
-**toprule, midrule, bottomrule:	Zus�tzlicher Trennstrich �ber der Zeile (erfordert booktabs.sty)
-*|}	beendet eine Tabelle
-
-Beispiel 1:
-{|columns=2|columndescription=cc
-|Zelle 1
-|Zelle 2
-|-
-|Zelle 3
-|Zelle 4
-|-
-|Zelle 5
-|Zelle 6
-|}
-
-Beispiel 2:
-{| border=1|columns=6|columndescription=cccccc
-|Zelle 1
-|colspan=5|text-align=center| Zelle 2 �ber f�nf Spalten
-|-
-|Zelle 3
-|Zelle 4
-|Zelle 5
-|Zelle 6
-|Zelle 7
-|Zelle 8
-|}
-
-
-#~ Beispiel 3 mit Titelzeile:
-#~ {| border=1
-#~ !A
-#~ !B
-#~ !C
-#~ |-
-#~ |Zelle 1
-#~ | colspan="2" align="center" | Zelle 2
-#~ |-
-#~ |Zelle 3
-#~ |Zelle 4
-#~ |Zelle 5
-#~ |}
-
-----
-
-==Makros==
-Makros sind eingeleitet mit {{.
-nach dem Makronamen sind Parameter mit | getrennt.
-
-===Link ins ODP===
-*{{dmoz|World/Deutsch}}
-*{{dmoz|World/Deutsch|Deutschsprachige Inhalte}}
-
-===Neue Zeile===
-	{{newline|clear}}
-vorher
-{{newline|clear}}
-nachher
-
-Das Makro newline erfordert den Parameter ''clear''.
-Kann insbesonders genutzt werden um nach floatenden Bildern 
-die Folgezeile unter den float zu setzen.
-
-==Auspr�nge==
-Mit
-	>>>key{}
-	...
-	<<<
-wird eine externe Aufbereitung gerufen.
-key wird von WikiCollector genutzt um den Aufbereiter (Klasse) zu rufen.
-
-html ist bereits definiert und erlaubt die Verwednung von Original-Htlm
-
-Beispiel:
->>>html{}
-<strong>Fett</strong>
-<<<
-Ende Beispiel