Rumex verwendet pandocs markdown weil man damit sehr einfach und schnell Text erstellen und in verschiedenen Formate wandeln kann. Für die Erstellung von Denkschriften1 wurde zusätzlich eine, ich nenne sie statik Funktion eingebaut. Mit dieser Funktion ist es möglich innerhalb eines Unterverzeichnisses verschiedenen Ausgabe Formate zu erstellen. Zur Zeit werden, von Rumex, folgenden Formate unterstützt:
Erstellt werden die einzelnen Formate über Funktionstasten die innerhalb (g)vim2 zur Verfügung stehen.Eine Besonderheit ist dass die .htm Datei auch ohne die zusätzlichen Dateien wieBilder oder die CSS Datei funktionieren. Alle Daten werden in die 3.htm Datei eingebunden.
Auch wurde die Literaturfunktion von Pandoc eingebaut sodass Verweise auf anderen Quellen in den Denkschriften verwendet werden können.
Wer sich Rumex nicht installieren möchte aber dennoch eine einfache Möglichkeit sucht HTML Seiten zu erstellen, kann sich einmal cirsium anschauen. Cirsium ist eine Auskopplung aus Rumex, unterteilt aber die Quelltextdatei in verschiedene Abschnitte. Am besten einfach mal auf github.com anschauen.
Ab der Rumex Version 0.8.2 sind die Funktionstasten in Rumex enthalten. Folgende F-Tasten wurden belegt.
Erstellt die .htm Datei ohne Inhaltsverzeichnis.
Erstellt die .htm Datei mit Inhaltsverzeichnis bis zur Ebene 3.
Erstellt die .htm Datei mit kompletten Inhaltsverzeichnis bzw. bis Ebene 5 da LaTeX auch nicht mehr Ebenen unterstützt und die beiden Ausgabe Format annähernd identisch sein sollten.
Öffnet die .htm Datei.
Erstellt die .pdf Datei ohne Inhaltsverzeichnis.
Erstellt die .pdf Datei mit Inhaltsverzeichnis bis zur Ebene 3.
Erstellt die .pdf Datei mit kompletten Inhaltsverzeichnis. Hier ist anzumerken dass LaTeX nur Inhaltsverzeichnisse bis zur Ebene 5 unterstützt. Das HTML Format wurde entsprechend angepasst, siehe oben.
Öffnet die .pdf Datei. Zur Zeit wird nur zathura unterstützt.
Erstellt die restlichen Formate, .epub, .odt und .mobi. Voraussetzung für das .mobi Format ist calibre.
Öffnet die Literatur Verwaltung rumex.bib. Voraussetzung, jabref ist installiert.
Die erzeugte HTML Datei besitzt Standardmäßig keine Formatierung bzw. verwendet die Standard Darstellung des Browsers.
Kopf- und Fusszeile werden dadurch nicht, vom restlichen Text, unterschieden. Auch das Inhaltsverzeichnis ist im ersten Moment als solches nicht gleich zu erkennen. Dieses kann mit ein wenig CSS geändert werden. Diese CSS Datei ist ab Rumex Version 0.8.2 enthalten muss aber unter Umständen noch eingerichtet werden.
cd .rx
ln -s ../.rumex/default/statik.css statik.cssBeim Lesen des Artikels "PDF-Dokumente schreiben mit Pandoc und Markdown" (Stender, 2013) ist mir die Idee gekommen die Rumex statik Funktion mit einem Literaturverzeichnis, die ja auch in pandoc zur Verfügung steht, zu versehen.
Für die Verwendung der Literaturfunktion muss pandoc um das Zusatzprogramm pandoc-citeproc erweitert werden. Wer Pandoc über die Paketverwaltung installiert hat braucht hier nichts zu machen. Wer Pandoc manuell, so wie ich, installiert hat muss dieses Programm nachinstallieren.
Dazu erweitert man die Installationszeile um das neue Programm
cabal update
cabal install pandoc pandoc-citeprocZu guter Letzt erstellt man noch die symbolischen Links der beiden Programme.
sudo ln -s /home/USER/.cabal/bin/pandoc /usr/local/bin/.
sudo ln -s /home/USER/.cabal/bin/pandoc-citeproc /usr/local/bin/.Wer Rumex schon im Einsatz hat muss für die Erweiterung ein wenig Hand anlegen. Zu erste holt man sich die neue Version4 von rumex.
Dann braucht man noch drei zusätzliche Dateien im Verzeichnis .rx.
rumex.bibrumex.cslstatik.cssWobei der Literatur Vorlage Stiel und die CSS Datei nur verlinkt wird. In der rumex.bib werden dann die Literatur Verweise verwaltet.
cd .rx
touch rumex.bib
ln -s ../.rumex/default/din-1505-2.csl rumex.csl
ln -s ../.rumex/default/statik.css statik.cssAls Literatur Stil kommt din-1505-2.csl zum Einsatz. Andere Stile findet man im git Repository https://github.com/citation-style-language/styles.git. Als Name für die Stil Vorlage wurde rumex.csl gewählt damit mit eine Änderung des Stils einfach über den Symlink gemacht werden kann.
Für die Verwaltung der Literatur Datenbank verwende ich Jabref.
sudo apt-get install jabrefDer Aufruf des Programms wurde auch auf einen F Taste gelegt. Wer eine anderes Programm verwenden will muss diesen entsprechend anpassen.
Auf Wikipedia (2013) findet man eine schöne Beschreibung über die Literatur Verwaltung mit BibTex.
Die BibTex Einträge muss man sich unter Umständen nicht einmal selber erstellen. Da verschiedene Seiten entsprechende Dienste anbieten. Gelungen finde ich die Seite von http://www.literatur-generator.de/ aber auch auf http://lead.to/amazon/en/?op=bt findet man BibTeX Einträge. Zwar muss man diese unter Umständen noch ein wenig überarbeiten aber das Grund Gerüst wird einem sozusagen frei Haus geliefert.
Wer einen Wikipedia Artikel zitieren dem wird unter "Werkzeuge -> Seite zitieren" weiter geholfen.
Für das zitieren von Internetseiten verwende ich folgende Formate, siehe dazu Abschnitt Literaturverzeichnis.
@ELECTRONIC{ wiki:bibtex,
author = "Wikipedia",
title = "BibTeX --- Wikipedia{,} Die freie Enzyklopädie",
year = "2013",
url = "http://de.wikipedia.org/w/index.php?title=BibTeX&oldid=124228120",
note = "[Online; Stand 18. Dezember 2013]"
}...oderAchtung: Das Formate@WWWwird von jabref nicht unterstützt und gegen ein anders ausgetauscht. Bei dem Einsatz von Jabref am besten@ELECTRONICverwenden.
@WWW{ wiki:bibtex,
author = "Wikipedia",
title = "BibTeX --- Wikipedia{,} Die freie Enzyklopädie",
year = "2013",
url = "http://de.wikipedia.org/w/index.php?title=BibTeX&oldid=124228120",
note = "[Online; Stand 18. Dezember 2013]"
}Innerhalb von Rumex erstellt man in einem separatem Unterverzeichnis die entsprechende markdown Datei und dann kann es auch schon los gehen.
Außerhalb von Rumex kann man diese Funktion natürlich auch verwenden. Mit Außerhalb meine ich Denkschriften die nicht veröffentlicht werden. Dazu gibt es zwei Möglichkeiten.
Die Datei bzw. das Verzeichnis in .gitignore hinterlegen. Somit wird diese nicht verwaltet und auch nicht, bei einem make online, hoch geladen.
Eine zweite lokale Rumex Installation die nur für Denkschriften verwendet wird.
...und dann wäre da noch Cirsium, eine Auskopplung aus Rumex, mit der man einfache html und pdf Seiten erstellen kann. Die Literaturverzeichnisoption ist auch enthalten. Die Formate odt, epub und mobi sind jedoch nicht eingebaut.
Die Überschrift für das Literaturverzeichnis muss immer am Ende des Artikels gesetzt werden.
Beispiel
# LiteraturverzeichnisBei dem Einbinden der Bilder muss man beachten dass die Erstellung der statik Datei vom Verzeichnis .rx ausgeht.
Will man also ein Bild, dass im Ordner der Statik Datei liegt einbinden so muss auch auf das Bild aus der Sicht des .rx Verzeichnisses eingebunden werden.
Beispiel:
Das Bild liegt im Ordner statik somit müsste der Markdown Befehl so aussehen.
In Rumex kann man diese Funktion natürlich auch verwenden. Am besten erstellt man sich dazu ein eigenes Unterverzeichnis und dort die Datei index.md mit den Texten.
.rx VerzeichnisEs wird sicher passieren dass man die Funktionstasten der Statik Seiten auch bei der Bearbeitung der eigentlichen Rumex Dateien drückt. Durch entsprechende Einträge in der .gitignore Datei werden solche Dateien von einem Upload ausgeschlossen. Mit den Aufruf von make statikclean können die erstellten statik Dateien Schlussendliche aus dem .rx Verzeichnis entfernt werden. Dieser Befehl wird auch bei make clean ausgeführt.
Das PDF Programm zathura hat die Eigenschaft dass wenn sich die Datei ändert diese automatisch nachgeladen wird. Eine schöne Funktion wenn man seinen Text, an dem man gerade arbeitet, immer wieder einmal im Ausgabe Format betrachten will. Einfach die Taste F6 drücken, die Datei wird auch gleich gespeichert, und mit ALT-TAB das Programm Fenster wechseln.
Bei Format HTML geht das natürlich auch. Nur muss hier eine Erweiterung installiert werden. Für die Browser Chromium und Firefox habe ich mit Auto Refresh PlusChromium bzw. Tab Auto ReloadFireFox gute Erfahrungen gemacht.
Die PDF Datei dieser Beschreibung kann man sich hier ansehen. Die Markdown Quelldatei kann man sich hier holen.
Stender, Daniel: PDF-Dokumente schreiben mit Pandoc und Markdown. URL http://www.pro-linux.de/artikel/2/1635/3,bibliographie.html
Wikipedia: BibTeX — Wikipedia, Die freie Enzyklopädie. URL http://de.wikipedia.org/w/index.php?title=BibTeX&oldid=124228120. — [Online; Stand 18. Dezember 2013]
Im Neudeutschen würde man die Denkschrift als Memorandum bezeichnen.↩
Die Funktionstasten sind im gvim Rumex Menü nicht eingebaut. Man sollte sie sich also merken :-).↩
Diese Eigenschaft wurde wieder entfernt da eine Datei mit sehr vielen Bildern oder gar Videos, die alle in die HTML Datei eingebunden werden, sehr groß wird. Dieses erhöht die Ladezeit der HTM Datei. Bei der Verwaltung durch git wirkt sich diese Eigenschaft auch ungünstig aus.↩
Die Literatur Erweiterung ist ab der Rumex Version 0.8.2 enthalten.↩