Methods-Berlin / RLernplattform

https://methods-berlin.github.io/RLernplattform/
1 stars 3 forks source link

Vereinheitlichen der Formatierung #21

Closed jhorzek closed 1 year ago

jhorzek commented 1 year ago

Wir haben gerade sehr viele unterschiedliche Formatierungen im Fließtext:

Hier gibt es sicherlich ein System, aber ich bin gerade nicht sicher, ob das irgendwo dokumentiert ist. Ich denke, wir sollten für die neuen Seiten ein Übersichtsdokument erstellen, wann welche Formatierung genutzt wird. Beispielsweise könnten weniger relevante Aspekte immer in die Footnotes. Sehr relevante Begriffe könnten wir grün einfärben. Bold und Kursiv könnten wir für die Überschriften vorbehalten. Wenn jemand Lust hat, ein einheitliches Design zu entwerfen, darf sie/er sich gerne selbst zuordnen.

vs723 commented 1 year ago

Literaturverzeichnis einheitlich machen -> in Fehlende Werte ist es vor dem Hinweis auf die Replizierbarkeit von Analysen, ansonsten immer als aller letztes

jhorzek commented 1 year ago

Super! Wenn Du willst, kannst Du das direkt anpassen. Für solche einzelnen Punkte kannst Du auch gerne neue issues erstellen und diese dann wieder schließen, sobald sie bearbeitet wurden.

manuelarnold commented 1 year ago

Meiner Meinung nach könnten wir uns von den meisten Formatierungen im Fließtext trennen. Da in jedem Absatz ein paar Wörter hervorgehoben sind, verliert die Hervorhebung schnell an Wirkung. Weniger ist da manchmal mehr. Besonders unterschiedliche Schriftgrößen finde ich nicht besonders toll. Asides finde ich eigentlich prima, wenn man damit eine kurze Definition eines Fachbegriffs zwischenschiebt. Das benutzen ja auch viele Lehrbücher. Bei dem ausklappbaren Text bin ich hin- und hergerissen. Was mich daran stört, ist, dass ich jedes Mal klicken muss um nachzuschauen, ob ich den Text lesen muss oder nicht. Das macht auch alles nicht einfacher. Daher würde ich lange Beispiele einfach mit einer Box oder so markieren.

Zusammengefasst wären das meine Vorschläge:

jhorzek commented 1 year ago

Finde ich einen guten Ansatz! Ich würde das erst mal so für neue Dokumente handhaben. Die bestehenden Dokumente würde ich vorerst nicht überarbeiten, weil das relativ aufwändig ist. Da können wir uns später noch nach und nach drum kümmern.

jhorzek commented 1 year ago

Ich habe leider festgestellt, dass einige der Formatierungen in den .qmd Dokumenten nicht wirklich kompatibel mit Quarto Books waren. Daher habe ich kurzerhand fast alle Formatierungen entfernt. Da ich das größtenteils per search and replace getan habe, funktionieren die neuen Seiten noch nicht ganz problemlos. Wir sollten noch mal genauer schauen, wo wir eventuell die Formatierung noch weiter anpassen wollen.