docgenerator 0.1.1 → 1.0.2

data/self_docgenerator.rb

@@ -0,0 +1,161 @@
+#
+#This program creates element-description in TARGETDIR
+#
+require 'docgenerator'
+require 'wiki2doc/wiki2docgenerator'
+puts "==> Version #{Gem.loaded_specs['docgenerator'].version}"
+TARGETDIR = 'self_docgenerator'
+
+
+class DocElement
+  @@all = []
+  def initialize(objekt)
+    @@all << self
+    @el_class = objekt
+    @el_object = objekt.new()
+    @el_object.ids.each{|key|
+      @key = key if "#{key}" =~ /\A[A-Za-z]+\Z/
+      break if @key
+    }
+    @el_object << 'content' if @el_object.content?
+    puts  "No key: #{objekt.inspect}" if ! @key
+  end
+  attr_reader :key
+  attr_reader :el_object
+  def self.each()
+      @@all.uniq!
+      @@all.each{|o| yield o }
+  end
+    
+  def mk_doc( nav )
+    descr = []
+    descr << element(:label,{ :name => @key }).cr
+    descr << element(:h2,{}, @el_object.ids.join(', ')).cr
+    #~ descr << @el_class.inspect
+    descr << element(:h3, {}, 'Ids' ).cr
+    descr << ul = element(:ul).cr
+    @el_object.ids.map{|id| ul << element(:li, {}, id) }
+    
+    #
+    #Attributes
+    #
+    descr << element(:h3, {}, "Attributes").cr
+    attr_code = []  #attr-list for usage
+    if Element.get_attribute_list( @el_class ).empty?
+      descr << element(:p, {}, "No attributes available").cr
+    else
+      descr << attr_tab = element(:tabular, { :columns => 10, :border => '1px' } ).cr
+      #title
+      attr_tab << row = element(:row).cr
+        row << element(:col, {}, 'Attribute' ).cr
+        [ :required, :content, :unique, 
+                          :html, :latex,  :text, :wiki,  :texkeyval 
+                    ].map{ |akey| 
+          row << element(:col, {:align => 'center'}, akey ).cr
+        }
+        row << element(:col, {:align => 'center'}, 'Allowed values' ).cr
+      #description of attributes
+      @el_object.attr.sort_by{|key, attr|attr.sortkey}.each{|key, attr|
+        attr_tab << row = element(:row).cr
+        row << element(:col,{}, key)
+        [ :required, :content, :unique, 
+          :html, :latex,  :text, :wiki,  :texkeyval 
+                    ].map{ |akey| 
+            if @el_object[key].send("#{akey}?".to_sym )
+              row << element(:col,{:align => 'center'}, element(:radic ))
+            else
+              row << element(:col,{:align => 'center'},element(:empty ))
+            end
+        }
+        row << element(:col,{},
+            @el_object[key].allowed_values ? @el_object[key].allowed_values.join(", ") : nil
+        )
+        
+        attr_code << "\t\t#{key} => "
+        attr_code.last << @el_object[key].allowed_values.join("|") if @el_object[key].allowed_values
+      } #Attributelist
+    end #Attributes
+    
+    descr << element(:h3, {}, "Output").cr
+    descr << element(:p, {}, "As example content, the text 'content' was added.").cr if @el_object.content?
+    descr << tab = element(:tabular, { :columns => 3, :border => '1px' } ).cr
+    tab << row = element(:row).cr
+        row << element(:col,{}, 'HTML')
+        row << element(:col,{}, element(:pre, {}, @el_object.to_html))
+        row << element(:col,{}, element(:pre, {}, @el_object.htmltag))
+    tab << row = element(:row).cr
+        row << element(:col,{}, 'LaTeX')
+        row << element(:col,{}, element(:pre, {}, @el_object.to_latex))
+    tab << row = element(:row).cr
+        row << element(:col,{}, 'Wiki')
+        row << element(:col,{}, element(:pre, {}, @el_object.to_wiki))
+    tab << row = element(:row).cr
+        row << element(:col,{}, 'Text')
+        row << element(:col,{}, element(:pre, {}, @el_object.to_text))
+
+    descr << element(:h2, {}, "Usage:").cr
+    code = "element( #{@key.inspect}"
+    if attr_code.empty?
+      code << ", {}, " if @el_object.content?
+    else
+      code << ", {\n#{attr_code.join("\n")}\n\t}"
+    end
+    code << ", 'content'" if @el_object.content?
+    code << ' )'
+    descr << element(:pre, {}, code ).cr
+
+    doc = Document.new(
+      :title => "selfdocgenerator: #{@el_object.ids.join(', ')}"
+    )
+    doc.body << nav
+    doc.body << descr
+    at_exit{ doc.save("#{TARGETDIR}/#{@key}.html", true) }
+    return "#{@key}.html"
+  end
+end
+
+ObjectSpace.garbage_collect
+ObjectSpace.each_object(Class){|o|
+  DocElement.new(o) if o.ancestors.include?(Element)
+}
+
+doc = Document.new(
+  :title => 'Element Overview for docgenerator.rb'
+  )
+#~ doc.body << element(:tableofcontents).cr
+wiki = Wikitext.new(:content => <<wiki
+==Command-Overview for docgenerator.rb, version #{Gem.loaded_specs['docgenerator'].version}==
+This overview is generated by #{__FILE__}.
+
+.
+wiki
+)
+#Index to all elements
+index = {}
+nav = element(:ul)
+DocElement.each{|o|
+  odoc = o.mk_doc( nav )
+  o.el_object.ids.each{|id|
+    index[id] = element(:href, { :href => "#{odoc}" }, id ) 
+  }
+}
+#Prepare lettere
+'A'.upto('Z'){|letter|  wiki  << "[[##{letter}|#{letter}]] " }
+'a'.upto('z'){|letter|  wiki  << "[[##{letter}|#{letter}]] " }
+
+doc.body << wiki
+doc.body << element(:h1,{},"Index")
+act_letter  = nil
+doc.body << indexlist = element(:ul).cr
+index.sort_by{|id, entry| id.to_s }.map{|id, entry| 
+  if act_letter != id.to_s[0..0] and id.to_s[0..0] =~ /\w/
+    act_letter = id.to_s[0..0]
+    doc.body <<   element(:label, { :name => "#{act_letter}" })
+    doc.body <<   element(:h2,{},act_letter )    
+    doc.body << indexlist = element(:ul).cr
+  end
+  indexlist << element(:li,{}, entry).cr 
+  nav << element(:li,{:style => CSS.new(:display => 'inline') }, [ entry, ' - '] )
+}
+
+doc.save("#{TARGETDIR}/_command_overview.html", true )

