Skip to content

CERES-RUB/er-pandoc-workflow

Repository files navigation

Entangled Religions typesetting

Workflow

Der Workflow besteht aus drei Schritten:

  1. Konvertierung eines DOCX-Dokuments in Markdown.
  2. Bereinigung des Dokuments und redaktionelle Überarbeitung.
  3. Konvertierung des Markdown-Dokuments in PDF (mittels LaTeX).

Konvertierung DOCX → Markdown

Für jedes Dokument wird ein neues Verzeichnis unter articles angelegt, z.B. articles/Autor_Kurztitel. Hier wird die Docx-Datei gespeichert.

Die Konversion wird dann aus dem Hauptordner heraus über das Skript convert.sh angestoßen:

./convert.sh articles/Autor_Kurztitel/Autor_Kurztitel.docx

Wenn Ubuntu unter Windows verwendet wird, muss man vorher in den entsprechenden Ordner wechseln:

cd /mnt/c/Users/USERNAME/sciebo/ER_Workflow/

Bereinigung

  1. Kopfdaten Jedem Markdown-Dokument muss ein Satz mit Kopfdaten vorangestellt werden. Ein Beispielsatz der erforderlichen Felder findet sich in der Datei template/metadata.md.
  2. Literaturverweise Die Literaturverweise im Dokument werden durch Referenzen auf die Zotero-Datenbank ersetzt. Noch ausarbeiten!
  3. CMoS Der Text wird, falls nicht zuvor geschehen, an den Chicago Style (author-date) angepasst.

Darüberhinaus sollte allgemein überprüft werden, ob die Formatierungen richtig übernommen wurden, und ggf. das Markdown mit den untenstehenden Funktionen angepasst werden.

Markdown

ER nutzt pandoc und dessen Markdown-Erweiterungen.

Sprachen

Die Hauptsprache des Dokuments wird in den Metadatan über die Variable lang gesetzt, z.B.:

lang: en

Weitere Sprachen können entweder für ganze Abschnitte oder für einzelne Segmente gesetzt werden, indem Divs und Spans genutzt werden:

::: {lang="de"}

Der Text ist deutsch.

:::

This is an English sentence with parts [auf Deutsch]{lang="de"}.

Falls für die LaTeX-Ausgabe der jeweiligen Sprachen zusätzlich Schriftarten notwendig sind, werden diese in der Regel automatisch geladen. Für Arabisch (lang="ar"), Hebräisch (lang="he"), Griechisch (lang="el"), Coptisch (lang="cop"), Ge'ez (lang="am") und Syrisch (lang="syr") sind Schriften im LaTeX-Template definiert, weitere müssen u.U. ergänzt werden.

Eine Ausnahme sind CJK-Schriften wie Chinesisch. Da hierfür ein zusätzliches Paket geladen werden muss, das relativ weitreichend in den Textsatz eingreift, muss dies explizit in den Metadaten definiert werden (wie zum Beispiel im Artikel von Santangelo):

CJKmainfont: Noto Serif CJK TC

Abbildungen und Tabellen

Abbildungen werden als „gleitende Objekte“ gesetzt, das heißt sie haben keinen festen Platz, sondern werden günstig (meist oben auf einer Seite) gesetzt. Im Text sollte daher immer über eine Nummer auf die Abbildung verwiesen werden. Es kann im Falle von Sonderzeichen wie öffnenden (einfachen) Anführungszeichen, die (fälschlicherweise) in Transliterationen wie ‘Arabah verwendet werden, passieren, dass eine Bildreferenz nicht richtig erkannt wird. In diesem Falle muss darauf geachtet werden, das problemverursachende Sonderzeichen via \ zu escapen (in diesem Beispiel also ‘Arabah durch \‘Arabah zu ersetzen). Um im Text auf die Nummer der Abbildung zu verweisen, wird eine ID vergeben, die immer mit fig: anfängt:

See figure @fig:afigure.

