rudimentäre HTML-Ausgabe
This commit is contained in:
Jakob Voss
parent
d6830bf9de
commit
95da487cad
5
Makefile
5
Makefile
|
|
@ -1,4 +1,4 @@
|
|||
default: vorlage.pdf vorlage.html vorlage.docx
|
||||
default: vorlage.pdf vorlage.html vorlage.docx vorlage.odt
|
||||
|
||||
# Artikel-Vorlage für Pandoc (LaTeX und HTML)
|
||||
TEMPLATE=informationspraxis-artikel-vorlage
|
||||
|
|
@ -38,6 +38,9 @@ LATEX_OPTIONS+=-V graphics=1
|
|||
.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
|
||||
|
||||
|
|
|
|||
70
README.md
70
README.md
|
|
@ -2,36 +2,62 @@ 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.
|
||||
|
||||
# Verwendung der Vorlage zum Verfassen eigener Artikeln
|
||||
|
||||
Die Vorlage besteht aus zwei Dateien:
|
||||
|
||||
* Die Datei **vorlage.yml** für die Metadaten des Artikels
|
||||
(Titel, Autor, 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
|
||||
|
||||
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.
|
||||
|
||||
Bitte benennen Sie beide Dateien einheitlich um und behalten die Dateiendung
|
||||
bei, beispielsweise
|
||||
|
||||
* vorlage.yml $\Rightarrow$ meinartikel.yml
|
||||
* vorlage.docx $\Rightarrow$ meinartikel.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.
|
||||
|
||||
# Konvertierung nach HTML und PDF
|
||||
|
||||
Die Konvertierung benötigt das Program [Pandoc](johnmacfarlane.net/pandoc/)
|
||||
sowie zur Erzeugung von PDF eine LaTeX-Umgebung und GNU make.
|
||||
sowie zur Erzeugung von PDF eine LaTeX-Umgebung und das Systemprogramm make.
|
||||
Die Konvertierung nach HTML und PDF
|
||||
|
||||
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 PDF, HTML und DOCX konvertieren:
|
||||
|
||||
make
|
||||
|
||||
Die HTML-Version ist bislang noch nicht angepasst und die DOCX-Version enthält
|
||||
(absichtlich) keine Metadaten sondern nur den Artikelinhalt.
|
||||
|
||||
# Anleitung
|
||||
## Vorbereitung
|
||||
|
||||
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
|
||||
pandoc meinartikel.docx -o meinartikel.md
|
||||
|
||||
Die YAML-Datei muss mit einem Texteditor angepasst werden. Anschließend können
|
||||
PDF- und HTML-Version folgendermaßen erstellt werden:
|
||||
Die YAML-Datei muss ggf. mit einem Texteditor angepasst werden.
|
||||
|
||||
make artikel.pdf artikel.html
|
||||
## Konvertierung der Markdown-Datei
|
||||
|
||||
PDF- und HTML-Version können mit folgendem Aufruf auf der Kommandozeile
|
||||
erstellt werden:
|
||||
|
||||
make meinartikel.html
|
||||
make meinartikel.pdf
|
||||
|
||||
# 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
|
||||
|
||||
Die HTML-Version ist bislang noch nicht angepasst und die DOCX-Version enthält
|
||||
(absichtlich) keine Metadaten sondern nur den Artikelinhalt.
|
||||
|
||||
|
|
|
|||
|
|
@ -37,26 +37,58 @@ $endfor$
|
|||
$for(include-before)$
|
||||
$include-before$
|
||||
$endfor$
|
||||
$if(title)$
|
||||
|
||||
<header>
|
||||
<div class="author">
|
||||
<b>$for(author)$$author.name$$sep$, $endfor$</b>
|
||||
</div>
|
||||
<h1 class="title">$title$</h1>
|
||||
$if(subtitle)$
|
||||
<h1 class="subtitle">$subtitle$</h1>
|
||||
$endif$
|
||||
$for(author)$
|
||||
<h2 class="author">$author$</h2>
|
||||
$endfor$
|
||||
$if(date)$
|
||||
<h3 class="date">$date$</h3>
|
||||
$endif$
|
||||
<h2 class="abstract">Zusammenfassung</h2>
|
||||
<p>$abstract$</p>
|
||||
<h3 class="keywords">Schlüsselwörter</h3>
|
||||
<p>$for(keywords)$$keywords$$sep$, $endfor$</p>
|
||||
|
||||
<h2>$title-en$</h2>
|
||||
<h3 class="abstract">Abstract</h3>
|
||||
<p>$abstract-en$</p>
|
||||
|
||||
<h3>Keywords</h3>
|
||||
<p>$for(keywords-en)$$keywords-en$$sep$, $endfor$</p>
|
||||
|
||||
<h3>Classification</h3>
|
||||
<p>$for(jita)$$jita$$sep$, $endfor$</p>
|
||||
|
||||
<hr>
|
||||
<p>
|
||||
<b>Einreichung / Annahme / Veröffentlichung:</b>
|
||||
$received$ / $accepted$ / $published$
|
||||
</p>
|
||||
|
||||
</header>
|
||||
$endif$
|
||||
|
||||
$if(toc)$
|
||||
<nav id="$idprefix$TOC">
|
||||
$toc$
|
||||
</nav>
|
||||
$endif$
|
||||
$body$
|
||||
|
||||
<h2>AutorInnen</h2>
|
||||
<ul>
|
||||
$for(author)$
|
||||
<li>
|
||||
<div>$author.name$$if(author.email)$, $author.email$$endif$</div>
|
||||
<div>
|
||||
$if(author.affiliation)$$author.affiliation$$if(author.address)$, $endif$$endif$$if(author.address)$$author.address$$endif$
|
||||
</div>
|
||||
$if(author.url)$<div><a href="$author.url$">$author.url$</a></div>$endif$
|
||||
|
||||
<!-- TODO: author.orcid oder gnd -->
|
||||
|
||||
</li>
|
||||
$endfor$
|
||||
</ul>
|
||||
|
||||
$for(include-after)$
|
||||
$include-after$
|
||||
$endfor$
|
||||
|
|
|
|||
|
|
@ -0,0 +1,156 @@
|
|||
<!DOCTYPE html>
|
||||
<html>
|
||||
<head>
|
||||
<meta charset="utf-8">
|
||||
<meta name="generator" content="pandoc">
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1.0, user-scalable=yes">
|
||||
<title>Deutscher Titel</title>
|
||||
<style type="text/css">code{white-space: pre;}</style>
|
||||
<!--[if lt IE 9]>
|
||||
<script src="http://html5shim.googlecode.com/svn/trunk/html5.js"></script>
|
||||
<![endif]-->
|
||||
</head>
|
||||
<body>
|
||||
|
||||
<header>
|
||||
<div class="author">
|
||||
<b>Vorname Nachname, Vorname Nachname</b>
|
||||
</div>
|
||||
<h1 class="title">Deutscher Titel</h1>
|
||||
<h2 class="abstract">Zusammenfassung</h2>
|
||||
<p>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.</p>
|
||||
<h3 class="keywords">Schlüsselwörter</h3>
|
||||
<p>Schlüsselwort 1, Schlüsselwort 2, Schlüsselwort 3, …</p>
|
||||
|
||||
<h2>English title</h2>
|
||||
<h3 class="abstract">Abstract</h3>
|
||||
<p>Every article must conatain an English abstract. The abstract is limited to one paragraph and up to 700 characters.</p>
|
||||
|
||||
<h3>Keywords</h3>
|
||||
<p>keyword 1, keyword 2, keyword 3, …</p>
|
||||
|
||||
<h3>Classification</h3>
|
||||
<p>A. Theoretische und allgemeine Aspekte von Bibliotheken und Informationen, GI. Weiterbildung</p>
|
||||
|
||||
<hr>
|
||||
<p>
|
||||
<b>Einreichung / Annahme / Veröffentlichung:</b>
|
||||
6.10.2014 / 12.11.2014 / 3.12.2014
|
||||
</p>
|
||||
|
||||
</header>
|
||||
|
||||
<h2 id="einleitung">1. Einleitung</h2>
|
||||
<p>Diese Vorlage ist <strong>nicht aktuell</strong> und dient lediglich als Platzhalter!</p>
|
||||
<p>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.</p>
|
||||
<figure>
|
||||
<img src="images/image01.png" />
|
||||
</figure>
|
||||
<p>Abb. 1: Titel Abbildung 1 (normale Option)</p>
|
||||
<p>Siehe <a href="#einleitung">Einleitung</a></p>
|
||||
<h2 id="überschrift-1.-ebene" class="c0 c19">2 Überschrift 1. Ebene</h2>
|
||||
<p>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</p>
|
||||
<p>Abb. 2: Titel Abbildung 2 (Option für breite Abbildungen)</p>
|
||||
<p>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.</p>
|
||||
<h2 id="überschrift-2.-ebene" class="c0 c22">2.1 Überschrift 2. Ebene</h2>
|
||||
<p>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.<a href="#fn1" class="footnoteRef" id="fnref1"><sup>1</sup></a></p>
|
||||
<h2 id="überschrift-2.-ebene-1" class="c0 c22">2.2 Überschrift 2. Ebene</h2>
|
||||
<p>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.<a href="#fn2" class="footnoteRef" id="fnref2"><sup>2</sup></a> Verwenden Sie nicht die automatisierten Aufzählungen Ihres Textprogrammes. Aufzählungszeichen Minus Leerzeichen Text der Aufzählung.<br /> - Liste</p>
|
||||
<ul>
|
||||
<li><p>Liste</p></li>
|
||||
<li><p>Liste</p></li>
|
||||
</ul>
|
||||
<p>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.</p>
|
||||
<table>
|
||||
<caption>Wahllos eingegebene Zahlen und ein Minuszeichen</caption>
|
||||
<col style="width: 25%" /><col style="width: 25%" /><col style="width: 25%" /><col style="width: 25%" /><tbody>
|
||||
<tr class="odd">
|
||||
<td style="text-align: left;"><p>Spalte 1</p></td>
|
||||
<td style="text-align: left;"><p>Spalte 2</p></td>
|
||||
<td style="text-align: left;"><p>Spalte 3</p></td>
|
||||
<td style="text-align: left;"><p>Spalte 4</p></td>
|
||||
</tr>
|
||||
<tr class="even">
|
||||
<td style="text-align: left;"><p>Zeile 2</p></td>
|
||||
<td style="text-align: left;"><p>123,45</p></td>
|
||||
<td style="text-align: left;"><p>17,2</p></td>
|
||||
<td style="text-align: left;"><p>1232,23</p></td>
|
||||
</tr>
|
||||
<tr class="odd">
|
||||
<td style="text-align: left;"><p>Zeile 3</p></td>
|
||||
<td style="text-align: left;"><p>56,78</p></td>
|
||||
<td style="text-align: left;"><p>–</p></td>
|
||||
<td style="text-align: left;"><p>189,9</p></td>
|
||||
</tr>
|
||||
<tr class="even">
|
||||
<td style="text-align: left;"><p>Zeile 4</p></td>
|
||||
<td style="text-align: left;"><p>198</p></td>
|
||||
<td style="text-align: left;"><p>67,325</p></td>
|
||||
<td style="text-align: left;"><p>789567,03</p></td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<h3 id="listen">2.2 Listen</h3>
|
||||
<p>Verwenden Sie nicht die automatisierten Aufzählungen Ihres Textprogrammes. Einfache Listen: Minus Leerzeichen Text der Aufzählung.</p>
|
||||
<ul>
|
||||
<li>Liste</li>
|
||||
<li>Liste</li>
|
||||
<li>Liste</li>
|
||||
</ul>
|
||||
<p>Nummerierte Listen: Nummer Punkt Leerzeichen Text der Aufzählung.</p>
|
||||
<ol type="1">
|
||||
<li><p>Nummerierte Liste</p></li>
|
||||
<li><p>Nummerierte Liste</p></li>
|
||||
<li><p>Nummerierte Liste</p></li>
|
||||
</ol>
|
||||
<h3 id="programmcode-und-datensätze">2.2.2 Programmcode und Datensätze</h3>
|
||||
<p>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”)!</p>
|
||||
<pre><code>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</code></pre>
|
||||
<p>Abb. 3: Ausschnitt aus einem MARC-Datensatz</p>
|
||||
<p>Umfangreichere Daten und Programme sollten in etablierten Forschunsgdaten- und/oder Code-Repositories verfügbar gemacht und im Artikel verlinkt werden.</p>
|
||||
<h2 id="quellen">3 Quellen</h2>
|
||||
<p>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/</p>
|
||||
<p>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</p>
|
||||
<p>Nachname, Vorname Vorn. (2013): Titel: Untertitel. Ort: Verlag.</p>
|
||||
<p>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.</p>
|
||||
<section class="footnotes">
|
||||
<hr />
|
||||
<ol>
|
||||
<li id="fn1"><p>Eine Fußnote. So wenige wie möglich verwenden<a href="#fnref1">↩</a></p></li>
|
||||
<li id="fn2"><p>Leider funktionieren bei Google keine Endnoten, aber das wäre unsere Empfehlung für die eingereichten Artikel<a href="#fnref2">↩</a></p></li>
|
||||
</ol>
|
||||
</section>
|
||||
|
||||
<h2>AutorInnen</h2>
|
||||
<ul>
|
||||
<li>
|
||||
<div>Vorname Nachname, vorname@email.tld</div>
|
||||
<div>
|
||||
|
||||
</div>
|
||||
<div><a href="http://example.org/">http://example.org/</a></div>
|
||||
|
||||
<!-- TODO: author.orcid oder gnd -->
|
||||
|
||||
</li>
|
||||
<li>
|
||||
<div>Vorname Nachname, vorname@email.tld</div>
|
||||
<div>
|
||||
Beispielorganisation, Beispielstraße 123, 00000 Dingshausen
|
||||
</div>
|
||||
|
||||
|
||||
<!-- TODO: author.orcid oder gnd -->
|
||||
|
||||
</li>
|
||||
</ul>
|
||||
|
||||
</body>
|
||||
</html>
|
||||
Binary file not shown.
Loading…
Reference in New Issue