docgenerator 1.0.4 → 1.1.1

data/self_docgenerator.rb

@@ -109,7 +109,7 @@ class DocElement
     )
     doc.body << nav
     doc.body << descr
-    at_exit{ doc.save("#{TARGETDIR}/#{@key}.html", true) }
+    at_exit{ doc.save("#{TARGETDIR}/#{@key}.html") }
     return "#{@key}.html"
   end
 end
@@ -124,7 +124,7 @@ doc = Document.new(
   )
 #~ doc.body << element(:tableofcontents).cr
 wiki = Wikitext.new(:content => <<wiki
-==Command-Overview for docgenerator.rb, version #{Gem.loaded_specs['docgenerator'].version}==
+==Element-Overview for docgenerator.rb, version #{Gem.loaded_specs['docgenerator'].version}==
 This overview is generated by #{__FILE__}.
 
 .
@@ -133,15 +133,17 @@ wiki
 #Index to all elements
 index = {}
 nav = element(:ul)
+letters = []
 DocElement.each{|o|
   odoc = o.mk_doc( nav )
   o.el_object.ids.each{|id|
     index[id] = element(:href, { :href => "#{odoc}" }, id ) 
+    letters << id.to_s[0,1]
   }
 }
-#Prepare lettere
-'A'.upto('Z'){|letter|  wiki  << "[[##{letter}|#{letter}]] " }
-'a'.upto('z'){|letter|  wiki  << "[[##{letter}|#{letter}]] " }
+#Prepare letters
+'A'.upto('Z'){|letter|  wiki  << "[[##{letter}|#{letter}]] " if letters.include?(letter)}
+'a'.upto('z'){|letter|  wiki  << "[[##{letter}|#{letter}]] " if letters.include?(letter)}
 
 doc.body << wiki
 doc.body << element(:h1,{},"Index")
@@ -158,4 +160,4 @@ index.sort_by{|id, entry| id.to_s }.map{|id, entry|
   nav << element(:li,{:style => CSS.new(:display => 'inline') }, [ entry, ' - '] )
 }
 
-doc.save("#{TARGETDIR}/_command_overview.html", true )
+doc.save("#{TARGETDIR}/_command_overview.html" )

data/unittest/creole1.0test.txt

@@ -0,0 +1,128 @@
+= Top-level heading (1)
+== This a test for creole 0.1 (2)
+=== This is a Subheading (3)
+==== Subsub (4)
+===== Subsubsub (5)
+
+The ending equal signs should not be displayed:
+
+= Top-level heading (1) =
+== This a test for creole 0.1 (2) ==
+=== This is a Subheading (3) ===
+==== Subsub (4) ====
+===== Subsubsub (5) =====
+
+
+You can make things **bold** or //italic// or **//both//** or //**both**//.
+
+Character formatting extends across line breaks: **bold,
+this is still bold. This line deliberately does not end in star-star.
+
+Not bold. Character formatting does not cross paragraph boundaries.
+
+You can use [[internal links]] or [[http://www.wikicreole.org|external links]],
+give the link a [[internal links|different]] name.
+
+Here's another sentence: This wisdom is taken from [[Ward Cunningham's]]
+[[http://www.c2.com/doc/wikisym/WikiSym2006.pdf|Presentation at the Wikisym 06]].
+
+Here's a external link without a description: [[http://www.wikicreole.org]]
+
+Be careful that italic links are rendered properly:  //[[http://my.book.example/|My Book Title]]// 
+
+Free links without braces should be rendered as well, like http://www.wikicreole.org/ and http://www.wikicreole.org/users/~example. 
+
+Creole1.0 specifies that http://bar and ftp://bar should not render italic,
+something like foo://bar should render as italic.
+
+You can use this to draw a line to separate the page:
+----
+
+You can use lists, start it at the first column for now, please...
+
+unnumbered lists are like
+* item a
+* item b
+* **bold item c**
+
+blank space is also permitted before lists like:
+  *   item a
+ * item b
+* item c
+ ** item c.a
+
+or you can number them
+# [[item 1]]
+# item 2
+# // italic item 3 //
+    ## item 3.1
+  ## item 3.2
+
+up to five levels
+* 1
+** 2
+*** 3
+**** 4
+***** 5
+
+* You can have
+multiline list items
+* this is a second multiline
+list item
+
+You can use nowiki syntax if you would like do stuff like this:
+
+{{{
+Guitar Chord C:
+
+||---|---|---|
+||-0-|---|---|
+||---|---|---|
+||---|-0-|---|
+||---|---|-0-|
+||---|---|---|
+}}}
+
+You can also use it inline nowiki {{{ in a sentence }}} like this.
+
+= Escapes =
+Normal Link: http://wikicreole.org/ - now same link, but escaped: ~http://wikicreole.org/ 
+
+Normal asterisks: ~**not bold~**
+
+a tilde alone: ~
+
+a tilde escapes itself: ~~xxx
+
+=== Creole 0.2 ===
+
+This should be a flower with the ALT text "this is a flower" if your wiki supports ALT text on images:
+
+{{Red_Flower.jpg|here is a red flower}}
+
+=== Creole 0.4 ===
+
+Tables are done like this:
+
+|=header col1|=header col2| 
+|col1|col2| 
+|you         |can         | 
+|also        |align\\ it. | 
+
+You can format an address by simply forcing linebreaks:
+
+My contact dates:\\
+Phone: xyz\\
+Fax: +45\\
+Mobile: abc
+
+=== Creole 0.5 ===
+
+|= Header title               |= Another header title     |
+| {{{ //not italic text// }}} | {{{ **not bold text** }}} |
+| //italic text//             | **  bold text **          |
+
+=== Creole 1.0 ===
+
+If interwiki links are setup in your wiki, this links to the WikiCreole page about Creole 1.0 test cases: [[WikiCreole:Creole1.0TestCases]].
+

data/unittest/expected/beamer_01_doc.html

@@ -5,9 +5,9 @@
 <html>
 <head >
 <title>Title</title>
+<meta name = "shorttitle" content = "Short title" />
 <meta name="author" content="Knut Lickert"> 
 <meta name="creation-date" content="2008-05-15"> 
-<meta name = "shorttitle" content = "Short title" />
 </head>
 <body ></body>
 </html>

data/unittest/expected/beamer_02_doc.html

@@ -5,9 +5,9 @@
 <html>
 <head >
 <title>Title</title>
+<meta name = "shorttitle" content = "Short title" />
 <meta name="author" content="Knut Lickert"> 
 <meta name="creation-date" content="2008-05-15"> 
-<meta name = "shorttitle" content = "Short title" />
 </head>
 <body ><h1 >Sectiontitle</h1>
 <h2 >Subectiontitle</h2>

data/unittest/expected/beamer_doc_html_overview_with_detailpic_and_text_doc.html

@@ -0,0 +1,34 @@
+<!--
+<<prefix>>
+-->
+<!doctype html public "-//W3C//DTD HTML 4.01 Transitional//EN">
+<html>
+<head >
+<title>Title</title>
+<meta name = "shorttitle" content = "Short title" />
+<meta name="author" content="Knut Lickert"> 
+<meta name="creation-date" content="2008-05-15"> 
+</head>
+<body >
+<div class = "frame" >
+<p class = "frametitle">Title</p>
+
+<div align = "center" >
+<img src = "test.png" />
+</div>
+<p >remark: You can make notes 
+</p>
+<p class = "note">
+<ul >
+<li >
+This is a note    
+</li>
+<li >
+Notes are wiki-enabled
+</li>
+</ul>
+</p>
+</div>
+<br clear = "all" />
+</body>
+</html>

data/unittest/expected/beamer_doc_html_overview_with_detailpic_doc.html

@@ -0,0 +1,34 @@
+<!--
+<<prefix>>
+-->
+<!doctype html public "-//W3C//DTD HTML 4.01 Transitional//EN">
+<html>
+<head >
+<title>Title</title>
+<meta name = "shorttitle" content = "Short title" />
+<meta name="author" content="Knut Lickert"> 
+<meta name="creation-date" content="2008-05-15"> 
+</head>
+<body >
+<div class = "frame" >
+<p class = "frametitle">Title</p>
+
+<div align = "center" >
+<img src = "test.png" />
+</div>
+<p >remark: You can make notes 
+</p>
+<p class = "note">
+<ul >
+<li >
+This is a note    
+</li>
+<li >
+Notes are wiki-enabled
+</li>
+</ul>
+</p>
+</div>
+<br clear = "all" />
+</body>
+</html>

data/unittest/expected/beamer_doc_key_doc.html

@@ -5,9 +5,9 @@
 <html>
 <head >
 <title>Title</title>
+<meta name = "shorttitle" content = "Short title" />
 <meta name="author" content="Knut Lickert"> 
 <meta name="creation-date" content="2008-05-15"> 
-<meta name = "shorttitle" content = "Short title" />
 </head>
 <body >
 <div id = "key" class = "frame" >

data/unittest/expected/beamer_doc_note_doc.html

@@ -5,9 +5,9 @@
 <html>
 <head >
 <title>Title</title>
+<meta name = "shorttitle" content = "Short title" />
 <meta name="author" content="Knut Lickert"> 
 <meta name="creation-date" content="2008-05-15"> 
-<meta name = "shorttitle" content = "Short title" />
 </head>
 <body >
 <div class = "frame" >

data/unittest/expected/beamer_doc_pic_bottom_doc.html

@@ -5,9 +5,9 @@
 <html>
 <head >
 <title>Picture at bottom</title>
+<meta name = "shorttitle" content = "Short title" />
 <meta name="author" content="Knut Lickert"> 
 <meta name="creation-date" content="2008-05-15"> 
-<meta name = "shorttitle" content = "Short title" />
 </head>
 <body >
 <div class = "frame" >

data/unittest/expected/beamer_doc_pic_doc.html

@@ -5,9 +5,9 @@
 <html>
 <head >
 <title>Presentation with picture</title>
+<meta name = "shorttitle" content = "Short title" />
 <meta name="author" content="Knut Lickert"> 
 <meta name="creation-date" content="2008-05-15"> 
-<meta name = "shorttitle" content = "Short title" />
 </head>
 <body >
 <div class = "frame" >

data/unittest/expected/beamer_doc_pic_left_doc.html

@@ -5,9 +5,9 @@
 <html>
 <head >
 <title>Title</title>
+<meta name = "shorttitle" content = "Short title" />
 <meta name="author" content="Knut Lickert"> 
 <meta name="creation-date" content="2008-05-15"> 
-<meta name = "shorttitle" content = "Short title" />
 </head>
 <body >
 <div class = "frame" >

data/unittest/expected/beamer_doc_pic_right_doc.html

@@ -5,9 +5,9 @@
 <html>
 <head >
 <title>Title</title>
+<meta name = "shorttitle" content = "Short title" />
 <meta name="author" content="Knut Lickert"> 
 <meta name="creation-date" content="2008-05-15"> 
-<meta name = "shorttitle" content = "Short title" />
 </head>
 <body >
 <div class = "frame" >

data/unittest/expected/beamer_doc_pic_top_doc.html

@@ -5,9 +5,9 @@
 <html>
 <head >
 <title>Picture on top</title>
+<meta name = "shorttitle" content = "Short title" />
 <meta name="author" content="Knut Lickert"> 
 <meta name="creation-date" content="2008-05-15"> 
-<meta name = "shorttitle" content = "Short title" />
 </head>
 <body >
 <div class = "frame" >

data/unittest/expected/test_footnote.html

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

data/unittest/expected/test_footnote.latex

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

data/unittest/expected/test_footnote_group.html

@@ -1,8 +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>
+<p >Text zu Abschnitt 1<sup><a href="#g2-1">1</a></sup>Weiterer Text<sup><a href="#footnote-1">1</a></sup></p>
 <h2 >Fu�noten</h2>
-<p ><sup ><a name="foot1">1</a></sup>Noch ne Fu�note<br />
+<p ><sup ><a name="footnote-1">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 ><sup ><a name="g2-1">1</a></sup>Fu� eins (g1)<br />
 </p>

data/unittest/expected/test_footnote_group.latex

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

data/unittest/expected_creole/test_creole.html

@@ -0,0 +1,3 @@
+<h2 >Titel 1</h2>
+<p >Text, mehr Text</p>
+<p >Neuer Absatz</p>

data/unittest/expected_creole/test_creole_characters_all.html

@@ -0,0 +1,10 @@
+<ul >
+<li >&lArr;  </li>
+<li >&rArr;  </li>
+<li >$  </li>
+<li >%  </li>
+<li >&larr;  </li>
+<li >&rarr;  </li>
+<li >&amp;  </li>
+<li >_</li>
+</ul>

data/unittest/expected_creole/test_creole_characters_all.latex

@@ -0,0 +1,20 @@
+
+\begin{itemize}
+
+\item \ensuremath{\Lefttarrow}  
+
+\item \ensuremath{\Rightarrow}  
+
+\item \$  
+
+\item \%  
+
+\item \ensuremath{\leftarrow}  
+
+\item \ensuremath{\rightarrow}  
+
+\item \&  
+
+\item \_
+\end{itemize}
+

data/unittest/expected_creole/test_creole_characters_special.html

@@ -0,0 +1,10 @@
+<p >
+Special Characters:  
+</p>
+<ul >
+<li >$ - Dollar  </li>
+<li >% - Percent  </li>
+<li >&rArr; Rightarrow  </li>
+<li >&rarr; rightarrow  </li>
+<li >_ Underscore  </li>
+</ul>

data/unittest/expected_creole/test_creole_characters_special.latex

@@ -0,0 +1,18 @@
+
+
+Special Characters:  
+
+
+\begin{itemize}
+
+\item $ - Dollar  
+
+\item \% - Percent  
+
+\item \ensuremath{\Rightarrow} Rightarrow  
+
+\item \ensuremath{\rightarrow} rightarrow  
+
+\item \_ Underscore  
+\end{itemize}
+

data/unittest/expected_creole/test_creole_countdown.html

@@ -0,0 +1,3 @@
+<p >
+Countdown: 10-9-8-7-6-5-4-3-2-1  
+</p>

data/unittest/expected_creole/test_creole_countdown.latex

@@ -0,0 +1,4 @@
+
+
+Countdown: 10-9-8-7-6-5-4-3-2-1  
+

data/unittest/expected_creole/test_creole_creole1.0test.html

@@ -0,0 +1,182 @@
+<h1 > Top-level heading (1)</h1>
+<h2 > This a test for creole 0.1 (2)</h2>
+<h3 > This is a Subheading (3)</h3>
+<h4 > Subsub (4)</h4>
+<h5 > Subsubsub (5)</h5>
+<p >
+The ending equal signs should not be displayed:  
+</p>
+<h1 > Top-level heading (1) </h1>
+<h2 > This a test for creole 0.1 (2) </h2>
+<h3 > This is a Subheading (3) </h3>
+<h4 > Subsub (4) </h4>
+<h5 > Subsubsub (5) </h5>
+<p >
+You can make things <strong >bold</strong> or <em >italic</em> or <strong ><em >both</em></strong> or <em ><strong >both</strong></em>.  
+</p>
+<p >
+Character formatting extends across line breaks: <strong >bold,this is still bold. This line deliberately does not end in star-star. </strong>
+</p>
+<p >
+Not bold. Character formatting does not cross paragraph boundaries.  
+</p>
+<p >
+You can use <a href = "internal links" >internal links</a> or <a href = "http://www.wikicreole.org" >external links</a>, give the link a <a href = "internal links" >different</a> name.  
+</p>
+<p >
+Here's another sentence: This wisdom is taken from <a href = "Ward Cunningham's" >Ward Cunningham's</a>  <a href = "http://www.c2.com/doc/wikisym/WikiSym2006.pdf" >Presentation at the Wikisym 06</a>.  
+</p>
+<p >
+Here's a external link without a description: <a href = "http://www.wikicreole.org" >http://www.wikicreole.org</a>  
+</p>
+<p >
+Be careful that italic links are rendered properly: <em ><a href = "http://my.book.example/" >My Book Title</a></em>    
+</p>
+<p >
+Free links without braces should be rendered as well, like <a href = "http://www.wikicreole.org/" >http://www.wikicreole.org/</a> and <a href = "http://www.wikicreole.org/users/~example." >http://www.wikicreole.org/users/~example.</a>   
+</p>
+<p >
+Creole1.0 specifies that <a href = "http://bar" >http://bar</a> and ftp:<em >bar should not render italic,something like foo:</em>bar should render as italic.  
+</p>
+<p >
+You can use this to draw a line to separate the page:  
+</p>
+<hr />
+<p >
+You can use lists, start it at the first column for now, please...  
+</p>
+<p >
+unnumbered lists are like  
+</p>
+<ul >
+<li > item a  </li>
+<li > item b  </li>
+<li >  <strong >bold item c</strong>  </li>
+</ul>
+<p >
+blank space is also permitted before lists like:  
+</p>
+<ul >
+<li > item a  </li>
+<li > item b  </li>
+<li > item c  <ul >
+<li > item c.a  </li>
+</ul>
+</li>
+</ul>
+<p >
+or you can number them  
+</p>
+<ol >
+<li >  <a href = "item 1" >item 1</a>  </li>
+<li > item 2  </li>
+<li >  <em >italic item 3 </em>  <ol >
+<li > item 3.1  </li>
+<li > item 3.2  </li>
+</ol>
+</li>
+</ol>
+<p >
+up to five levels  
+</p>
+<ul >
+<li > 1  <ul >
+<li > 2  <ul >
+<li > 3  <ul >
+<li > 4  <ul >
+<li > 5  </li>
+</ul>
+</li>
+</ul>
+</li>
+</ul>
+</li>
+</ul>
+</li>
+</ul>
+<ul >
+<li > You can have multiline list items  </li>
+<li > this is a second multiline list item  </li>
+</ul>
+<p >
+You can use nowiki syntax if you would like do stuff like this:  
+</p>
+<pre>
+Guitar Chord C:
+
+||---|---|---|
+||-0-|---|---|
+||---|---|---|
+||---|-0-|---|
+||---|---|-0-|
+||---|---|---|
+</pre>
+<p >
+You can also use it inline nowiki <span style = "display: inline;white-space:pre;font-family:monospace"> in a sentence </span> like this.  
+</p>
+<h1 > Escapes </h1>
+<p >
+Normal Link: <a href = "http://wikicreole.org/" >http://wikicreole.org/</a> - now same link, but escaped: ~<a href = "http://wikicreole.org/" >http://wikicreole.org/</a>   
+</p>
+<p >
+Normal asterisks: ~<strong >not bold~</strong>  
+</p>
+<p >
+a tilde alone: ~  
+</p>
+<p >
+a tilde escapes itself: ~~xxx  
+</p>
+<h3 > Creole 0.2 </h3>
+<p >
+This should be a flower with the ALT text "this is a flower" if your wiki
+supports ALT text on images:  
+</p>
+<p >
+<img src = "Red_Flower.jpg" alt = "here is a red flower" />  
+</p>
+<h3 > Creole 0.4 </h3>
+<p >
+Tables are done like this:  
+</p>
+<table >
+<tr ><th >header col1</th>
+<th >header col2</th>
+</tr>
+<tr ><td >col1</td>
+<td >col2</td>
+</tr>
+<tr ><td >you</td>
+<td >can</td>
+</tr>
+<tr ><td >also</td>
+<td >align<br />
+ it.</td>
+</tr>
+</table>
+<p >
+You can format an address by simply forcing linebreaks:  
+</p>
+<p >
+My contact dates:<br />
+ Phone: xyz<br />
+ Fax: +45<br />
+ Mobile: abc  
+</p>
+<h3 > Creole 0.5 </h3>
+<table >
+<tr ><th >Header title</th>
+<th >Another header title</th>
+</tr>
+<tr ><td ><span style = "display: inline;white-space:pre;font-family:monospace"> //not italic text// </span></td>
+<td ><span style = "display: inline;white-space:pre;font-family:monospace"> **not bold text** </span></td>
+</tr>
+<tr ><td ><em >italic text</em></td>
+<td ><strong >bold text </strong></td>
+</tr>
+</table>
+<h3 > Creole 1.0 </h3>
+<p >
+If interwiki links are setup in your wiki, this links to the WikiCreole
+page about Creole 1.0 test cases: <a href = "WikiCreole:Creole1.0TestCases" >WikiCreole:Creole1.0TestCases</a>.  
+</p>