![A caption for the figure](figure1.tif){#fig:afigure}

Tabellen werden derzeit standardmäßig an der Stelle gesetzt, an der sie im Text erscheinen, nicht als gleitende Objekte.1 Dennoch sollte hier die Tabelle referenziert werden. Die Tabellenbeschriftung wird dabei in einer separaten Zeile mit dem Anfang Table: definiert. Hier haben die IDs immer das Präfix tbl:.

Table: Sample grid table. {#tbl:atable}

+---------------+---------------+--------------------+
| Fruit         | Price         | Advantages         |
+===============+===============+====================+
| Bananas       | $1.34         | - built-in wrapper |
|               |               | - bright color     |
+---------------+---------------+--------------------+
| Oranges       | $2.10         | - cures scurvy     |
|               |               | - tasty            |
+---------------+---------------+--------------------+

Falls die automatischen Spaltenbreiten kein gutes Ergebnis liefern, können sie explizit definiert werden. Hierfür werden für die Anzahl der Spalten Bruchteile definiert, die sich auf 1 addieren, also z.B.:

Table: Sample grid table. {#tbl:atable colwidth=".3 .2 .5"}

+---------------+---------------+--------------------+
| Fruit         | Price         | Advantages         |
+===============+===============+====================+
| Bananas       | $1.34         | - built-in wrapper |
|               |               | - bright color     |
+---------------+---------------+--------------------+
| Oranges       | $2.10         | - cures scurvy     |
|               |               | - tasty            |
+---------------+---------------+--------------------+

Absatzzählung

Die Absätze des Artikels werden automatisch nummeriert. Innerhalb von Listen gibt es eine Besonderheit: Kompakte Listen ohne Leerzeile zwischen Einträgen werden als ein einzelner Absatz gezählt, bei nicht-kompakten Listen wird jeder Eintrag als ein Absatz gezählt:

Eine Absatznummer:

* Kompakte
* Liste

Zwei Absatznummern:

* Nicht-kompakte

* Liste

Sollen für einen Abschnitt die Absätze nicht nummeriert werden, so muss dieser in ein DIV mit der Klasse noparnums gefasst werden. Dies ist etwas sinnvoll für die Acknowledgements, eine Autorenbiographie o.ä.

::: noparnums

# Acknowledgements

The author thanks …

:::

Sollen sukzessive Absätze nicht eingerückt werden (was aufgrund des fehlenden Abstands zwischen den Paragraphen nur in Ausnahmefällen sinnvoll ist - lieber eine Definitionsliste verwenden), kann der Abschnitt mit noindent ausgezeichnet werden.

## A.  Standard Borrowings

::: noindent

*’’c’r(’)y**ācārya* (B, G, R) 2. b. 2. f.

*’’kš’r**akṣara* (?, R) 2. q.

*’’m(’)wkp’š**Amoghapāśa* (L, P) 2. a; 2. i.IL

*’’n’k’my**anāgāmin*, nom. *anagamī* (R) 2. u. HL

*’’n’nt**Ānanda* (MK, L, P) 2. q., n. 31

:::

Wenn noparnums mit noindent kombiniert werden soll (was im obigen Beispiel sinnvoll ist), müssen die Klassen in eckigen Klammern eingefügt werden (der . vor den Namen ist hier unbedingt notwendig, siehe auch pandoc Documentation fenced_divs).

## A.  Standard Borrowings

::: { .noindent .noparnums }

*’’c’r(’)y**ācārya* (B, G, R) 2. b. 2. f.

*’’kš’r**akṣara* (?, R) 2. q.

*’’m(’)wkp’š**Amoghapāśa* (L, P) 2. a; 2. i.IL

*’’n’k’my**anāgāmin*, nom. *anagamī* (R) 2. u. HL

*’’n’nt**Ānanda* (MK, L, P) 2. q., n. 31

:::

Zitate

Blockzitate stellen in pandoc immer einen eigenen Absatz dar. Daher ist es nicht ohne weiteres möglich, Blockzitate zu definieren, die Teil des umgebenden Absatzes sind. Es ist aber möglich, die folgende Einrückung im PDF zu unterdrücken:

Das ist ein Text.

> Hier ist ein Zitat

\noindent das viel Aufschluss gibt.

Bibliographie

Zotero

Die Literaturangaben aller Artikel werden in einer gemeinsamen Zotero-Bibliothek verwaltet. Um die Konsistenz zwischen verschiedenen Bearbeitenden sicherzustellen, wird zusätzlich das Plugin Better BibTeX verwendet.

In den Einstellungen unter Bearbeiten → Einstellungen → Better BibTeX wird folgendes Format für den Zitierschlüssel eingestellt: [auth]_[shorttitle1]_[year]

Zitierschlüssel sollten für alle Einträge angepinnt werden (Rechtsklick → Better BibTeX → BibTeX-Key anheften).

Zotero Korrektur importierter Titel anhand der Reference List der Autor_innen

Die folgenden Korrekturen werden zurzeit von ER HiWis übernommen (kann auch als Anleitung für neue HiWis dienen):

  • Überprüfen, ob alle Einträge der Literaturliste auch im Zotero Ordner vorhanden sind
  • Eintragsart überprüfen - wurde der Eintrag richtig zugeordnet? (Journalartikel, Sammelbandartikel, Monographie?)
  • Richtigkeit aller Felder überprüfen
  • Groß- und Kleinschreibung aller Felder überprüfen (oft werden alle Wörter kleingeschrieben importiert)
  • Sprachfeld ausfüllen (wichtig!) --> bitte die Sprachfelder aller Einträge ausfüllen, besonders wichtig ist dabei, dass nicht-englische Einträge per Sprachfeld definiert werden (oft: Deutsch, Französisch, Italienisch)
  • Bei Unklarheiten und fehlenden Informationen werden einzelne Titel zurzeit eigenständig recherchiert, sofern möglich (via Google oder bibliographische Datenbanken). Dabei liegt es im eigenen Ermessen, ob alternativ offene Fragen an den/die Autor_in zurückgegeben werden.
  • Wenn Unklarheiten nicht geklärt werden können, wird zurzeit eine Notiz an den entsprechenden Zotero-Eintrag angefügt, die das Problem für die Managing Editor beschreibt und die originale, von Autor_innen eingereichte, Reference enthält.
  • Bei Autor 2020a, Autor 2020b etc in der Autorenbibliographie: Bitte einen Vermerk ins "Extra Feld" machen, damit die References beim Textsatz leichter zuzuordnen sind.

Sonderfälle in Zotero (Formatierung)

Manchmal muss bei einzelnen Titeln die Formatierung in Zotero korrigiert werden, beispielsweise bei Kursivierungen im Titel, etc. Dies geschieht durch HTML Codes.

  • Kursiv
  • Fett
  • Sprache nicht übertragen (relevant für die richtige Groß- und Kleinschreibung in der Ausgabe): Introduction to religious studies: Einführung in die Religionswissenschaft (Wenn hier im Sprachenfeld Englisch definiert ist, würde ohne den "nocase" Befehl die Ausgabe "Einführung In Die Religionswissenschaft" ergeben (da headline style).

Für weitere Ausnahmen und Beispiele, siehe Adrians super Dokumentation im Ordner Hiwis/Praktikanten. Die könnte in Teilen auch eine gute Handreichung für neue HiWis sein.

Sonderfälle mit Artikelbeispielen

  • Appendix soll nach der Reference List erscheinen: Santangelo, Dege-Müller_Karlsson
  • komplexere Tabellen: Stadlbauer
  • Sprachen: Coptisch (Colditz), Chinesisch (Santangelo, Deeg), Ge'ez (Dege-Müller_Karlsson)
  • kleinere Literaturlisten, die nicht über Zotero gepflegt werden, aber im gleichen Format erscheinen sollen (ab zweiter Zeile eingerückt), zum Beispiel Archivmaterial oder Diskographie: Dege-Müller_Karlsson, siehe auch Viehbeck

Footnotes

  1. Das sollte in Zukunft konfigurierbar sein.

About

Templates and scripts to convert articles for Entangled Religions using Markdown and Pandoc

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published