Skip to content
Vorlagen für die Dokumentenkonvertierung mit pandoc für die Zeitschrift Informationspraxis. Dient der Generierung von HTML, PDF und EPUB aus einem Ausgangsformat (ODT, DOCX oder MD).
Branch: master
Clone or download
Pull request Compare This branch is 10 commits ahead of Informationspraxis:master.
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
example
screenshots
README.md Workflow dokumentiert Jun 6, 2019
cc-by.png
ip-logo.png
pandoc-template.html
pandoc-template.tex
vorlage-markdown.md
vorlage-metadaten.yml
vorlage-word.dotx

README.md

Dieses Repository enthält Vorlagen für Artikel der Fachzeitschrift Informationspraxis sowie Konfigurationsdateien zur Konvertierung der Artikel mit Pandoc nach HTML, PDF und EPUB.

Vorlage für Beitragseinreichungen

  • vorlage-word.dotx zum Verfassen mit Word
  • vorlage-markdown.md zum Verfassen in Markdown-Syntax
  • vorlage-libreoffice.ott zum Verfassen mit Libre/Open Office
    • TODO: Vorlage für LibreOffice

Redaktionsworkflow

Für die Konvertierung der eingereichten Artikel nach HTML, PDF und EPUB nutzen wir Pandoc. Für die redaktionelle Bearbeitung nutzen wir den Markdown-Editor Typora. Beide Tools sind für Windows, macOS und Linux verfügbar. Unter Windows benötigen wir zusätzlich einen vernünftigen Texteditor zur Bearbeitung der Metadaten im YAML-Format wie z.B. Notepad++.

Beispiel

Installation

Windows, MacOS, Linux:

Windows zusätzlich:

Redaktionelle Bearbeitung

Der folgende Workflow wurde getestet am 6.6.2019 unter Windows mit:

  • Pandoc 2.7.2
  • MiKTeX 2.9.7086
  • Typora 0.9.70
  • Notepad++ 7.7

Schritt 1: Erstellung einer YAML-Datei für die Metadaten

Vorlagendatei vorlage-metadaten.yml in einem UTF-8-fähigen-Texteditor (z.B. Notepad++ unter Windows) öffnen, alle relevanten Daten ausfüllen und unter neuem Dateinamen speichern, hier im Beispiel erstautorin-2019.yml.

Der Abschnitt "von den AutorInnen vergebene Metadaten" kann ggf. per Copy & Paste aus dem von den AutorInnen eingereichten Dokument übernommen werden.

Metadaten in YAML

Schritt 2: Konvertierung des eingereichten Dokuments nach Markdown

Öffnen Sie eine Kommandozeile (Windows: PowerShell, macOS/Linux: Terminal) und wechseln Sie in das Verzeichnis, in das Sie die Vorlagen heruntergeladen haben.

Legen Sie das eingereichte Dokument ebenfalls in diesem Verzeichnis ab. In diesem Beispiel heißt die Quelldatei erstautorin-2019.docx

Konvertierung nach Markdown

  • von Format Markdown
    • keine Konvertierung notwendig, weiter mit Schritt 3
  • von Format DOC
    • Datei in Word oder LibreOffice öffnen und als DOCX speichern
    • Dann weiter mit Format DOCX
  • von Format DOCX (Beispiel für Quelldatei erstautorin-2019.docx)
pandoc --extract-media . --wrap=none -t markdown-simple_tables -o erstautorin-2019.md erstautorin-2019.docx
  • von Format ODT (Beispiel für Quelldatei erstautorin-2019.odt)
pandoc --extract-media . --wrap=none -t markdown-simple_tables -o erstautorin-2019.md erstautorin-2019.odt

Schritt 3: Nachbearbeitung der Markdown-Datei

Die im vorigen Schritt erstellte Markdown-Datei in einem Markdown-Editor (z.B. Typora unter Windows) öffnen und bereinigen.

Nachbearbeitung mit Typora

Folgende Nacharbeiten sind erforderlich:

  • Metadaten und Fragmente aus der Vorlage zu Beginn der Datei löschen. Der Text muss direkt mit der ersten Überschrift (z.B. 1 Einleitung) beginnen.
  • Prüfen, ob alle Bilder korrekt angezeigt werden. Größenangaben wie {width="6.531496062992126in" height="2.263779527559055in"} löschen.
  • Bildunterschriften prüfen und ggf. vereinheitlichen.
  • Wenn Listen kompakt dargestellt werden sollen, dann im Quellcode (Menü Darstellung / Quellcodemodus) leere Zeilen innerhalb der Aufzählungen entfernen.
  • Ggf. weitere Formatierung gemäß der Richtlinien und nach Pandoc-Markdown-Syntax

HTML, PDF und EPUB generieren

Zurück in der Kommandozeile die folgenden Befehle aufrufen, um die fertigen Dateien für OJS zu erstellen.

Konvertierung von Markdown nach HTML, PDF und EPUB

Schritt 4: Erstellung der HTML-Version

pandoc -s --toc --template pandoc-template.html -o erstautorin-2019.html erstautorin-2019.yml erstautorin-2019.md

Manuelle Nacharbeiten:

  • Mit Suchen & Ersetzen die Pfadangabe für Bilddateien anpassen, da OJS direkte Links auf Dateinamen der Bilddateien erwartet
    • Suchen: img src="./media/
    • Ersetzen: img src="

Schritt 5: Erstellung der PDF-Version

pandoc -s --toc --template pandoc-template.tex -V fontsize=12pt -V papersize=a4paper -V documentclass=article -V headheight=20mm -V headsep=10mm -V footskip=20mm -V top=30mm -V bottom=40mm -V left=25mm -V right=25mm -V graphics=1 -o erstautorin-2019.pdf erstautorin-2019.yml erstautorin-2019.md

Schritt 6: Erstellung der EPUB-Version

pandoc -s --toc -o erstautorin-2019.epub erstautorin-2019.yml erstautorin-2019.md
You can’t perform that action at this time.