• DocBookFormat

{title: DocBookFormat im Wiki} {author: io} {date: 24. Juni 2003} {abstract: Kurze Erklärung, wie mit einem kleinen Konversions-Tool schicke HTML-Seiten aus unseren haesslichen Wiki-Texten entschlüpfen können ...} {version: 0.2}

Warum

Einheitliches Layout und gute Lesbarkeit der späteren html- oder auch pdf-Version unserer senselab:CryptoSeminarAnleitungen.

= Wie funktioniert es =

zuerst mal per Hand

• du nimmst den Text (wie auch immer man ihn einfacher aus dem Wiki holen kann, als per copy/paste) und bringst ihn in eine Datei
• dann startest du:

parsewiki -f docbook datei >ausgabeDatei

• dat geht ganz fix; doch nun kommt die Umwandlung in html:

openjade -t sgml -d /usr/share/sgml/docbook/stylesheet/dsssl/modular/html/docbook.dsl ausgabeDatei oder openjade -t sgml -d /home/public.senselab/CryptoSeminar/Anleitungen/ldp.dsl#html ausgabeDatei oder docbook2html ausgabeDatei (das ist wohl die netteste Variante)

• und das dauert unglaublich lange (halbe Stunde?) -- warum auch immer

nun per Mausklick

einfach die betreffende Seite im Wiki auswählen und dann DocBook-Konvertierung im Seitenkopf anwählen

Woher weiß ich, wie ich meinen Inhalt formatiere?

Prinzipiell funktioniert das Ganze mit normalem Wiki-Text; die wenigen speziellen Tags findest du in der Doku zu parsewiki. Der dazugehörige Quelltext hilft vielleicht noch mehr.

In Kürze:

• Zeilen, die mit einem Leerzeichen beginnen, werden verbatim also im Programmstil dargestellt

• Kapitel oder Unterkapital werden folgendermassen gestaltet: <nowiki>= Titel des Kapitels =</nowiki>

  • die Leerzeichen sind dabei relevant

  • die Anzahl der =-Zeichen entspricht (wie immer) der Hierarchie-Ebene dieses Elements

• Listen

  • nummeriert: "#" am Zeilenanfang

  • ungeordnet: "*" am Zeilenanfang

  • Beschreibung: mit ";" und ":", also in der Form: ;Begriff: Beschreibung

  • die verschiedenen Listen können (auch gemischt) ineinander verschachtelt werden
• Links
  • die http-Form wird automatisch erkannt - die komplette Adresse erscheint dann im Text

  • falls ein Ersatztext angezeigt werden soll, dann geht das so: <nowiki>TEXT</nowiki>

  • bei lokalen Links sind zwei eckige Klammern nötig

• Bilder werden analog zu Links eingefügt - folgende Endungen werden anschließend als Grafik eingefügt: jpg, jpeg, png, bmp, gif

• Schriften

  • kursiv: von zwei Doppel-Apostrophen umschliessen oder als: <nowiki><em>Text</em></nowiki>

  • fett: drei Apostrophe oder: <nowiki><strong>Text</strong></nowiki>

  • monospaced: zwischen zwei Doppelkommata oder: <nowiki>Text</nowiki>

  • das alles gilt immer nur für eine Zeile, ansonsten: Zeilen mit Backslash verbinden

Zusätzlich kannst du folgende Meta-Informationen hinzufuegen: title, date, version, author und abstract. Sie können nach folgendem Muster in den ersten Zeilen einer Wiki-Seite benutzt werden: <nowiki>{title: Heute erkläre ich die Welt} {version: 2.7}</nowiki>

Wo finde ich ein Beispiel?

Ein Beispiel für eine DocBookFormat-Doku ist senselab:CryptoSeminarDocBookMozilla. Daraus wurde die docbook-Datei erzeugt und natürlich die resultierenden HTML-Dokumente:

• Variante I: falls du openjade gestartet hast Variante II: falls du docbook2html benutzt

Alles klar?

so denn, ihr könnt dann ja mal so langsam beginnen, eure Dokus umzubasteln ...

FAQ für das DocBookFormat

Q: Fußnoten, verdammt!

A: Durch das docbook-Element <footnote>... text ...</footnote> (theoretisch)

Q: Wo hätte ich das mit den Fußnoten selber herausfinden können?

A: hier

Q: Der openjade-Aufruf mit der ldp.dsl funktioniert nicht!

A: Keine Ahnung, alternativ kannst du es aber auch mal mit: docbook2html ausgabeDatei versuchen (alles ungetestet, weil es so unglaublich lange dauert)