artikel-vorlage/README.md

64 lines
2.2 KiB
Markdown
Raw Normal View History

2014-09-12 14:36:30 +02:00
Dieses git-Repository enthält Vorlagen für Artikel der Fachzeitschrift
[Informationspraxis](http://informationspraxis.de/) sowie Skripte zur
Konvertierung der Artikel nach HTML und PDF.
2014-09-21 20:42:10 +02:00
# Verwendung der Vorlage zum Verfassen eigener Artikeln
2014-09-12 15:13:21 +02:00
2014-09-21 20:42:10 +02:00
Die Vorlage besteht aus zwei Dateien:
2014-09-12 15:13:21 +02:00
2014-09-21 20:42:10 +02:00
* Die Datei **vorlage.yml** für die Metadaten des Artikels
(Titel, Autor, Abstract...)
* Eine der folgenden Dateien für den Artikeltext:
* **vorlage.md** zum Verfassen in Markdown-Syntax
* **vorlage.docx** zum Verfassen mit Word
* **vorlage.odt** zum Verfassen mit Libre/Open Offixe
2014-09-12 15:13:21 +02:00
2014-09-21 20:42:10 +02:00
Die Verwendung anderer Dokumentformate (LaTeX, Google Docs etc.) ist ebenfalls
möglich, allerdings werden diese zunächst nach Markdown umgewandelt, wobei es
zu Fehlern kommen kann.
2014-09-12 15:13:21 +02:00
2014-09-21 20:42:10 +02:00
Bitte benennen Sie beide Dateien einheitlich um und behalten die Dateiendung
bei, beispielsweise
2014-09-12 15:13:21 +02:00
2014-09-21 20:42:10 +02:00
* vorlage.yml $\Rightarrow$ meinartikel.yml
* vorlage.docx $\Rightarrow$ meinartikel.docx
2014-09-12 15:13:21 +02:00
2014-09-21 20:42:10 +02:00
Bei Bedarf können Sie Ihre Artikel wie im Folgenden beschrieben nach HTML
und/oder PDF konvertieren, um das fertige Layout des Artikels zu überprüfen.
2014-09-15 12:33:35 +02:00
2014-09-21 20:42:10 +02:00
# Konvertierung nach HTML und PDF
2014-09-12 15:13:21 +02:00
2014-09-21 20:42:10 +02:00
Die Konvertierung benötigt das Program [Pandoc](johnmacfarlane.net/pandoc/)
sowie zur Erzeugung von PDF eine LaTeX-Umgebung und das Systemprogramm make.
Die Konvertierung nach HTML und PDF
## Vorbereitung
2014-09-12 15:13:21 +02:00
Pro Artikel muss eine Markdown-Datei mit dem Artikelinhalt (Dateieindung `.md`)
und eine YAML-Datei mit den Metadaten (Dateiendung `.yml`) angelegt werden. Die
Markdown-Datei kann beispielsweise mit durch Konvertierung aus dem DOCX-Format
(Word) mit Pandoc erstellt werden.
2014-09-21 20:42:10 +02:00
pandoc meinartikel.docx -o meinartikel.md
Die YAML-Datei muss ggf. mit einem Texteditor angepasst werden.
## Konvertierung der Markdown-Datei
2014-09-12 15:13:21 +02:00
2014-09-21 20:42:10 +02:00
PDF- und HTML-Version können mit folgendem Aufruf auf der Kommandozeile
erstellt werden:
2014-09-12 15:13:21 +02:00
2014-09-21 20:42:10 +02:00
make meinartikel.html
make meinartikel.pdf
# Stand der Umsetzung
Unter einem Unix-System mit LaTeX und Pandoc lässt sich die Vorlage
folgendermaßen nach PDF, HTML, DOCX und ODT konvertieren:
2014-10-12 23:27:17 +02:00
make vorlage
2014-09-21 20:42:10 +02:00
Die HTML-Version ist bislang noch nicht angepasst und die DOCX-Version enthält
(absichtlich) keine Metadaten sondern nur den Artikelinhalt.
2014-09-12 15:13:21 +02:00