Dies ist eine alte Version des Dokuments!


CodiMD

Bei CodiMD (https://pad.gwdg.de) handelt es sich um eine Alternative zum Etherpad, also eine Softwarelösung zum kollaborativen Bearbeiten von Dokumenten in Echtzeit. Dies erlaubt Nutzer*innen, eine sogenannte Notiz (englisch: Note) anzulegen, mit anderen Nutzer*innen zu teilen und gleichzeitig zu editieren. Das 'MD' im Namen steht hierbei für MarkDown, eine einsteigerfreundliche Sprache zur Formatierung von (Web-)Dokumenten. Einige wichtige Funktionen sowie Hinweise zur Nutzung von CodiMD finden sich auf dieser Seite - sollten weitere Fragen oder Probleme auftauchen, melden Sie sich gerne unter codimd@gwdg.de oder unter support@gwdg.de.

Wichtige Hinweise

Privatsphäre: In der Standardeinstellung sind alle Notizen bei CodiMD für alle Nutzer*innen sowohl les- als auch schreibbar, sobald die URL zu der Notiz bekannt ist. Sobald eine Person also den Link zu einer Notiz kennt, deren Zugriffsbeschränkung 'FREELY' ist, kann diese alle Daten lesen, editieren/löschen. Sensible Daten sollten daher nicht in CodiMD abgelegt werden! Die Zugriffsbeschränkungen lassen sich durch Klick auf das Dropdown-Menü mit dem Text 'FREELY' oben rechts in der Dokumentenvorschau anpassen. Eine detaillierte Beschreibung der Rechte findet sich unter https://pad.gwdg.de/features#Permissions.

Löschung aller Notizen: Notizen werden nach 6 monatiger Inaktivität dauerhaft gelöscht, sodass sich CodiMD nicht als Ort zur dauerhaften Speicherung von Daten eignet. Dies ist eine Maßnahme, die wir ergreifen um die Anzahl der (unbenutzten) Notizen nicht unbegrenzt ansteigen zu lassen.

Nutzungsvoraussetzungen

Um CodiMD nutzen zu können, wird ein aktueller Webbrowser mit Internetzugang benötigt. Außerdem braucht jeder, der eine neue Notiz erstellen möchte, einen Nutzeraccount bei der GWDG. Möchten Sie sich einen neuen Account zur Nutzung von CodiMD erstellen, können Sie dies über https://www.gwdg.de/registration tun. Bevor eine Notiz erstellt werden kann, muss man sich durch Klick auf 'Einloggen' und anschließend auf 'Einloggen über SAML' anmelden. Das Bearbeiten von Notizen ist, bei bekannter URL zu der Notiz, auch ohne Nutzeraccount möglich.

Funktionen

CodiMD verfügt über eine Vielzahl von Funktionen, eine vollständige Übersicht findet sich unter https://pad.gwdg.de/features (leider nur auf Englisch). Beispielcode kann von dort sehr einfach in die eigenen Notizen übernommen und entsprechend modifiziert werden. Die wichtigsten Funktionalitäten sind auch hier noch einmal aufgeführt:

  • MarkDown: Markdown erlaubt unter Benutzung einfacher Befehle die Formatierung von Texten, ein kleine Sammlung findet sich in der Menüleiste bei dem '?'-Button, zudem nutzt CodiMD an vielen Stellen Autovervollständigung
  • verschiedene Ansichten: nur Texteingabe (Markdown), Texteingabe und Vorschau, nur Vorschau
  • Zugriffsbeschränkung: per default darf jeder im Besitz der URL zu einer Note diese Ansehen und Editieren (!), dies lässt sich durch Klick auf 'FREELY' (oben rechts bei Vorschau) anpassen (detaillierte Beschreibung der Zugriffsbeschränkung unter https://pad.gwdg.de/features#Permissions
  • Export von Dokumenten: im Menü oben rechts unter 'Download' das gewünschte Format auswählen
  • Einbinden von Inhalten: Bilder, PDFs, Präsentationen, Videos, mathematische Formeln und viele Diagrammtypen möglich (siehe mehr unter https://pad.gwdg.de/features)
  • Präsentationsmodus: Bearbeiten von Präsentationen, Beispiel siehe https://pad.gwdg.de/slide-example?both
  • Veröffentlichen von Notizen: Erzeugen eines neuen Links zu der Dokumentenansicht der Notiz (unabhängig von vorheriger Zugriffsbeschränkung)

Unterschiede zu Etherpad

Falls Sie vorher das Etherpad genutzt haben, hier eine kurze Zusammenfassung der Unterschiede zwischen CodiMD und Etherpad:

  • in CodiMD ist das Erstellen neuer Notizen (entspricht im Etherpad einem Pad) nur mit Account nach Login möglich
  • Zugriffsbeschränkung der Notizen erlauben die Vergabe individueller Lese-/Schreibrechte für Notizen
  • Unterstützung von Markdown zur Formatierung von Dokumenten, Hilfestellung findet sich in der Menüleiste bei dem '?'-Button