Erster Entwurf

2014-09-12 15:13:21 +02:00 · 2014-09-12 15:13:21 +02:00 · ae5e9e39a3
parent 28b00e8a59
commit ae5e9e39a3
6 changed files with 349 additions and 17 deletions
--- a/39
+++ b/39
@ -1,13 +1,40 @@
-.SUFFIXES: .md .html .tex .pdf
+default: vorlage.pdf vorlage.html

-LATEX_OPTIONS=--template pandoc-artikel-template.tex 
-HTML_OPTIONS=--template pandoc-artikel-template.html
+# Artikel-Vorlage für Pandoc (LaTeX und HTML)
+TEMPLATE=informationspraxis-artikel-vorlage
+LATEX_OPTIONS=--template $(TEMPLATE).tex
+HTML_OPTIONS=--template $(TEMPLATE).html
+
+
+# Einstellungen zum PDF-Seitenlayout.
+# Grundlagen siehe <https://en.wikibooks.org/wiki/LaTeX/Page_Layout>
+# und <http://johnmacfarlane.net/pandoc/demo/example9/templates.html>
+
+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=1
+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
+.PHONY: clean

 .md.html:
-	pandoc -s -S -t html5 $(HTML_OPTIONS) -o $@ $<
+	cat $(patsubst %.md,%.yml,$<) $< | pandoc -s -S -t html5 $(HTML_OPTIONS) -o $@ -

 .md.tex:
-	pandoc -s -S -t latex $(LATEX_OPTIONS) -o $@ $<
+	cat $(patsubst %.md,%.yml,$<) $< | pandoc -s -S $(LATEX_OPTIONS) -o $@ -

 .md.pdf:
-	pandoc -s -S $(LATEX_OPTIONS) -o $@ $<
+	cat $(patsubst %.md,%.yml,$<) $< | pandoc -s -S $(LATEX_OPTIONS) -o $@ -
+
+clean:
+	rm -f *.{log,aux,toc}
+
--- a/README.md
+++ b/README.md
@ -2,4 +2,33 @@ 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.

-Die Konvertierung benötigt das Program [Pandoc](johnmacfarlane.net/pandoc/).
+Die Konvertierung benötigt das Program [Pandoc](johnmacfarlane.net/pandoc/)
+sowie zur Erzeugung von PDF eine LaTeX-Umgebung und GNU make.
+
+Der Inhalt der Vorlage befindet sich in Markdown-Syntax in der Datei
+
+* `vorlage.md`
+
+und die dazugehörigen Metadaten in der Datei 
+
+* `vorlage.yml`
+
+Unter einem Unix-System mit LaTeX und Pandoc lässt sich die Vorlage
+folgendermaßen nach HTML und PDF konvertieren:
+
+    make vorlage.html vorlage.pdf
+
+# Anleitung
+
+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.
+
+    pandoc -o artikel.md artikel.docx
+
+Die YAML-Datei muss mit einem Texteditor angepasst werden. Anschließend können
+PDF- und HTML-Version folgendermaßen erstellt werden:
+
+    make artikel.pdf artikel.html
+
--- a/informationspraxis-artikel-vorlage.html
+++ b/informationspraxis-artikel-vorlage.html
--- a/informationspraxis-artikel-vorlage.tex
+++ b/informationspraxis-artikel-vorlage.tex
@ -43,9 +43,8 @@ $endif$
 \IfFileExists{upquote.sty}{\usepackage{upquote}}{}
 % use microtype if available
 \IfFileExists{microtype.sty}{\usepackage{microtype}}{}
-$if(geometry)$
-\usepackage[$for(geometry)$$geometry$$sep$,$endfor$]{geometry}
-$endif$
+
+
 $if(natbib)$
 \usepackage{natbib}
 \bibliographystyle{$if(biblio-style)$$biblio-style$$else$plainnat$endif$}
@ -128,15 +127,99 @@ $if(lang)$
 \fi
 $endif$