data/unittest/expected/test_beamer_note.html

@@ -0,0 +1 @@
+<span >Notiz</span>

data/unittest/expected/test_beamer_note.latex

@@ -0,0 +1 @@
+\note{Notiz}

data/unittest/expected/test_beamer_note.text

@@ -0,0 +1 @@
+Notiz

data/unittest/expected/test_beamer_note.wiki

@@ -0,0 +1 @@
+Notiz

data/unittest/expected/test_block.html

@@ -0,0 +1 @@
+<div >Block 1<span >Zwischenblock</span>Ende Block 1</div>

data/unittest/expected/test_block.latex

@@ -0,0 +1 @@
+\begingroup Block 1\bgroup Zwischenblock\egroup Ende Block 1\endgroup 

data/unittest/expected/test_block.text

@@ -0,0 +1 @@
+Block 1ZwischenblockEnde Block 1

data/unittest/expected/test_block.wiki

@@ -0,0 +1,2 @@
+Block 1Zwischenblock
+Ende Block 1

data/unittest/expected/test_css.css

@@ -0,0 +1 @@
+background-color: blue;color: red

data/unittest/expected/test_css2.css

@@ -0,0 +1 @@
+background-color: blue;color: red;float: right

data/unittest/expected/test_description.html

@@ -0,0 +1 @@
+<dl ><dt >Top 1</dt><dd >Listpunkt 1</dd></dl>

