From a14df9876031335425dd61a4e2aeb5074283ea94 Mon Sep 17 00:00:00 2001 From: Felix Lohmeier Date: Mon, 25 Sep 2017 21:49:40 +0200 Subject: [PATCH] =?UTF-8?q?Vorgaben=20aus=20HOWTO=20in=20README=20=C3=BCbe?= =?UTF-8?q?rnommen;=20Makefile=20entfernt?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- HOWTO.md | 33 ---------------------- Makefile | 54 ------------------------------------ README.md | 83 ++++++++++++++++++++++++++----------------------------- 3 files changed, 39 insertions(+), 131 deletions(-) delete mode 100644 HOWTO.md delete mode 100644 Makefile diff --git a/HOWTO.md b/HOWTO.md deleted file mode 100644 index 081fb0c..0000000 --- a/HOWTO.md +++ /dev/null @@ -1,33 +0,0 @@ -Wenn der Artikel bereits im Markdown-Format vorhanden ist, beginne mit Schritt -3. - -1. Umbenennung der Datei nach dem Schema `erstautorin-yyyy-mm-dd.xxx` wobei - `erstautorin` der Nachname der Erstautorin oder des Erstautors in - Kleinbuchstaben, `yyyy-mm-dd` das Datum der Einreichung und `xxx` die - Dateiendung ist. - -2. Falls es sich nicht bereits um eine DOCX-Datei handelt (Dateiendung `docx`), - Konvertierung in dieses Format, z.B. mit Word oder http://cloudconvert.org/ - -3. Konvertierung der DOCX-Datei nach Markdown mit Hilfe von Pandoc: - - ``` - pandoc -o erstautorin-yyyy-mm-dd.md erstautorin-yyyy-mm-dd.docx - ``` - -4. Erstellung einer YAML-Datei `erstautorin-yyyy-mm-dd.yml` für die Metadaten - entsprechend der Vorlage `vorlage.yml` und Bearbeitung der Markdown-Datei - `erstautorin-yyyy-mm-dd.md` mit einem Texteditor: - - - Titel, Abstract, Keywords, (Informationen über die) Autoren etc. - gehören *nur* in die YAML-Datei - - - ... - -5. Sicherstellen, dass sich die Datei `ip-logo.png` im aktuellen Verzeichnis - befindet. - -6. Erstellung der HTML- und PDF-Version - - - ....(ausführlichere Anleitung folgt)... - diff --git a/Makefile b/Makefile deleted file mode 100644 index 5e0944a..0000000 --- a/Makefile +++ /dev/null @@ -1,54 +0,0 @@ -# Verzeichnis, in dem sich dieses Mafile befindet -DIR := $(shell dirname $(realpath $(lastword $(MAKEFILE_LIST)))) - -vorlage: vorlage.pdf vorlage.html vorlage.docx vorlage.odt - -# Artikel-Vorlage für Pandoc (LaTeX und HTML) -TEMPLATE=informationspraxis-artikel-vorlage -LATEX_OPTIONS=--template $(DIR)/$(TEMPLATE).tex -HTML_OPTIONS=--template $(DIR)/$(TEMPLATE).html - - -# Einstellungen zum PDF-Seitenlayout. -# Grundlagen siehe -# und - -ENDNOTES=1 - -LATEX_OPTIONS+=-V fontfamily=arev -LATEX_OPTIONS+=-V fontsize=12pt -LATEX_OPTIONS+=-V papersize=a4paper -LATEX_OPTIONS+=-V documentclass=article -LATEX_OPTIONS+=-V headheight=20mm -V headsep=10mm -LATEX_OPTIONS+=-V footskip=20mm -LATEX_OPTIONS+=-V top=30mm -V bottom=40mm -V left=25mm -V right=25mm -LATEX_OPTIONS+=-V endnotes=$(ENDNOTES) -LATEX_OPTIONS+=-V lang=ngerman -LATEX_OPTIONS+=-V graphics=1 - - -# Konvertierungsregeln von Markdown (Artikel) und YAML (Metadaten) nach HTML & PDF -.SUFFIXES: .md .html .tex .pdf .docx .odt -.PHONY: clean - -.md.html: - cat $(patsubst %.md,%.yml,$<) $< | pandoc -s -S -t html5 $(HTML_OPTIONS) -o $@ - - -.md.tex: - cat $(patsubst %.md,%.yml,$<) $< | pandoc -s -S $(LATEX_OPTIONS) -o $@ - - -#.md.pdf: -# cat $(patsubst %.md,%.yml,$<) $< | pandoc -s -S $(LATEX_OPTIONS) -o $@ - - -.tex.pdf: - yes "" | pdflatex $< - -.md.docx: - cat $(patsubst %.md,%.yml,$<) $< | pandoc -s -S -o $@ - - -.md.odt: - cat $(patsubst %.md,%.yml,$<) $< | pandoc -s -S -o $@ - - -clean: - rm -f *.log *.aux *.toc *.out - diff --git a/README.md b/README.md index ea1869a..5a7e125 100644 --- a/README.md +++ b/README.md @@ -1,63 +1,58 @@ -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. +Dieses Repository enthält Vorlagen für Artikel der Fachzeitschrift [Informationspraxis](http://informationspraxis.de/) sowie Konfigurationsdateien zur Konvertierung der Artikel mit [Pandoc](johnmacfarlane.net/pandoc/) nach HTML, PDF und EPUB. -# Verwendung der Vorlage zum Verfassen eigener Artikeln +## Vorlage -Die Vorlage besteht aus zwei Dateien: +Die Vorlage für Artikel besteht aus zwei Dateien: -* Die Datei **vorlage.yml** für die Metadaten des Artikels - (Titel, Autor, Abstract...) +* Die Datei **vorlage-metadaten.yml** für die Metadaten des Artikels (Titel, Autor/in, 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 + * **vorlage-markdown.md** zum Verfassen in Markdown-Syntax + * **vorlage-word.docx** zum Verfassen mit Word + * **vorlage-libreoffice.odt** zum Verfassen mit Libre/Open Offixe -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. +## Redaktionelle Bearbeitung -Bitte benennen Sie beide Dateien einheitlich um und behalten die Dateiendung -bei, beispielsweise +1. Konvertierung des eingereichten Dokuments nach Markdown mit Hilfe von Pandoc: -* vorlage.yml $\Rightarrow$ meinartikel.yml -* vorlage.docx $\Rightarrow$ meinartikel.docx + - von Format DOCX: -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. + ``` + pandoc -o erstautorin-yyyy-mm-dd.md erstautorin-yyyy-mm-dd.docx + ``` + + - von Format ODT: + + ``` + pandoc -o erstautorin-yyyy-mm-dd.md erstautorin-yyyy-mm-dd.docx + ``` + + - von Format DOC: Zunächst Konvertierung in DOCX, z.B. mit Word oder [http://cloudconvert.org](http://cloudconvert.org), dann Konvertierung mit Pandoc (s.o.) -# Konvertierung nach HTML und PDF +2. Erstellung einer YAML-Datei `erstautorin-yyyy-mm-dd.yml` für die Metadaten entsprechend der Vorlage `vorlage-metadaten.yml` -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 +3. Bearbeitung der Markdown-Datei `erstautorin-yyyy-mm-dd.md` -## Vorbereitung + - Titel, Abstract, Keywords, (Informationen über die) Autoren etc. + gehören *ausschließlich* in die YAML-Datei -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. + - Sichtprüfung der Formatierung und ggf. Korrekturen nach [Pandoc-Markdown-Syntax](http://pandoc.org/MANUAL.html#pandocs-markdown) - pandoc meinartikel.docx -o meinartikel.md +## Konvertierung nach HTML, PDF und EPUB -Die YAML-Datei muss ggf. mit einem Texteditor angepasst werden. +1. Erstellung der HTML-Version -## Konvertierung der Markdown-Datei + ``` + pandoc -s --template pandoc-template.html -o erstautorin-yyyy-mm-dd.html erstautorin-yyyy-mm-dd.md erstautorin-yyyy-mm-dd.yml + ``` -PDF- und HTML-Version können mit folgendem Aufruf auf der Kommandozeile -erstellt werden: +2. Erstellung der PDF-Version - make meinartikel.html - make meinartikel.pdf + ``` + pandoc -s --template pandoc-template.tex -o erstautorin-yyyy-mm-dd.pdf erstautorin-yyyy-mm-dd.md erstautorin-yyyy-mm-dd.yml + ``` -# 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: - - make vorlage - -Die HTML-Version ist bislang noch nicht angepasst und die DOCX-Version enthält -(absichtlich) keine Metadaten sondern nur den Artikelinhalt. +7. Erstellung der EPUB-Version + ``` + pandoc -s -o erstautorin-yyyy-mm-dd.epub erstautorin-yyyy-mm-dd.md erstautorin-yyyy-mm-dd.yml + ``` \ No newline at end of file