+%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
+% Seitenlayout
+\usepackage[
+ % showframe,
+  top=$top$,
+  bottom=$bottom$,
+  left=$left$,
+  right=$right$,
+  headheight=$headheight$,
+  $if(footskip)$footskip=$footskip$$endif$,
+  $if(headsep)$headsep=$headsep$$else$headsep=\dimexpr$top$-$headheight$\relax$endif$
+]{geometry}
+
+% Kopf- und Fußzeilen
+\usepackage{fancyhdr}
+\fancyhead{}
+\fancyfoot{}
+\renewcommand{\headrulewidth}{0pt}
+%% Kopfzeile & Fußzeile folgende Seiten
+\pagestyle{fancy}
+\lhead{\footnotesize $for(author)$$author.name$$sep$, $endfor$: $title$}
+\lfoot{\footnotesize
+  \href{http://www.informationspraxis.de}{\underline{\smash{www.informationspraxis.de}}}
+  $if(doi)$\;/\; \href{http://dx.doi.org/$doi$}{doi $doi$}$endif$
+  $if(license)$\\$license.short$$endif$
+}
+\rfoot{\textbf{\thepage}}
+%% Kopfzeile & Fußzeile Titelseite
+\fancypagestyle{plain}{
+  \lhead{\includegraphics[width=11.3mm,height=10.5mm]{ip-logo.png}}
+  \rhead{\footnotesize 
+    \textbf{$year$} / $issue$ % TODO: month, day ?
+    $if(category)$\\ $category$$endif$
+  }
+  \cfoot{}\rfoot{}
+}
+
+\usepackage[small,figurename=Abbildung,tablename=Tabelle]{caption}
+
+\makeatletter
+\renewcommand\@maketitle{
+  % TODO: affiliation, email, ...
+%    \subsection*{$for(author)$$author.name$$sep$, $endfor$}
+  {\bfseries $for(author)$$author.name$$sep$, $endfor$ \par}
+
+  \section*{\@title}
+
+  \subsubsection*{Zusammenfassung}
+  $abstract$
+
+  \subsubsection*{Schlüsselwörter}
+  $for(keywords)$$keywords$$sep$, $endfor$
+
+  \subsection*{$title-en$}
+
+  \subsubsection*{Abstract}
+  $abstract-en$
+
+  \subsubsection*{Keywords}
+  $for(keywords-en)$$keywords-en$$sep$, $endfor$
+
+  \subsubsection*{Classification}
+  $for(jita)$$jita$$sep$, $endfor$
+  \pagebreak
+}
+
+$if(endnotes)$
+\usepackage{endnotes}
+\let\footnote\endnote
+\def\enoteformat{\rightskip=0pt\leftskip=0pt\parindent=0em
+     \leavevmode\llap{\makeenmark}}
+%Linie statt "Anmerkungen"
+%\def\enoteheading{\par\kern2\baselineskip%
+%\footnoterule%
+%\kern1\baselineskip}
+% subsection statt section
+\def\enoteheading{\subsection*{\notesname
+\@mkboth{\MakeUppercase{\notesname}}{\MakeUppercase{\notesname}}}%
+\mbox{}\par\vskip-\baselineskip}
+\def\notesname{Anmerkungen}
+\def\enotesize{\normalsize}
+$endif$
+%%%
+\makeatother
+%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
+
 $if(title)$
 \title{$title$}
 $endif$
 $if(subtitle)$
 \subtitle{$subtitle$}
 $endif$
-$if(author)$
 \author{$for(author)$$author$$sep$ \and $endfor$}
-$endif$
 $if(date)$
 \date{$date$}
 $endif$
@ -148,11 +231,6 @@ $endfor$
 $if(title)$
 \maketitle
 $endif$
-$if(abstract)$
-\begin{abstract}
-$abstract$
-\end{abstract}
-$endif$

 $for(include-before)$
 $include-before$
@ -184,6 +262,27 @@ $if(biblatex)$
 \printbibliography$if(biblio-title)$[title=$biblio-title$]$endif$

 $endif$
+
+$if(endnotes)$
+\theendnotes
+$endif$
+
+% \hrulefill
+\subsection*{AutorInnen}
+\begin{itemize}
+$for(author)$
+\item
+$author.name$$if(author.email)$, $author.email$$endif$
+
+$if(author.affiliation)$$author.affiliation$$if(author.address)$,$endif$$endif$$if(author.address)$$author.address$$endif$
+
+$if(author.url)$ \url{$author.url$}$endif$
+
+% TODO: author.orcid oder gnd
+
+$endfor$
+\end{itemize}
+
 $for(include-after)$
 $include-after$

--- a/vorlage.md
+++ b/vorlage.md
@ -0,0 +1,136 @@
+1. Einleitung
+----------------------
+
+Diese Vorlage ist **nicht aktuell** und dient lediglich als Platzhalter!
+
+Text hier. Und hier ist ein in eigenen Worten wiedergegebenes Zitat.
+(vgl. AutorIn & AutorIn, 2009). Text hier. Text hier. Text hier. Pro
+Kapitel mind. eine halbe Seite. Text hier. Text hier.
+
+<!--![](images/image01.png)-->
+
+Abb. 1: Titel Abbildung 1 (normale Option)
+
+Siehe [Einleitung](#einleitung)
+
+2 Überschrift 1. Ebene {.c0 .c19}
+----------------------
+
+Text hier. Text hier. Text hier. “Ein wörtliches Zitat soll sehr sparsam
+eingesetzt werden.” (NAME, Name & NAME, 2014) Text hier. Text hier. Text
+hier. Text hier.1
+
+<!--![](images/image00.png)-->
+
+Abb. 2: Titel Abbildung 2 (Option für breite Abbildungen)
+
+Text hier. Text hier. Text hier. Text hier. Text hier. Text hier. Text
+hier. Text hier. Text hier. Text hier. Text hier. Text hier. Text hier.
+Text hier. Text hier. Text hier. Text hier. Text hier. Text hier. Text
+hier. Text hier. Text hier. Text hier. Text hier. Text hier. Text hier.
+Text hier. Text hier. Text hier. Text hier.
+
+## 2.1 Überschrift 2. Ebene {.c0 .c22}
+
+Text hier. Text hier. Text hier. Text hier. Text hier. Text hier. Text
+hier. Text hier. Text hier. Text hier. Text hier. Text hier. Text hier.
+Text hier. Text hier.Text hier. Text hier. Text hier. Text hier. Text
+hier. Text hier. Text hier. Text hier. Text hier. Text hier. Text hier.
+Text hier. Text hier. Text hier. Text hier.^[Eine Fußnote. So wenige wie
+möglich verwenden]
+
+## 2.2 Überschrift 2. Ebene {.c0 .c22}
+
+Text hier. Text hier. Hervorhebungen sparsamund immer nur kursiv
+einsetzen. Text hier. Text hier. Text hier. Text hier. Text hier. Text
+hier. Text hier. Text hier.Text hier. Text hier. Text hier. Text hier.
+Text hier. Text hier.^[Leider funktionieren bei Google keine Endnoten, aber
+das wäre unsere Empfehlung für die eingereichten Artikel]
+Verwenden Sie nicht die
+automatisierten Aufzählungen Ihres Textprogrammes. Aufzählungszeichen
+Minus Leerzeichen Text der Aufzählung.\
+
+- Liste
+
+- Liste
+
+- Liste
+
+Text hier. Text hier. Text hier. Text hier. Text hier. Text hier. Text
+hier. Text hier. Text hier. Text hier. Text hier. Text hier. Text hier.
+Text hier. Text hier.Text hier. Text hier. Text hier. Text hier. Text
+hier. Text hier.
+
+--------------------+--------------------+--------------------+--------------------+
+| Spalte 1           | Spalte 2           | Spalte 3           | Spalte 4           |
+--------------------+--------------------+--------------------+--------------------+
+| Zeile 2            | 123,45             | 17,2               | 1232,23            |
+--------------------+--------------------+--------------------+--------------------+
+| Zeile 3            | 56,78              | -                  | 189,9              |
+--------------------+--------------------+--------------------+--------------------+
+| Zeile 4            | 198                | 67,325             | 789567,03          |
+--------------------+--------------------+--------------------+--------------------+
+
+:Wahllos eingegebene Zahlen und ein Minuszeichen
+
+### 2.2 Listen
+
+Verwenden Sie nicht die automatisierten Aufzählungen Ihres Textprogrammes.
+Einfache Listen: Minus Leerzeichen Text der Aufzählung.
+
+- Liste
+- Liste
+- Liste
+
+Nummerierte Listen: Nummer Punkt Leerzeichen Text der Aufzählung.
+
+1. Nummerierte Liste
+
+2. Nummerierte Liste
+
+3. Nummerierte Liste
+
+### 2.2.2 Programmcode und Datensätze
+
+Programmcode und Datensätze sollten in Artikeln überschaubar bleiben und
+angemessen beschrieben werden. Der wesentliche Inhalt und Zweck eines
+Code-Abschnitts sollte auch ohne tiefere Kenntnisse des Datenformates bzw. der
+Programmiersprache erkennbar sein. Die Code-Abschnitte werden in einer 1x1
+Tabelle gesetzt. Bei Bedarf können sie auch mit einem Titel versehen werden,
+die Nummerierung erfolgt allerdings als Abbildung ("Abb. X")!
+
+
+~~~
+240 10 _aLiving my life <dt.>
+245 10 _aGelebtes Leben
+       _bAutobiografie
+       _cEmma Goldman. Mit einem Vorw. von Ilija Trojanow.
+250    _aErstausg., 1. Aufl.
+260 3  _aHamburg
+       _bEd. Nautilus
+       _c2010
+~~~
+
+Abb. 3: Ausschnitt aus einem MARC-Datensatz
+
+Umfangreichere Daten und Programme sollten in etablierten Forschunsgdaten-
+und/oder Code-Repositories verfügbar gemacht und im Artikel verlinkt werden.
+
+
+3 Quellen
+---------
+
+Nachname, Vorname (xx. Jan. 2012): Titel: Untertitel[online]. Zugriff
+am: 10. Aug. 2014]. Verfügbar unter:
+http://www.adresse.de/titel/name\_name\_titel\_name/
+
+Nachname, Vorname (2009): Titel des unselbständigen Werkes. In:
+Nachname, Vorname und Nachname, Vorname, Hg.: Der Titel des
+selbständigen Titels. Ort: Verlag, S. von-bis
+
+Nachname, Vorname Vorn. (2013): Titel: Untertitel. Ort: Verlag.
+
+Nachname, Vorname, Nachname, Vorname & Nachname, Vorname (2010). Titel
+des Artikels. In: Titel des Journals109, 2, S. 16–26. [Zugriff am 10.
+Aug. 2014]. DOI: http://dx.doi.org/10.2403/jo.nam.2010.07.008.
+
--- a/vorlage.yml
+++ b/vorlage.yml
@ -0,0 +1,41 @@
+---
+title: Deutscher Titel
+title-en: English title
+year: 2014
+issue: 1 # ???
+author:
+    - name: Vorname Nachname
+      email: vorname@email.tld
+      url: http://example.org/
+    - name: Vorname Nachname
+      email: vorname@email.tld
+      affiliation: Beispielorganisation
+abstract:
+    Jeder Artikel muss eine Zusammenfassung in deutscher Sprache enthalten. Die
+    Zusammenfassung soll einen kurzen und vollständigen Überblick über den Inhalt
+    des Artikels geben. Die wichtgisten Ergebnisse, Hintergrund und Vorgehensweise
+    des Artikels sollten klar nachvollziehbar aus der Zusammenfassung hervorgehen.
+    Der Umfang der Zusammenfassung ist auf 700 Zeichen (incl. Leerzeichen) 
+    beschränkt. Die Zusammenfassung sollte aus einem einzelnen Absatz bestehen.
+abstract-en:
+    Every article must conatain an English abstract. The abstract is limited to one
+    paragraph and up to 700 characters.
+keywords:
+    - Schlüsselwort 1
+    - Schlüsselwort 2
+    - Schlüsselwort 3
+    - ...
+keywords-en:
+    - keyword 1
+    - keyword 2
+    - keyword 3
+    - ...
+jita: 
+    - A. Theoretische und allgemeine Aspekte von Bibliotheken und Informationen
+    - GI. Weiterbildung
+
+category: Fachbeitrag
+license: 
+    short: CC-BY-SA 4.0
+doi: 123.456/7890abcde
+...