Präsentation der Jekyll-Version überarbeiten.

bundestag / gesetze

Bundesgesetze und -verordnungen

http://bundestag.github.io/gesetze/

The Unlicense

1.69k stars 156 forks source link

Präsentation der Jekyll-Version überarbeiten. #21

Open Bengt opened 12 years ago

Bengt commented 12 years ago

Der gh-pages-Branch dieses Repositories enthält schon grundlegende Konfiguration, um die Markdown Repräsentationen in HTML umzuwandeln. Es fehlt aber noch ein zumindest grundlegendes Design in CSS und vielleicht auch etwas die Navigation unterstützendes Javascript.

Siehe auch: Statement vom Projektautor zum Thema.

Bitte beachten: #19 hängt hier von ab.

tobislaw commented 12 years ago

Folgendes wäre mir aufgefallen:

Die §§ Überschriften sollten alle die gleiche Größe haben
Stark untergliederte Paragraphen zb § 11 I Nr. 1a StGB sind regelmäßig bugged; Aber Markdown ist ok
Speziell beim StGB fehlen schon in der Markdown-Version die Fußnoten im Original; sehr großes Problem, weil man so nicht erkennen kann, dass einige Vorschriften unwirksam sind (zB §43a StGB, § 66 StGB)
Im BGB sehen die Footnotes aus der .xml Version im .html nicht gut aus und broken links, zb § 14 BGB
Satzzahlen in der html-Fassung würden die Lesbarkeit deutlich erhöhen (Beispiel: http://www.gesetze-im-internet.de/estdv_1955/BJNR007560955.html)

tobislaw commented 12 years ago

Zum zweiten Punkt von oben: Offenbar liegt es am Linebreak in der Markdown-Version, für die er dann Code-Tags in die HTML Datei reinschreibt. Vielleicht sollte man alle nicht benötigten Markdown-Funktionen standardmäßig abschalten?
Zum dritten Punkt: Leider sind bei Gesetze-Im-Internet viele Fußnoten auch irrelevant, aber jedenfalls alle mit "BVerfGE" sollte man haben, weil sie Gesetzeskraft haben

stefanw commented 12 years ago

Kurz zu den Überschriften: es gibt in HTML und damit auch in Markdown nur Überschriften von h1 - h6. Alles was tiefer geht, geht bei der Konvertierung schief. Ggf. sollten wir es im Markdown trotzdem als tiefergehend auszeichnen, allerdings klappt dann die Markdown->HTML-Übersetzung auf gh-pages nicht mehr und es wird keine richtige Überschrift generiert.

Früher oder später müssen wir wohl unseren eigenen Jekyll-Generator aufsetzen.

tobislaw commented 12 years ago

Sry hatte die §§ Überschriften in der HTML-Version gemeint, die sind eben unterschiedlich groß, weil sie auch im Markdown von h4-h6 gehen. Ich denke man kann einfach im CSS alles ab h4 gleich groß machen. Zwar wären dann im Fließtext auch Kapitel/Untertitel Überschriften gleich groß, aber die sind eher irrelevant; zumindest habe ich noch nie bewusst auf sie geachtet.

nichtich commented 12 years ago

Zur Weiterverarbeitung der Gesetzestexte nach HTML, PDF, ePub, LaTeX etc. empfehle ich pandoc statt jekyll.

stefanw commented 12 years ago

@nichtich: Jekyll ist für HTML static pages auf GitHub geeignet. Das Ziel ist es hier eine Datengrundlage zu bieten, mit der man Gesetze mit Tool X nach Format Y umwandeln kann, wenn man das lustig findet. X kann auch pandoc sein.

Ziel ist:

Möglichst alle nötigen Formatierungen abzubilden, z.B. auch Fußnoten, document anchors
Möglichst kompatibel mit existierender Markdown Syntax bzw. existierenden Markdown-Erweiterungen sein

Bengt commented 12 years ago

@stefanw Es gibt aber eben schon einige Markdown-Dialekte und ich denke, es sollte mal mal geklärt werden, welcher hier benutzt werden soll.

rriemann commented 12 years ago

Parser wie Kramdown haben unterstützung für Klassen. Das sieht dann in etwa so aus:

### title
{: .order-9 }

Damit könnte man die weitere Formatierung in CSS machen. Mehr als 6 Level gibt es eben in HTML nicht. Mehr dazu: http://kramdown.rubyforge.org/quickref.html#block-attributes