Hallo Community,

Wie sich vielleicht noch mancher erinnert, arbeite ich mit dem ein oder anderen hier an einem etwas umfangreicheren Ruby-Projekt, dem OpenRubyRMK (siehe meine Signatur). Nun stehe ich vor dem Problem, für die Dokumentation ein relativ komplexes Tabellenlayout umsetzen zu müssen, und wie wir alle wissen, sind sich RDoc und Tabellen spinnefeind. Es muss also ein brauchbares Tool her, um Tabellen relativ einfach zu bearbeiten und automatisch (via Rake-Task) daraus HTML zu generieren, Am schönsten wäre es, wenn man auch ein paar Adjustierungen am Stylesheet für die Tabellen machen könnte, um z.B. einige Zellen farblich zu unterlegen.

So, was meint nun komplex? Komplex meint etwa soetwas:
| TEILÜBERSCHRIFT (soll farbigunterlegt sein sein) |
|==================++=================++===============+
| Unterrubrik 1 || Unterrubrik 2 || Unterrubrik 3 |
|------+-----------++-----+-----------++---------------|
| Def1 | Erklärung || abc | Erklärung || Punkt 1 |
|------+-----------++-----+-----------++---------------|
| Def2 | Erklärung || def | Erklärung || Punkt 2 |
|------+-----------++-----+-----------++---------------|
| ... | ... || ... | ... || ... |
|======+===========++=====+===========++===============+
| TEILÜBERSCHRIFT 2 |
|==================++=================++===============+
usw.


Dass es müßig ist, solche Tabellen von Hand in ASCII-Art zu erstellen, dürfte einsichtig sein. Die Textmenge in den einzelnen Zellen ist wird dabei ziemlich unterschiedlich sein, von wenig bis viel, und unter Umständen kommt noch die ein oder andere Spalte hinzu.

Welches Tool empfiehlt ihr mir, um die Tabellen zu erstellen (nur nochmal, um's klar zu habe: Es gibt keinen "Usrprungstext", den ich konvertieren möchte, ich schreibe selbst die Dokumentation. Und der Übersicht wegen brauche ich eben diese Tabellen)? Wäre natürlich klasse, wenn's in Ruby geschrieben und als Gem verfügbar wäre (dann könnte man es leicht von der Rakefile aus aufrufen), aber das ist letztenendes kein Muss. Wichtiger wäre mir farbliche Unterlegung bestimmter Zellen.

Valete,
Quintus

_________________
Habe den Mut, dich deines eigenen Verstandes zu bedienen! — Immanuel Kant

Mein Blog | Auf Twitter: @qquintilianus | PGP/GPG-Schlüssel: BF3A 614B D62B A4A0 C292 141C B875 5CB1 C592 A85A

Helft beim OpenRubyRMK, einem freien Programm zum erstellen von RPGs! (→ GitHub-Projekt)

hm bist du sicher daß die tabellen form die übersichtlichste darstellung für die information ist? dein beispiel kommt mir recht unübersichtlich vor. das kann aber auch am fehlenden kontext liegen...

gruss,
tom.

Es ist die übersichtlichste, die mir einfiel. Bislang stehen sämtliche Infos skizzenhaft zeilenweise untereinander in einer RDoc-Datei, das ist noch viel schlimmer. Es geht um die Dokumentation von Kommandos, die man an einen Server sendet, d.h. deren Namen, Zweck, Parameter und die möglichen Antworten des Servers darauf, und deren einzelne Attribute. Dazu noch mögliche Nebeneffekte wie das automatische Versenden von Infos an andere Clients des Servers.

Mir fiel schlicht keine übersichtlichere Variante als farbige Tabellen ein. Für Gegenvorschläge bin ich aber durchaus offen.

Vale,
Quintus

_________________
Habe den Mut, dich deines eigenen Verstandes zu bedienen! — Immanuel Kant

Mein Blog | Auf Twitter: @qquintilianus | PGP/GPG-Schlüssel: BF3A 614B D62B A4A0 C292 141C B875 5CB1 C592 A85A

Helft beim OpenRubyRMK, einem freien Programm zum erstellen von RPGs! (→ GitHub-Projekt)

Bearbeiten trifft es jetzt nicht gerade, aber zum generieren könntest du docgenerator nehmen.

Ein Beispiel auf die schnelle Zusammengebastelt:
#encoding: utf-8
require 'rubygems'
require 'docgenerator'
require 'yaml'

doc = Docgenerator::Document.new(
:title => 'Testdocument with tabulars'
)
data = YAML.load(<-
- TEILÜBERSCHRIFT (soll farbigunterlegt sein sein)
-
- Unterrubrik 1
- Unterrubrik 2
- Unterrubrik 3
-
- Def1
- Erklärung
- abc
- Erklärung
- Punkt 1
-
- Def2
- Erklärung
- abc
- Erklärung
- Punkt 2
xx
)

doc.body << element(:h1, {}, 'Tabulars').cr
doc.body << tab = element(:tabular, {
:columns => 6, #for HTML
} ).CR

data.each{|d|
case d.size
when 1
tab << row = element( :row, class: 'head').cr
row << element(:multicolumn, {
:columns => 5,
}, d )
when 3
tab << row = element( :row, class: 'subhead').cr
d.each{|dx|
row << element(:multicolumn, {
:columns => 2,
}, dx )
}
when 5
tab << row = element( :row).cr
d.each{|dx|
row << element(:column, {
}, dx )
}
else
p d.size
p d
end
}

#Formatdefinitionen
doc.head << <
xx

doc.save( __FILE__.sub(/\.rb/, ".html"))

Das Ergebnis anbei.

Die Daten für die Tabelle sind jetzt etwas dämlich aufgebaut (Anzahl Elemente bestimmt was es ist). Aber dazu müsste man deine Rohdaten besser kennen, aus denen die Doku erzeugt werden soll.

_________________
http://ruby.lickert.net/
http://gems.rubypla.net/

Screenshots!!!

Edit: Ich lasse ruby scripts HTML für mich generieren.

Verwende dann z.Bsp:


table 'inhalt','hier auch'
table2 'inhalt','hier auch' # mit 2 rows
table3 'inhalt','hier auch' # mit 3 rows

und so weiter...

Langfristig möchte ich das ganze in Form von Objekte haben.

table.rows = 5
table.padding 8

Und so weiter.

Das hilft dir jetzt wenig bei deinem Problem, sorry, aber ich komm mit
Rdoc nicht wirklich klar. Ich bin nicht besonders von Ruby Dokumentation
an sich begeistert... die Qualität ist meiner Meinung nach viel zu
niedrig.

_________________
Retired. Macht es gut!