myCsrf » FODINA

myCrsf

mind your Classical Scholar Research Framework ist eine LaTeX / BibTeX / JabRef basierte Sammlung von Dateien und Skripten, die den ganzen Prozess des Schreibens geisteswissenschaftlicher Texte unterstützen – einschließlich der Suche und Evaluation von Sekundärliteratur, der Pflege bibliographischer Daten, der Erzeugung von Exzerpten und der Erstellung der eigentlichen Arbeit. Und all dies soll den (alt-) philologischen Arbeits- und Darstellungsstil berücksichtigen.

Zunächst brauchte ich diesen leicht altmodischen Präsentationsstil für einige wissenschaftliche psikeds-Dokumente. Aber während seiner Genese gewann das ‚Framework‘ ein zunehmendes Eigenleben. So kam die Zeit, ihm einen eigenen Namen und eine Github-Repository zu spendieren.

Ziele

Als Sammlung von vorbereiteten und fertig konfigurierten Dateien, die den ganzen Prozess des Schreibens geisteswissenschaftlicher Texte unterstützt, liefert myCsrf einen vollständigen Satz von BibTex-, LaTeX- und Makefiles zur

Suche und Evaluation von Sekundärliteratur,
Pflege bibliographischer Daten,
Erzeugung von ‚Abstracts‘ und Exzerpten
Erstellung der eigentlichen Arbeit.

Das herausragende Merkmal vom mykCsrf ist seine Art, Zitatbelege über Fuß- oder Endnoten zu präsentieren, die weitestgehend dem (alt-) philologischen Standard folgen.

Beispiele

myCrsf enthält zu Demonstrationszwecken einen Text über das Wie und Wozu (alt-) philologischer Forschungstexte, und zwar in 4 Ausformungen:

classicalScholarFoNoDe.pdf :- vollausgearbeiteter, deutschsprachiger, selbsterklärender Text mit Anmerkungen als Fußnoten
classicalScholarFoNoEn.pdf :- kurze englisch-sprachige Demonstration mit Anmerkungen als Fußnoten
humanitiesEnNoDe.pdf :- vollausgearbeiteter, deutschsprachiger, selbsterklärender Text mit Anmerkungen als Endnoten
humanitiesEnNoDe.pdf :- kurze englisch-sprachige Demonstration mit Anmerkungen als Endnoten

Installation

Die notwendige Voraussetzungen:

Sie müssen entweder ein GNU–Linux System haben, das make, ghostscript, ps2pdf, einen pdf viewer, die bash und ein komplettes LaTeX system mitbringt. Oder Sie nutzen ein MS-Window -System mit installiertem MikTeX und Texmaker
Ihr LaTeX-System muss Koma Script, jurabib und BibTeX enthalten.
Für das Editieren der LaTeX-Dateien können Sie eclipse mit dem plugin Texlipse, winefish oder sogar den vi nutzen.
Zur Pflege der Bib-Dateien empfiehlt sich JabRef.
Html-Versionen ihrer Literaturdateien erzeugen Sie z.B. via TeX4ht.

Die myCsrf-Download-Urls:

Packen Sie nach dem Herunterladen das Paket einfach da aus, wo es sie es abgelegt haben wollen. Der oberste Ordner kann beliebig umbenannt werden. Um mit dem Schreiben eigener Werke zu beginnen, lesen Sie einfach das myCsrf-Readme. Es erklärt die Nutzung und Konfiguration des Systems im Detail.

Anwendung

Einen tieferen Einblick in die Arbeit mit myCsrf liefert die mycsrf Readme file. Rufen Sie make README.pdf im Projektordner auf, um eine lokale Version davon zu erzeugen. Hier ein erster grober Eindruck:

