diff --git a/README.md b/README.md index 4eb4d61..332144b 100644 --- a/README.md +++ b/README.md @@ -1,58 +1,126 @@ -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. +Dieses Repository enthält Vorlagen für Artikel der Fachzeitschrift [Informationspraxis](http://informationspraxis.de/) sowie Konfigurationsdateien zur Konvertierung der Artikel mit [Pandoc](https://pandoc.org) nach HTML, PDF und EPUB. -## Vorlage +## Vorlage für Beitragseinreichungen -Die Vorlage für Artikel besteht aus zwei Dateien: +* [vorlage-word.dotx](vorlage-word.dotx) zum Verfassen mit Word +* [vorlage-markdown.md](vorlage-markdown.md) zum Verfassen in Markdown-Syntax +* vorlage-libreoffice.ott zum Verfassen mit Libre/Open Office + - [ ] TODO: Vorlage für LibreOffice -* Die Datei **vorlage-metadaten.yml** für die Metadaten des Artikels (Titel, Autor/in, Abstract...) -* Eine der folgenden Dateien für den Artikeltext: - * **vorlage-markdown.md** zum Verfassen in Markdown-Syntax - * **vorlage-word.docx** zum Verfassen mit Word - * **vorlage-libreoffice.odt** zum Verfassen mit Libre/Open Offixe +## Redaktionsworkflow -## Redaktionelle Bearbeitung +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++. -1. Konvertierung des eingereichten Dokuments nach Markdown mit Hilfe von Pandoc: +### Beispiel - - von Format DOCX: +- AutorInnen + - Einreichung nach Word-Vorlage: [example/erstautorin-2019.docx](example/erstautorin-2019.docx) +- Redaktion + - Metadaten in YAML erfassen: [example/erstautorin-2019.yaml](example/erstautorin-2019.yaml) + - Markdown aus DOCX generiert und nachbearbeitet: [example/erstautorin-2019.yaml](example/erstautorin-2019.yaml) +- Pandoc + - HTML: [example/erstautorin-2019.html](example/erstautorin-2019.html) + - PDF: [example/erstautorin-2019.pdf](example/erstautorin-2019.pdf) + - EPUB: [example/erstautorin-2019.epub](example/erstautorin-2019.epub) - ``` - pandoc --extract-media . -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.odt - ``` - - - 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.) +### Installation -2. Erstellung einer YAML-Datei `erstautorin-yyyy-mm-dd.yml` für die Metadaten entsprechend der Vorlage `vorlage-metadaten.yml` +Windows, MacOS, Linux: -3. Bearbeitung der Markdown-Datei `erstautorin-yyyy-mm-dd.md` +* Pandoc installieren: https://pandoc.org/installing.html + * Pandoc benötigt LaTeX, siehe dazu den letzten Punkt der Pandoc Installationsanweisung. + * Unter Windows wird beispielsweise die (zusätzliche) Installation von [MiKTeX](https://miktex.org/howto/install-miktex) empfohlen. +* Markdown-Editor Typora installieren: https://typora.io/#download +* Vorlagen herunterladen: https://github.com/felixlohmeier/artikel-vorlage/archive/master.zip - - Titel, Abstract, Keywords, (Informationen über die) Autoren etc. - gehören *ausschließlich* in die YAML-Datei +Windows zusätzlich: - - Sichtprüfung der Formatierung und ggf. Korrekturen nach [Pandoc-Markdown-Syntax](http://pandoc.org/MANUAL.html#pandocs-markdown) +* Notepad++ installieren: https://notepad-plus-plus.org/download/ -## Konvertierung nach HTML, PDF und EPUB +### Redaktionelle Bearbeitung -1. Erstellung der HTML-Version +Der folgende Workflow wurde getestet am 6.6.2019 unter Windows mit: - ``` - pandoc -s --template pandoc-template.html -o erstautorin-yyyy-mm-dd.html erstautorin-yyyy-mm-dd.yml erstautorin-yyyy-mm-dd.md - ``` +* Pandoc 2.7.2 +* MiKTeX 2.9.7086 +* Typora 0.9.70 +* Notepad++ 7.7 -2. Erstellung der PDF-Version +#### Schritt 1: Erstellung einer YAML-Datei für die Metadaten - ``` - pandoc -s --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 erstautorin-yyyy-mm-dd.pdf erstautorin-yyyy-mm-dd.yml erstautorin-yyyy-mm-dd.md - ``` +Vorlagendatei `vorlage-metadaten.yml` in einem UTF-8-fähigen-Texteditor (z.B. Notepad++ unter Windows) öffnen, alle relevanten Daten ausfüllen und unter neuem Dateinamen speichern, hier im Beispiel `erstautorin-2019.yml`. -3. Erstellung der EPUB-Version +Der Abschnitt "von den AutorInnen vergebene Metadaten" kann ggf. per Copy & Paste aus dem von den AutorInnen eingereichten Dokument übernommen werden. + +![Metadaten in YAML](screenshots/metadaten.png) + +#### Schritt 2: Konvertierung des eingereichten Dokuments nach Markdown + +Öffnen Sie eine Kommandozeile (Windows: PowerShell, macOS/Linux: Terminal) und wechseln Sie in das Verzeichnis, in das Sie die Vorlagen heruntergeladen haben. + +Legen Sie das eingereichte Dokument ebenfalls in diesem Verzeichnis ab. In diesem Beispiel heißt die Quelldatei `erstautorin-2019.docx` + +![Konvertierung nach Markdown](screenshots/docx2md.png) + +* von Format Markdown + * keine Konvertierung notwendig, weiter mit Schritt 3 +* von Format DOC + * Datei in Word oder LibreOffice öffnen und als DOCX speichern + * Dann weiter mit Format DOCX + +- von Format DOCX (Beispiel für Quelldatei `erstautorin-2019.docx`) + +``` +pandoc --extract-media . --wrap=none -t markdown-simple_tables -o erstautorin-2019.md erstautorin-2019.docx +``` + +- von Format ODT (Beispiel für Quelldatei `erstautorin-2019.odt`) + +``` +pandoc --extract-media . --wrap=none -t markdown-simple_tables -o erstautorin-2019.md erstautorin-2019.odt +``` + +#### Schritt 3: Nachbearbeitung der Markdown-Datei + +Die im vorigen Schritt erstellte Markdown-Datei in einem Markdown-Editor (z.B. Typora unter Windows) öffnen und bereinigen. + +![Nachbearbeitung mit Typora](screenshots/typora.png) + +Folgende Nacharbeiten sind erforderlich: + +* Metadaten und Fragmente aus der Vorlage zu Beginn der Datei löschen. Der Text muss direkt mit der ersten Überschrift (z.B. `1 Einleitung`) beginnen. +* Prüfen, ob alle Bilder korrekt angezeigt werden. Größenangaben wie `{width="6.531496062992126in" height="2.263779527559055in"}` löschen. +* Bildunterschriften prüfen und ggf. vereinheitlichen. +* Wenn Listen kompakt dargestellt werden sollen, dann im Quellcode (Menü Darstellung / Quellcodemodus) leere Zeilen innerhalb der Aufzählungen entfernen. +* Ggf. weitere Formatierung gemäß der [Richtlinien](https://journals.ub.uni-heidelberg.de/index.php/ip/about/submissions) und nach [Pandoc-Markdown-Syntax](http://pandoc.org/MANUAL.html#pandocs-markdown) + +### HTML, PDF und EPUB generieren + +Zurück in der Kommandozeile die folgenden Befehle aufrufen, um die fertigen Dateien für OJS zu erstellen. + +![Konvertierung von Markdown nach HTML, PDF und EPUB](screenshots/md2html-pdf-epub.png) + +#### Schritt 4: Erstellung der HTML-Version + +``` +pandoc -s --toc --template pandoc-template.html -o erstautorin-2019.html erstautorin-2019.yml erstautorin-2019.md +``` + +Manuelle Nacharbeiten: + +* Mit Suchen & Ersetzen die Pfadangabe für Bilddateien anpassen, da OJS direkte Links auf Dateinamen der Bilddateien erwartet + * Suchen: `img src="./media/` + * Ersetzen: `img src="` + +#### Schritt 5: Erstellung der PDF-Version + +``` +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 erstautorin-2019.pdf erstautorin-2019.yml erstautorin-2019.md +``` + +#### Schritt 6: Erstellung der EPUB-Version + +``` +pandoc -s --toc -o erstautorin-2019.epub erstautorin-2019.yml erstautorin-2019.md +``` - ``` - pandoc -s -o erstautorin-yyyy-mm-dd.epub erstautorin-yyyy-mm-dd.yml erstautorin-yyyy-mm-dd.md - ``` diff --git a/example/erstautorin-2019.docx b/example/erstautorin-2019.docx new file mode 100644 index 0000000..9bb46b3 Binary files /dev/null and b/example/erstautorin-2019.docx differ diff --git a/example/erstautorin-2019.epub b/example/erstautorin-2019.epub new file mode 100644 index 0000000..1f6a35e Binary files /dev/null and b/example/erstautorin-2019.epub differ diff --git a/example/erstautorin-2019.html b/example/erstautorin-2019.html new file mode 100644 index 0000000..dab98be --- /dev/null +++ b/example/erstautorin-2019.html @@ -0,0 +1,182 @@ + + + + + + + + Deutscher Titel + + + + +
+

DOI: https://doi.org/10.11588/ip.2019.1.52673

+

Vorname NACHNAME, Vorname NACHNAME

+

Deutscher Titel

+

Zusammenfassung

+

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 wichtigsten 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.

+

Schlüsselwörter

+

Schlüsselwort 1, Schlüsselwort 2, Schlüsselwort 3 (max 5)

+ +

English title

+

Abstract

+

Every article must contain an English abstract. The abstract is limited to one paragraph and up to 700 characters.

+

Keywords

+

keyword 1, keyword 2, keyword 3 (max 5)

+ + +
+

Veröffentlichung: 10.03.2019 in Informationspraxis Bd. 5, Nr. 1 (2019)

+
+ +
+ +

Inhaltsverzeichnis

+ +

1 Einleitung (Überschrift 1. Ebene)

+

Titel, Zusammenfassung, Schlüsselwörter und Angaben zu den AutorInnen (alles in deutsch und englisch) bitte ausschließlich im Formular auf der vorherigen Seite. Bitte kein Inhaltsverzeichnis erstellen, das wird von der Redaktion automatisch generiert. Kurze, prägnante Überschriften verfassen und bitte keine (durchgängige) Großschreibung verwenden.

+

Wir empfehlen für Kurzbeiträge eine Länge bis etwa 12.000 Zeichen und für Fachbeiträge eine Länge bis etwa 40.000 Zeichen.

+

Alle Beiträge erscheinen unter der Lizenz Creative Commons Namensnennung 4.0. Die AutorInnen treten darüber hinaus keine Rechte an Informationspraxis ab.

+

2 Abbildungen

+

Abbildungen bitte als Bilddatei einfügen und nicht weiter formatieren. Abbildungen bitte mit Bildunterschriften versehen in der Form „Abb. 1: …" und durchnummerieren.

+

+

Abb. 1: Titel Abbildung 1

+

2.1 Zitate (Überschrift 2. Ebene)

+

Kurze Zitate im Fließtext. „Ein wörtliches Zitat soll sehr sparsam eingesetzt werden." (NAME, Vorname & NAME, 2014).

+

Längere Zitate einrücken:

+
+

„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." (NAME, Vorname & NAME, 2014)

+
+

2.2 Sparsame Formatierung

+

Hervorhebungen (kursiv, fett) sparsam einsetzen.

+

Als weitere Formatierungen sind hochgestellt, tiefgestellt und durchgestrichen möglich.

+

Verwenden Sie Fuß-1 oder Endnoten2 allenfalls für notwendige Anmerkungen.

+

2.2.1 Tabellen (Überschrift 3. Ebene)

+

Einfache Tabellen ohne weitere Formatierungen können hier erstellt werden. Komplex formatierte Tabellen bitte als Bilddatei einfügen. Alle Tabellen bitte mit einer Bildunterschrift in der Form „Tabelle 1: …" versehen und durchnummerieren.

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Spalte 1Spalte 2Spalte 3Spalte 4
Zeile 2123,4517,21232,23
Zeile 356,78-189,9
Zeile 419867,325789567,03
+

Tabelle 1: Zahlen und ein Minuszeichen

+

2.2.2 Listen

+

Einfache Listen werden unterstützt (spezielle Aufzählungszeichen werden ignoriert)

+ +

Nummerierte Listen werden ebenfalls unterstützt (wird im Layout jedoch immer zu 1,2,3 etc., unabhängig von der gewählten Form der Nummerierung)

+
    +
  1. Punkt 1 +
      +
    1. Punkt 1.1
    2. +
    3. Punkt 1.2
    4. +
  2. +
  3. Punkt 2
  4. +
+ +

Kurze und bedeutsame URLs können in den Fließtext aufgenommen werden: Zeitschrift Informationspraxis (http://informationspraxis.de)

+

Lange URLs als betitelte Links einfügen (und lieber nicht als Fußnote): Richtlinien für das Open Peer Review der Zeitschrift Informationspraxis

+

Querverweise im Dokument sind möglich, aber nur auf zuvor selbst erstellte Textmarken. Dazu zuerst an die gewünschte Textstelle wechseln und über die Funktion Textmarke eine Textmarke hinzufügen. Anschließend über die Funktion Link (STRG+K) und dann den Button Textmarke die erstellte Textmarke auswählen. Querverweise auf Überschriften werden nicht unterstützt. Beispiel für einen Querverweis: #Tabelle1

+

2.2.4 Code und Datensätze

+

Code 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.

+

Für Code-Abschnitte bitte immer die Formatvorlage Source Code verwenden, damit doppelte Leerzeichen usw. erhalten bleiben.

+
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. 2: Ausschnitt aus einem MARC-Datensatz

+

Umfangreichere Daten und Programme sollten in etablierten Forschungsdaten- und/oder Code-Repositories verfügbar gemacht und im Artikel verlinkt werden.

+

Die einer Veröffentlichung zugrunde liegenden Rohdaten sollten - sofern Urheberrecht und Datenschutz dem nicht im Wege stehen - unter der Lizenz CC-BY frei und öffentlich zur Verfügung stehen. Auf re3data.org finden AutorInnen eine große Auswahl an Repositories, auf denen Rohdaten veröffentlicht werden können. Informationspraxis empfiehlt die Nutzung von Zenodo.org. Hier ist eine Community Informationspraxis eingerichtet, in welche die Daten hochgeladen werden können.

+

Informationspraxis empfiehlt die Verwendung von Open-Source-Software. Wenn Sie quelloffene Software zur Verarbeitung von Daten nutzen, sollten Quellcode und Prozess so weit wie möglich nachvollziehbar gemacht werden (R-Skripte etc.). Der Quellcode zu verwendeter Software sollte ebenfalls möglichst offen zur Verfügung stehen.

+

3 Quellen

+

Wir empfehlen den Zitierstil Harvard nach GBFE (Gesellschaft für Bildung und Forschung in Europa; "Harvard author-date style with German Unisa / GBFE changes"). Der Stil befolgt folgende Grundsätze:

+ +

Christensen, Anne (29. Aug. 2012): Mentale Modelle: Die Brücke zwischen Discovery Tools und Informationskompetenz? [online]. Zugriff am: 10. Juli 2014. Verfügbar unter: http://xenzen.wordpress.com/2012/08/29/mentale-modelle-die-brucke-zwischen-discovery-tools-und-informationskompetenz/

+

Klee, Carsten (2013): Vokabulare für bibliographische Daten. Zwischen Dublin Core und bibliothekarischem Anspruch. In: Patrick Danowski und Adrian Pohl, Hg.: (Open) linked data in Bibliotheken. Berlin: de Gruyter Saur, S. 45-63. Verfügbar unter: https://doi.org/10.1515/9783110278736.45

+

Weinberger, David (2008): Das Ende der Schublade. Die Macht der neuen digitalen Unordnung. München: Hanser.

+
+
+
    +
  1. Eine Fußnote, möglichst wenig verwenden.

  2. +
  3. Eine Endnote, möglichst wenig verwenden.

  4. +
+
+ +
+ +

AutorInnen

+ + + + diff --git a/example/erstautorin-2019.md b/example/erstautorin-2019.md new file mode 100644 index 0000000..e73cba3 --- /dev/null +++ b/example/erstautorin-2019.md @@ -0,0 +1,118 @@ +1 Einleitung (Überschrift 1. Ebene) +=================================== + +Titel, Zusammenfassung, Schlüsselwörter und Angaben zu den AutorInnen (alles in deutsch und englisch) bitte ausschließlich im Formular auf der vorherigen Seite. Bitte kein Inhaltsverzeichnis erstellen, das wird von der Redaktion automatisch generiert. Kurze, prägnante Überschriften verfassen und bitte keine (durchgängige) Großschreibung verwenden. + +Wir empfehlen für Kurzbeiträge eine Länge bis etwa 12.000 Zeichen und für Fachbeiträge eine Länge bis etwa 40.000 Zeichen. + +Alle Beiträge erscheinen unter der Lizenz Creative Commons Namensnennung 4.0. Die AutorInnen treten darüber hinaus keine Rechte an Informationspraxis ab. + +2 Abbildungen +============= + +Abbildungen bitte als Bilddatei einfügen und nicht weiter formatieren. Abbildungen bitte mit Bildunterschriften versehen in der Form „Abb. 1: ..." und durchnummerieren. + +![](./media/image1.png) + +Abb. 1: Titel Abbildung 1 + +2.1 Zitate (Überschrift 2. Ebene) +--------------------------------- + +Kurze Zitate im Fließtext. „Ein wörtliches Zitat soll sehr sparsam eingesetzt werden." (NAME, Vorname & NAME, 2014). + +Längere Zitate einrücken: + +> „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." (NAME, Vorname & NAME, 2014) + +2.2 Sparsame Formatierung +------------------------- + +Hervorhebungen (*kursiv*, **fett**) sparsam einsetzen. + +Als weitere Formatierungen sind ^hochgestellt^, ~tiefgestellt~ und ~~durchgestrichen~~ möglich. + +Verwenden Sie Fuß-[^1] oder Endnoten[^2] allenfalls für notwendige Anmerkungen. + +### 2.2.1 Tabellen (Überschrift 3. Ebene) + +[]{#Tabelle1 .anchor}Einfache Tabellen ohne weitere Formatierungen können hier erstellt werden. Komplex formatierte Tabellen bitte als Bilddatei einfügen. Alle Tabellen bitte mit einer Bildunterschrift in der Form „Tabelle 1: ..." versehen und durchnummerieren. + +| 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 | + +Tabelle 1: Zahlen und ein Minuszeichen + +### 2.2.2 Listen + +Einfache Listen werden unterstützt (spezielle Aufzählungszeichen werden ignoriert) + +- Ein Stichpunkt + - Ein Stichpunkt auf zweiter Ebene + - Ein weiterer Stichpunkt auf zweiter Ebene +- Ein weiterer Stichpunkt + +Nummerierte Listen werden ebenfalls unterstützt (wird im Layout jedoch immer zu 1,2,3 etc., unabhängig von der gewählten Form der Nummerierung) + +1. Punkt 1 + a. Punkt 1.1 + b. Punkt 1.2 +2. Punkt 2 + +### 2.2.3 Links + +Kurze und bedeutsame URLs können in den Fließtext aufgenommen werden: Zeitschrift Informationspraxis () + +Lange URLs als betitelte Links einfügen (und lieber nicht als Fußnote): [Richtlinien für das Open Peer Review der Zeitschrift Informationspraxis](http://informationspraxis.de/zeitschrift-informationspraxis/richtlinien-fuer-das-open-peer-review/) + +Querverweise im Dokument sind möglich, aber nur auf zuvor selbst erstellte Textmarken. Dazu zuerst an die gewünschte Textstelle wechseln und über die Funktion Textmarke eine Textmarke hinzufügen. Anschließend über die Funktion Link (STRG+K) und dann den Button Textmarke die erstellte Textmarke auswählen. Querverweise auf Überschriften werden nicht unterstützt. Beispiel für einen Querverweis: [\#Tabelle1](#Tabelle1) + +### 2.2.4 Code und Datensätze + +Code 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. + +Für Code-Abschnitte bitte immer die Formatvorlage Source Code verwenden, damit doppelte Leerzeichen usw. erhalten bleiben. + + 240 10 _aLiving my life + 245 10 _aGelebtes Leben + _bAutobiografie + _cEmma Goldman. Mit einem Vorw. von Ilija Trojanow. + 250 _aErstausg., 1. Aufl. + 260 3 _aHamburg + _bEd. Nautilus + _c2010 + +Abb. 2: Ausschnitt aus einem MARC-Datensatz + +Umfangreichere Daten und Programme sollten in etablierten Forschungsdaten- und/oder Code-Repositories verfügbar gemacht und im Artikel verlinkt werden. + +Die einer Veröffentlichung zugrunde liegenden Rohdaten sollten - sofern Urheberrecht und Datenschutz dem nicht im Wege stehen - unter der Lizenz CC-BY frei und öffentlich zur Verfügung stehen. Auf re3data.org finden AutorInnen eine große Auswahl an Repositories, auf denen Rohdaten veröffentlicht werden können. Informationspraxis empfiehlt die Nutzung von Zenodo.org. Hier ist eine [Community Informationspraxis](https://zenodo.org/collection/user-informationspraxis) eingerichtet, in welche die Daten hochgeladen werden können. + +Informationspraxis empfiehlt die Verwendung von Open-Source-Software. Wenn Sie quelloffene Software zur Verarbeitung von Daten nutzen, sollten Quellcode und Prozess so weit wie möglich nachvollziehbar gemacht werden (R-Skripte etc.). Der Quellcode zu verwendeter Software sollte ebenfalls möglichst offen zur Verfügung stehen. + +3 Quellen +========= + +Wir empfehlen den Zitierstil [Harvard nach GBFE](http://editor.citationstyles.org/styleInfo/?styleId=http%3A%2F%2Fwww.zotero.org%2Fstyles%2Fharvard-gesellschaft-fur-bildung-und-forschung-in-europa) (Gesellschaft für Bildung und Forschung in Europa; \"Harvard author-date style with German Unisa / GBFE changes\"). Der Stil befolgt folgende Grundsätze: + +- Author-Date Format +- Journal-Namen nicht abgekürzt +- Vorname nicht abgekürzt +- Im Literaturverzeichnis: Nachname, Vorname, und das auch für die/den weitere/n AutorInnen +- Keine Kapitälchen oder durchgehende Großschreibung für egal was +- URL wird genannt +- Name des Journals / übergeordneten Werkes kursiv gesetzt +- ansonsten möglichst einfache Typographie, möglichst nichts anderes kursiv und überhaupt nichts fett, unterstrichen etc. + +Christensen, Anne (29. Aug. 2012): Mentale Modelle: Die Brücke zwischen Discovery Tools und Informationskompetenz? \[online\]. Zugriff am: 10. Juli 2014. Verfügbar unter: + +Klee, Carsten (2013): Vokabulare für bibliographische Daten. Zwischen Dublin Core und bibliothekarischem Anspruch. In: Patrick Danowski und Adrian Pohl, Hg.: (Open) linked data in Bibliotheken. Berlin: de Gruyter Saur, S. 45-63. Verfügbar unter: + +Weinberger, David (2008): Das Ende der Schublade. Die Macht der neuen digitalen Unordnung. München: Hanser. + +[^1]: Eine Fußnote, möglichst wenig verwenden. + +[^2]: Eine Endnote, möglichst wenig verwenden. diff --git a/example/erstautorin-2019.pdf b/example/erstautorin-2019.pdf new file mode 100644 index 0000000..52328bb Binary files /dev/null and b/example/erstautorin-2019.pdf differ diff --git a/example/erstautorin-2019.yml b/example/erstautorin-2019.yml new file mode 100644 index 0000000..213b886 --- /dev/null +++ b/example/erstautorin-2019.yml @@ -0,0 +1,39 @@ +--- +# Von den AutorInnen vergebene Metadaten +title: Deutscher Titel +title-en: English title +author: Vorname NACHNAME, Vorname NACHNAME +author-detail: + - name: Vorname Nachname + email: name@beispiel.de + url: http://example.org + orcid: 0000-0000-0000-0001 + - name: Vorname Nachname + email: name@beispiel.de + affiliation: Beispielorganisation + address: Beispielstraße 123, 00000 Dingshausen +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 wichtigsten 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 contain 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 (max 5) +keywords-en: + - keyword 1 + - keyword 2 + - keyword 3 (max 5) + +# Von der Redaktion vergebene Metadaten +author-short: Nachname/Nachname +title-short: Kurztitel +category: Fachbeitrag +date: 10.03.2019 +received: 10.03.2019 +accepted: 10.03.2019 +identifier: 10.11588/ip.2019.1.52673 +publisher: Informationspraxis Bd. 5, Nr. 1 (2019) +lang: de +rights: CC-BY 4.0 +... diff --git a/example/media/image1.png b/example/media/image1.png new file mode 100644 index 0000000..deef803 Binary files /dev/null and b/example/media/image1.png differ diff --git a/screenshots/docx2md.png b/screenshots/docx2md.png new file mode 100644 index 0000000..92bf78b Binary files /dev/null and b/screenshots/docx2md.png differ diff --git a/screenshots/md2html-pdf-epub.png b/screenshots/md2html-pdf-epub.png new file mode 100644 index 0000000..b358b24 Binary files /dev/null and b/screenshots/md2html-pdf-epub.png differ diff --git a/screenshots/metadaten.png b/screenshots/metadaten.png new file mode 100644 index 0000000..dd1a3e2 Binary files /dev/null and b/screenshots/metadaten.png differ diff --git a/screenshots/typora.png b/screenshots/typora.png new file mode 100644 index 0000000..4025ef3 Binary files /dev/null and b/screenshots/typora.png differ