data/unittest/expected/test_description.latex

@@ -0,0 +1,3 @@
+
+\begin{description}
+\item[Top 1]  Listpunkt 1 \end{description}

data/unittest/expected/test_description.text

@@ -0,0 +1,3 @@
+
+Top 1: 
+	Listpunkt 1

data/unittest/expected/test_description.wiki

@@ -0,0 +1,3 @@
+
+;Top 1
+:Listpunkt 1

data/unittest/expected/test_document_article.latex

@@ -0,0 +1,23 @@
+<<prefix>>
+\documentclass[ngerman]{scrartcl}
+\usepackage{babel}
+\usepackage[ansinew]{inputenc}
+\usepackage{hyperref}
+% ----------------------------------------------------------------
+
+\title{Testdokument}
+\hypersetup{pdftitle={Testdokument}}
+\author{docgenerator.rb}\hypersetup{pdfauthor={docgenerator.rb}}
+\hypersetup{pdfkeywords={Test}}
+\hypersetup{pdfsubject={This is a test for a Document, generated by docgenerator.rb}}
+
+% ----------------------------------------------------------------
+\begin{document}
+\maketitle 
+
+
+This is some content
+
+
+\end{document}
+% ----------------------------------------------------------------

data/unittest/expected/test_document_html.html

@@ -0,0 +1,14 @@
+<!--
+<<prefix>>
+-->
+<!doctype html public "-//W3C//DTD HTML 4.01 Transitional//EN">
+<html>
+<head >
+<title>Testdokument</title>
+<meta name="author" content="docgenerator.rb"> 
+<meta name="keywords" content="Test"> 
+<meta name="description" content="This is a test for a Document, generated by docgenerator.rb"> 
+</head>
+<body ><!-- maketitle -->
+<p >This is some content</p></body>
+</html>

data/unittest/expected/test_document_replacement_article.latex

@@ -0,0 +1,23 @@
+<<prefix>>
+\documentclass[ngerman]{scrartcl}
+\usepackage{babel}
+\usepackage[ansinew]{inputenc}
+\usepackage{hyperref}
+% ----------------------------------------------------------------
+
+\title{Testdokument}
+\hypersetup{pdftitle={Testdokument}}
+\author{docgenerator.rb}\hypersetup{pdfauthor={docgenerator.rb}}
+\hypersetup{pdfkeywords={Test}}
+\hypersetup{pdfsubject={This is a test for a Document, generated by docgenerator.rb}}
+
+% ----------------------------------------------------------------
+\begin{document}
+\maketitle 
+
+
+Etwas Inhalt
+
+
+\end{document}
+% ----------------------------------------------------------------

data/unittest/expected/test_document_replacement_html.html

@@ -0,0 +1,14 @@
+<!--
+<<prefix>>
+-->
+<!doctype html public "-//W3C//DTD HTML 4.01 Transitional//EN">
+<html>
+<head >
+<title>Testdokument</title>
+<meta name="author" content="docgenerator.rb"> 
+<meta name="keywords" content="Test"> 
+<meta name="description" content="This is a test for a Document, generated by docgenerator.rb"> 
+</head>
+<body ><!-- maketitle -->
+<p >Etwas Inhalt</p></body>
+</html>

data/unittest/expected/test_document_replacement_text.text

@@ -0,0 +1,5 @@
+
+
+
+Etwas Inhalt
+

data/unittest/expected/test_document_replacement_wiki.wiki

@@ -0,0 +1,5 @@
+
+
+
+Etwas Inhalt
+

data/unittest/expected/test_document_text.text

@@ -0,0 +1,5 @@
+
+
+
+This is some content
+

data/unittest/expected/test_document_wiki.wiki

@@ -0,0 +1,5 @@
+
+
+
+This is some content
+

data/unittest/expected/test_enumerate.html

@@ -0,0 +1 @@
+<ol ><li >Listpunkt 1</li></ol>

