Workflow-Abbildung, YAML-Check und Bildunterschrift

.yamllint

@@ -0,0 +1,18 @@
+# configuration file for yamllint extending the default one
+
+extends: default
+
+rules:
+  comments:
+    require-starting-space: true
+    min-spaces-from-content: 2
+  document-start:
+    level: error
+  document-end:
+    level: error
+  empty-lines:
+    max: 0
+  empty-values: enable
+  line-length: disable
+  trailing-spaces:
+    level: warning

Makefile

@@ -3,9 +3,10 @@
 # 
 # You can creates either (1) all article galleys from all the docx and odt
 # files in this directory, or (2) make a specific galley (recognized by
-# the file ending) from a specific article only
+# the file ending) from a specific article only, or check all yaml files (3)
 # (1) make
 # (2) make article.pdf
+# (3) make check
 #
 
 SOURCE_DOCS := $(wildcard *.docx *.odt)
@@ -44,10 +45,15 @@ all : $(EXPORTED)
 %.epub: %.md %.yml
 	pandoc -s --toc -o $@ $^
 
+# For validating/checking all YAML files
+.PHONY: check
+check:
+	yamllint *.yml
+
 # For debugging
 %.tex: %.md %.yml
 	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 $@ $^
 %.native.txt: %.docx
-	pandoc --extract-media . --wrap=none --lua-filter clean-images.lua --lua-filter compact-lists.lua -t native -o $@ $^
+	pandoc -s --extract-media . --wrap=none --lua-filter clean-images.lua --lua-filter compact-lists.lua -t native -o $@ $^
 %.native.txt: %.odt
-	pandoc --extract-media . --wrap=none --lua-filter clean-images.lua --lua-filter compact-lists.lua -t native -o $@ $^
+	pandoc -s --extract-media . --wrap=none --lua-filter clean-images.lua --lua-filter compact-lists.lua -t native -o $@ $^

README.md

@@ -12,6 +12,8 @@ Dieses Repository enthält Vorlagen für Artikel der Fachzeitschrift [Informatio
 
 Für die Konvertierung der eingereichten Artikel nach HTML, PDF und EPUB nutzen wir [Pandoc](https://pandoc.org/). Für die redaktionelle Bearbeitung nutzen wir den Markdown-Editor [Typora](https://typora.io). 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++.
 
+![Workflow mit Pandoc](workflow.png)
+
 ### Beispiel
 
 - AutorInnen

pandoc-template.html

@@ -7,6 +7,7 @@
   <meta name="author" content="$author$">
   <title>$if(title-prefix)$$title-prefix$ - $endif$$pagetitle$</title>
   <style type="text/css">code{white-space: pre;}</style>
+  <style type="text/css">figcaption, table>caption {font-size: small;}</style>
 $if(quotes)$
   <style type="text/css">q { quotes: "“" "”" "‘" "’"; }</style>
 $endif$

pandoc-template.tex

@@ -268,7 +268,10 @@
   \pagebreak
 }
 
-\usepackage[small,figurename=Abbildung,tablename=Tabelle]{caption}
+% numbering of figures and tables will be done manually
+% in order to consistent among the different output formats
+% thus "empty" here for labelformat
+\usepackage[small,labelformat=empty,figurename=Abb.,tablename=Tab.]{caption}
 
 \makeatother
 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%

vorlage-markdown.md

@@ -45,11 +45,12 @@ Alle Beiträge erscheinen unter der Lizenz Creative Commons Namensnennung 4.0. D
 
 Abbildungen bitte als Bilddatei mitschicken, hier mit Dateinamen einbinden und nicht weiter formatieren.
 
-![](image1.png)
+![Abb. 1: Workflow zur Verarbeitung der Eingabedateien und Erzeugung der Fahnen](workflow.png){ #workflow }
 
-Abb. 1: Titel Abbildung 1
-
-Abbildungen bitte wie oben mit Bildunterschriften versehen und durchnummerieren.
+Bildunterschriften werden bei Abbildungen automatisch aus dem Alt-Tag (Text zwischen eckiger Klammer) erzeugt.
+Eine Bildunterschrift soll immer mit "Abb." beginnen gefolgt von einer fortlaufend hochgezählten Nummer (beginnend bei 1) und mit einem Doppelpunkt vom eigentlichen Inhalt der Bildunterschrift getrennt werden.
+Die ID in den geschwungen Klammern ist optional, aber erlaubt es einen internen Link auf die Abbildung zu setzen.
+Auch für solche Verweise bitte konsistent "Abb." sowie der Nummer angeben, z.B. [Abb. 1](#workflow).
 
 2.1 Zitate (Überschrift 2. Ebene)
 ---------------------------------