# Richtlinien für das Verfassen von Beiträgen Unser gemeinsames [Laborbuch](https://publish.obsidian.md/vhl/Willkommen) lädt Sie ein, Ihren Forschungsprozess zu dokumentieren. Dazu gehören neben Erfolgen, Erkenntnissen und Ergebnissen auch tentative Überlegungen, Sackgassen und Misserfolge, scheinbar nebensächliche Gedanken und die Auseinandersetzung mit ihrer eigenen Rolle als forschende Person. Wir wollen Ihnen daher die größtmögliche Freiheit geben, Ihre Beiträge in Obsidian so zu gestalten, wie Sie das für angemessen erachten. Entsprechend beschränken wir uns auf einige wenige, dafür aber wichtige Richtlinien für das Verfassen von Beiträgen, deren Beachtung wir Ihnen nachdrücklich ans Herz legen wollen. Der Grund dafür ist, dass erst die gemeinsame Umsetzung dieser Richtlinien das Laborbuch zu einem kollektiven Experiment machen kann und es internen wie externen Forschenden ermöglicht, sich im Laborbuch zu orientieren und sich mit anderen Beiträgen zu verlinken um gemeinsam Wissen zu generieren. Daher würden wir Sie um Folgendes bitten: ## Verwenden Sie den YAML-Header ^b5c6e4 Wir möchten Sie ersuchen, jeden Ihrer Beiträge mit dem sogenannten YAML-Header zu versehen. Kopieren Sie dazu einfach die folgenden Zeilen und fügen Sie den Codeblock in Ihre Beiträge jeweils **ganz oben als erster Text Ihres Beitrags** ein. #### ❕ Kopieren Sie dabei die drei Bindestriche oben und unten im Codeblock mit #### ❗ Lassen Sie die drei Apostrophe ganz oben und unten allerdings weg Alternativ können Sie als interne Nutzende auch in den Lesemodus von Obsidian wechseln und den Codeblock dort direkt in die Zwischenablage kopieren. ``` --- title: "Name Ihres Projekts oder Titel Ihres Beitrags" author: "Ihr(e) Name(n) getrennt durch ein Komma" date: 2022-06-13 seminar: "Name des Seminars, in dessen Rahmen Ihr Projekt erstellt wird (gegebenenfalls weglassen)" semester: "z.B. SoSe2022 oder WiSe2022/23" tags: tag1, tag2, noch_ein_tag --- ``` Ausgefüllt könnte der Header dann beispielsweise so aussehen wie im [[Labortagebuch von Melina Wilde und Kim Reichard]]. - Die Eingabe des Datums unter "date" erfolgt im Format JJJJ-MM-TT - Sollten Sie an keinem Seminar teilnehmen mit Ihrem Projekt, können Sie die Zeile mit seminar einfach vollständig weglassen. - Unter dem Punkt "tags" würden wir Sie bitten, mindestens zwei - oder auch mehr - Schlagwörter zu nennen. Diese sollen die wesentlichen Punkte oder Sujets Ihres Beitrags umreißen und werden es anderen Forschenden ermöglichen, Ihren Beitrag zielgerichtet zu finden. Im Fall von tags aus mehreren Begriffen setzen Sie bitte Unterstriche zwischen den Begriffen statt Leerzeichen, also z.B.: "Beiträge_Schreiben". - Sie können und dürfen Ihre YAML-Header bei Bedarf jederzeit um Ihnen wichtige Punkte erweitern. Der YAML-Header eröffnet zudem die Möglichkeit, auf einer Metaebene mit den Daten des Laborbuchs zu arbeiten. Bei Interesse hieran finden Sie eine kurze Einführung in das dafür notwendige [[Dataview| Dataview-Plugin]], verfasst von Mary Shnayien. ## Verlinken Sie Ihre Beiträge Damit das Laborbuch als lebendiger Zettelkasten und Experimentplattform funktionieren kann, bitten wir Sie, Ihre Beiträge untereinander und mit den für Sie interessanten Beiträgen anderer Forschender zu verlinken. Hierfür können Sie zum einen direkte links zu anderen Beiträgen setzen, indem Sie Code wie diesen verwenden: ``` markdown [[Willkommen]] ``` Daraus wird dann automatisch der Link: [[Willkommen]] Wenn die verlinkte Seite einen langen Titel hat, kann der Link auchmit dem folgenden Code verkürzt werden. Also zunächst nach den eckigen Klammern der Titel der Seite, dann ein senkrechter Strich und dann die Kurzfassung, die als Link angezeigt werden soll, wie hier: [[AR in Public 1 - Skizze und Exploration|AR in Public]] ``` markdown [[AR in Public 1 - Skizze und Exploration|AR in Public]] ``` Zum anderen können Sie, wenn Sie das möchten, wesentliche Begriffe Ihrer Beiträge im Text selbst als tags setzen, indem Sie das Rautezeichen # direkt vor diese Begriffe setzen, also z.B. #Schreibanleitung als tag. Auch hier gilt: Im Fall von tags aus mehreren Begriffen setzen Sie bitte Unterstriche zwischen den Begriffen statt Leerzeichen, also z.B.: #Beiträge_Schreiben als tag. ## Schreiben Sie lieber mehrere kurze Beiträge als einen langen Als Faustregel wollen wir Ihnen noch mit auf den Weg geben, dass es dem Geist des Laborbuchs eher entspricht, mehrere kurze Beiträge zu schreiben, als wenige lange, und diese dafür untereinander zu verlinken. Nur so nämlich werden die Zusammenhänge zwischen einzelnen Themen und Projekten auch in der Struktur des Laborbuchs erkennbar. Diesen Punkt finden Sie auch in unseren [[FAQ#^5c1f84|FAQ]]. --- Abgesehen von diesen Richtlinien bleibt es Ihnen überlassen, wie Sie Ihre Beiträge gestalten und Sie dürfen uns gerne überraschen. Mehr Informationen zu den Möglichkeiten in Obsidian finden Sie bei Bedarf hier: - [[Zur Betitelung Ihrer Beiträge|in weiteren Schreib- und Formatierungsanleitungen]] - [[FAQ|in unseren FAQ]] Bei Fragen wenden Sie sich gerne an [[Kontakt und Support|uns]].