data/unittest/expected/test_enumerate.latex

@@ -0,0 +1,3 @@
+
+\begin{enumerate}
+\item Listpunkt 1\end{enumerate}

data/unittest/expected/test_enumerate.text

@@ -0,0 +1 @@
+- Listpunkt 1

data/unittest/expected/test_enumerate.wiki

@@ -0,0 +1,2 @@
+
+# Listpunkt 1

data/unittest/expected/test_footnote.html

@@ -0,0 +1,5 @@
+<h1 >Abschnitt 1</h1>
+<p >Text zu Abschnitt 1<sup><a href="#foot1">1</a></sup>Weiterer Text</p>
+<h2 >Fu�noten</h2>
+<p ><sup ><a name="foot1">1</a></sup>Fu� eins<br />
+</p>

data/unittest/expected/test_footnote.latex

@@ -0,0 +1,11 @@
+\section{Abschnitt 1}
+
+
+Text zu Abschnitt 1\footnote{Fu� eins}Weiterer Text
+
+\subsection{Fu�noten}
+
+
+\textsuperscript{\label{foot1}\hypertarget{foot1}{1}}Fu� eins\newline 
+
+

data/unittest/expected/test_footnote.text

@@ -0,0 +1,13 @@
+
+Abschnitt 1
+    ------------------------------
+
+
+Text zu Abschnitt 1(1)Weiterer Text
+
+Fu�noten
+      ------------------------------
+
+
+^(foot1) 1^Fu� eins
+

data/unittest/expected/test_footnote.wiki

@@ -0,0 +1,11 @@
+
+==Abschnitt 1==
+
+
+Text zu Abschnitt 1(1)Weiterer Text
+
+===Fu�noten===
+
+
+^[[??foot1]]1^Fu� eins{{newline}}
+

data/unittest/expected/test_footnote_group.html

@@ -0,0 +1,8 @@
+<h1 >Abschnitt 1</h1>
+<p >Text zu Abschnitt 1<sup><a href="#footg1-1">1</a></sup>Weiterer Text<sup><a href="#foot1">1</a></sup></p>
+<h2 >Fu�noten</h2>
+<p ><sup ><a name="foot1">1</a></sup>Noch ne Fu�note<br />
+</p>
+<h3 >Fu�noten g1</h3>
+<p ><sup ><a name="footg1-1">1</a></sup>Fu� eins (g1)<br />
+</p>

data/unittest/expected/test_footnote_group.latex

@@ -0,0 +1,17 @@
+\section{Abschnitt 1}
+
+
+Text zu Abschnitt 1\footnote{Fu� eins (g1)}Weiterer Text\footnote{Noch ne Fu�note}
+
+\subsection{Fu�noten}
+
+
+\textsuperscript{\label{foot1}\hypertarget{foot1}{1}}Noch ne Fu�note\newline 
+
+
+\subsubsection{Fu�noten g1}
+
+
+\textsuperscript{\label{footg1-1}\hypertarget{footg1-1}{1}}Fu� eins (g1)\newline 
+
+

data/unittest/expected/test_footnote_group.wiki

@@ -0,0 +1,17 @@
+
+==Abschnitt 1==
+
+
+Text zu Abschnitt 1(1)Weiterer Text(1)
+
+===Fu�noten===
+
+
+^[[??foot1]]1^Noch ne Fu�note{{newline}}
+
+
+====Fu�noten g1====
+
+
+^[[??footg1-1]]1^Fu� eins (g1){{newline}}
+

data/unittest/expected/test_href.html

@@ -0,0 +1,2 @@
+<p >Jetzt ein <a name="ilink">Ziel</a> f�r einen Link</p>
+<p >Und hier der Textlink zum <a href = "#ilink" >Ziel.</a></p>

data/unittest/expected/test_href.latex

@@ -0,0 +1,8 @@
+
+
+Jetzt ein \label{ilink}\hypertarget{ilink}{Ziel} f�r einen Link
+
+
+
+Und hier der Textlink zum \hyperlink{ilink}{Ziel.}
+