search

hbz / lobid

Linking Open Bibliographic Data
https://lobid.org/
Eclipse Public License 2.0
16 stars 4 forks source link

Write lobid reference article for Infoprax #378

Closed acka47 closed 6 years ago

acka47 commented 6 years ago

I talked to @hauschke and decided that it would be best to write a "reference article" about lobid. We can easily take parts for the text from our blog.

How will we write this? I think it went quite well on GitHub with the Libreas article some time ago, didn't it?

fsteeg commented 6 years ago

We can easily take parts for the text from our blog.

Some relevant content from the blog:

I guess the article will be in German, right? So we'll have to translate the first half of the content.

How will we write this? I think it went quite well on GitHub with the Libreas article [...]

Yes, I agree. I suggest we set up a single *.md file to merge the blog content as a first step.

fsteeg commented 6 years ago

Joined the mentioned blog posts into a single file, no content changes, just updated the header levels:

https://github.com/hbz/lobid/blob/infoprax/doc/lobid.md

We can use this as a baseline for edits and diffs.

fsteeg commented 6 years ago

Ich habe die Struktur etwas überarbeitet und ein übersetztes TOC mit 2 Ebenen angelegt:

https://github.com/hbz/lobid/blob/infoprax/doc/lobid.md

So in etwa könnte die Gesamtstruktur aussehen. Ich würde dann Donnerstag hier weitermachen.

fsteeg commented 6 years ago

Der Inhalt unter https://github.com/hbz/lobid/blob/infoprax/doc/lobid.md ist jetzt komplett auf deutsch.

@acka47 Ich schlage vor, du liest dir das mal durch und dann überlegen wir zusammen, wie wir die Inhalte sinnvoll gliedern können. Ich denke vom Inhalt und Umfang ist das schon ganz gut so.

acka47 commented 6 years ago

Ich habe heute den ersten Abschnitt ("Überblick") gelesen und einige Änderungen committed (siehe diff). Außerdem habe ich hier einige Kommentare als hypothes.is-Annotationen ergänzt.

Von der Gliederung her ist der Text ja in den ersten beiden Abschnitten sehr technikbezogen. Ich finde das in Ordnung, allerdings sollten wir in einer Einleitung die Gründe für die Gliederung darlegen und vor allem in wenigen Worten deutlich machen, warum lobid überhaupt entwickelt wird, wer die Zielgruppe ist und was dieser mit lobid geboten wird.

acka47 commented 6 years ago

I am done for now, having worked through the whole text, rearranged it a bit and referencing LOUD. (we will have to add ano0ther LOUD reference in the documentation bit though.) @fsteeg , übernehmen Sie.

fsteeg commented 6 years ago

Bin nochmal den ganzen Text durchgegangen und habe Sachen gefixt und hier und da etwas ergänzt und die Überschriften-Struktur angepasst. Das TOC habe ich nochmal neu mit 2 Ebenen generiert, ich finde so sieht man gut die Gesamtstruktur. Ich bin insgesamt zufrieden so.

https://github.com/hbz/lobid/blob/infoprax/doc/lobid.md

Der verbleibende größere Schritt ist dann wohl, das in die Formatvorlage zu bekommen.

https://journals.ub.uni-heidelberg.de/index.php/ip/about/submissions

acka47 commented 6 years ago

Zu ergänzen:

acka47 commented 6 years ago

Eine Konversion des Markdowns nach docx mit pandoc (pandoc lobid.md -f markdown -t docx -s -o lobid.docx) sieht im Ergebnis bereits ganz gut aus. Folgende Dinge sind aber am Ende noch anzupassen:

acka47 commented 6 years ago

Nach der Konversion nach doc umfasst der Text 40 Seiten. Das finde ich schon sehr lang. Wir könnte wahrscheinlich leicht zwei Texte draus machen, einen zu lobid allgemein und einen zu lobid-gnd (ab "Fallstudie"). Können wir dann nächste Woche ja mal untereinander und – falls nötig – mit der Infopraxm-Redaktion besprechen.

acka47 commented 6 years ago

Infoprax-Empfehlung für die maximale Länge eines Fachbeitrags sind übrigens 24.000 Zeichen. Wir haben etwa 58.000...

fsteeg commented 6 years ago

Referenzen für zentrale lobid repos (gnd, organisations, resources) mit Zenodo Snapshot (siehe https://guides.github.com/activities/citable-code/)

Ich habe das in Zenodo soweit eingerichtet. Ich schlage vor, ich erzeuge dann die eigentlichen Releases wenn wir die aktuellen Anpassungen der Datenset-Beschreibungen deployed haben, die ja alle 3 Dienste betreffen.

Infoprax-Empfehlung für die maximale Länge eines Fachbeitrags sind übrigens 24.000 Zeichen. Wir haben etwa 58.000

Dann passt doch die von dir vorgeschlagene Aufteilung in zwei Artikel sehr gut.

hauschke commented 6 years ago

Zwei Artikel sind m.E. in Ordnung, wenn die inhaltliche Aufteilung Sinn ergibt.

acka47 commented 6 years ago

@hauschke Es ergibt auf jeden Fall Sinn, bin gerade schon am aufteilen.

fsteeg commented 6 years ago

Created snapshots for Zenodo:

https://doi.org/10.5281/zenodo.1423188 (gnd) https://doi.org/10.5281/zenodo.1423192 (organisations) https://doi.org/10.5281/zenodo.1423194 (resources)

fsteeg commented 6 years ago

Habe beide Artikel überarbeitet:

https://github.com/hbz/lobid/blob/infoprax/doc/lobid.md https://github.com/hbz/lobid/blob/infoprax/doc/lobid-gnd.md

acka47 commented 6 years ago

Sehr gut. Blöderweise kann ich gerade nicht mehr die Dateien nach doc(x) überführen, ohne dass die Bilder alle zu groß sind. Probiere am Montag weiter.

acka47 commented 6 years ago

Beide Artikel gingen heute an das hbz-Marketing zur Abnahme/zum Korrekturlesen.