Verwenden Sie jabref und eine der vorbereiteten Bib-Dateien zur Verwaltung Ihrer Sekundärliteratur:
- mycsrfResourcesDe.bib sollte verifizierte bibliographischen Angaben mit deutschsprachigen BibTex ‚annote’s enthalten.
- mycsrfResourcesEn.bib sollte verifizierte bibliographischen Angaben mit englischsprachigen BibTex ‚annote’s enthalten.
- mycsrfNextActions.bib sollte Daten enthalten, die noch verifiziert werden müssen.
- mycsrfSomedayMaybe.bib könnte jenen Daten aufnehmen, die vielleicht erst später wichtig werden.
Um jabref zu konfigurieren, importieren Sie btexmat/myScholarJabrefPrefs.xml über den jabref-Menue-Eintrag ‚preferences‘.
Um Ihre eingegeben bibliographischen Daten Korrektur zu lesen, lassen Sie sich die entsprechende Literaturliste kompilieren, die unter btexmat bereitliegt:
- mycsrfBibRevResourcesDe.tex (mycsrfBibRevNextActionDe.tex) listet alle Einträge von mycsrfResourcesDe.bib (mycsrfNextActions.bib) mit deutschen Abkürzung auf.
- mycsrfBibRevResourcesEn.tex (mycsrfBibRevNextActionEn.tex) listet alle Einträge von mycsrfResourcesEn.bib mit deutschen Abkürzung auf.
Um sich eigenständige LaTeX-Dokumente wie ${NAME}.tex als dvi- oder pdf-Datei generieren zu lassen, öffnen Sie eine Bash, wechseln Sie in den Ordner, der die Datei enthält und geben Sie den Befehl make ${NAME}.dvi oder make ${NAME}.pdf ein.
Um die dabei entstandenen Hilfsdateien wieder zu entfernen, tippen Sie make clean ein. Im Hauptordner steht Ihnen auch das Kommando make dclean zur Verfügung: es löscht auch alle Hilfsdateien in allen Unterordnern.
Um Exzerpte und Zusammenfassung zu erzeugen, kopieren Sie die Datei templates/mycsrfExtractTplEn.tex in den Ordner extracts, benennen Sie sie um (am Besten entsprechend des Bibkeys des zu exzerpierenden Werkes), öffnen Sie Eclipse/Texlipse, Winefish, Texmaker oder vi und beginnen Sie mit Ihrer Arbeit
Um ein in Ihr Hauptforschungspapier inkludierbares Snippet zu erzeugen, öffnen Sie eine Bash, wechseln Sie in den snippet-Ordner, kopieren Sie die Datei mycsrfSnippetInc.tex und benennen Sie sie um, öffnen Sie Eclipse/Texlipse, Winefish, Texmaker oder vi und beginnen Sie mit Ihrer Arbeit. Wenn Sie Ihren Text genieren lassen wollen, inkludieren Sie das Snipptet in Ihre Hauptdatei oder in die Datei snippets/mycsrfSnippetFrame.tex, bevor Sie das jeweilige Rahmendokument kompilieren lassen.
Sie können mycsrf.tex frei umbenennen, wenn Sie ein Forschungsdokument haben möchten, das als Datei nach Ihrem Projekt benannt ist.

Lizenz

Alle Dateien von myCsrf sind unter der Creative Commons Attribution 3.0 Germany License lizenziert: Sie dürfen das Werk vervielfältigen, verbreiten und öffentlich zugänglich machen Abwandlungen und Bearbeitungen des Werkes bzw. Inhaltes anfertigen und das Werk kommerziell nutzen, sofern Sie den Namen des Autors/Rechteinhabers in der von ihm festgelegten Weise nennen:

In einer Internet basierten Wiederverwendung verlinken Sie die verwendeten Teile bitte auf fodina.de/mycsrf und erwähnen Sie den Originalautor in einer angemessenen Weise. In einer Papier basierten Wiederverwendung fügen Sie bitte einen kurzen Hinweis auf fodina.de/mycsrf und den Autor Karsten Reincke in Ihr Vorwort ein. Bei normalen Zitaten verwenden Sie bitte den wissenschaftlichen Standard.