IT/CryptPad

Einführung

Allgemein

Wir stellen Pads für die gemeinsame Erarbeitung von Texten zur Verfügung. Bisher sind dies die Piratenpads auf Basis der Software Etherpad (Lite). Leider wird die Software in dieser Form nicht mehr weiterentwickelt und kann daher nicht mehr länger eingesetzt werden. Als Ersatz haben wir uns nun für die Einführung der CryptPads entschieden.

ACHTUNG: Auch weiterhin gilt, dass Pads nicht zur Dateiablage geeignet sind. Sobald ein Text fertiggestellt ist, muss er für eine dauerhafte Archivierung in ein anderes Medium (z. B. Wiki oder Redmine) übertragen werden.

Unterschiede CryptPad und Etherpad

Ganz wichtig: Pad-Links

Ein typischer Pad-Link sieht etwa so aus: https://cryptpad.hase.net/code/#/2/code/edit/JDG*I*ukdE*iM#d2-d1/ Man beachte das Wort "edit": wer diesen Link kennt, kann das Pad ändern. Es ist daher keine gute Idee, solche Links öffentlich zugänglich zu machen.

Jedes Pad hat auch einen Read-only-Link, der sich für eine Veröffentlichung eignet. Diesen findet man über den Menüpunkt "Eigenschaften" im Menü "..." (Icon rechts oben neben dem Papierkorb).

Autorenfarben

Die nützliche Kennzeichnung der Autoren durch verschiedene Schriftfarben gibt es leider im CryptPad nicht. Auch eine Umsetzung in der Zukunft wird es wohl nicht geben. Denn aufgrund der Funktionsweise des CryptPads ist nicht identifizierbar, wer gerade schreibt.

Teams

Teams in der vom Etherpad bekannten Form sind im CryptPad nicht vorgesehen. Es gibt aber auch hier die Möglichkeit, in Teams zusammenzuarbeiten. Ein paar Tipps haben wir im Abschnitt CryptPad für Teams zusammengefasst.

Ansichten

Wie bisher gibt es einen Schreib-Bereich (Editor) sowie einen Chat und die Ansicht der aktiven Nutzer. Neu ist die Vorschau, wie der geschriebene Text dann "schön formatiert" aussieht. Basis hierfür ist Markdown, das z. B. auch von Redmine und Discourse unterstützt wird. Eine Anleitung hierfür findet sich ebenfalls weiter unten.

"Sprechende" Pad-Links

CryptPad sieht die Vergabe von "sprechenden" Pad-Links nicht vor. Dies ist unter anderem dem Sicherheitskonzept geschuldet: Wer den Link nicht kennt, kann ein Pad nicht finden.

Migration Piratenpads -> CryptPad

Zunächst solltest du die Inhalte aus den Piratenpads sichern. Dies ist noch bis zur Abschaltung am 16. Juni möglich.

Als Teamadministrator einer Gruppeninstanz wie https://teamname.piratenpad.de stehen dir Optionen zum Exportieren der Pads als ZIP-Archiv zur Verfügung. Diese werden nach der Anmeldung am Ende der Pad-Liste angezeigt. Bitte beachte, dass passwortgeschützte Pads nicht im Archiv enthalten sind und einzeln gesichert werden müssen. Wenn du kein Teamadministrator bist, sichere bitte die Pads einzeln.

Um ein Lite-Pad unter der Adresse https://piratenpad.de/p/padname zu sichern, kopierst du bitte den gesamten Inhalt des Pads in eine Textdatei auf deinem Rechner. Ein Export ist leider nicht möglich.

Grundlagen

Pad-Arten

Bei uns stehen die zwei nachfolgend beschriebenen Pad-Arten zur Verfügung.

Pad (Markdown/Code)

In der Regel dürfte diese Pad-Art die richtige Wahl sein. Sie ähnelt den bisherigen Piratenpads und erlaubt die Erarbeitung von Textdokumenten. Zur Textformatierung kann Markdown verwendet werden.

CryptPad unterstützt auch Syntaxhervorhebung für eine Vielzahl von Programmier- und Auszeichnungssprachen. Die Sprache kann über das Menü ganz rechts ausgewählt werden.

Präsentation

Diese Pad-Art erlaubt die Erstellung von Präsentationen. Auch hier kommt Markdown für Formatierungen zum Einsatz.

Trenne die Folien mit --- in einer Zeile. Die Hintergrundfarbe kann über die Werkzeugleiste auf der rechten Seite geändert werden.

Pads erstellen

Um ein neues Pad zu erstellen, musst du zunächst zwischen den verfügbaren Pad-Arten wählen. Die Unterschiede wurden im vorigen Abschnitt beschrieben.

Du kannst dann festlegen, ob es ein eigenes Pad sein soll. Eigene Pads werden vom Server gelöscht, sobald du sie löschst, und sind dann auch für andere Nutzer nicht mehr verfügbar. Andernfalls werden sie erst vom Server gelöscht, wenn sie der letzte Nutzer aus seinem CryptDrive entfernt.

Außerdem kannst du festlegen, ob das Pad nach einer bestimmten Zeit ausläuft und automatisch gelöscht werden soll. Auch ein zusätzlicher Passwortschutz ist möglich.

Nach Erstellung des Pads öffnet sich die Pad-Ansicht: Ganz links werden die im Pad aktiven Nutzer angezeigt. Abgesehen davon ist das Fenster aufgeteilt in den Editor auf der linken Seite und die Anzeige des formatierten Dokuments auf der rechten Seite. Wenn dich die Anzeigen stören, kannst du sie über die entsprechenden Schaltflächen ausblenden.

Pads teilen

Pads können mit anderen geteilt werden. In der Pad-Ansicht steht diese Funktion über die entsprechende Schaltfläche oben links zur Verfügung. Hierbei kann ausgewählt werden, ob man Rechte zum Bearbeiten oder nur zum Ansehen einräumen möchte. Der generierte Link wird angezeigt und kann an andere Nutzer weitergegeben werden.

Ein bisschen Markdown

Markdown vereint zwei Zielstellung: schnelles, einfaches Schreiben von formatierten Texten und gute Lesbarkeit auch des unformatierten Textes; wer schon mal in html zu schreiben oder html-Source zu lesen versucht hat, erkennt das besonders schnell.

Eine beliebte Anfängerfalle in Markdown wieder einmal der Unterschied zwischen Zeile und Absatz und damit zwischen Zeilenenden und Absatzmarken und deren Verhältnis zur Return-/Enter-Taste.

ein Zeilenumbruch (Return-Taste) ist erstmal gar nichts (bewirkt aber einen Zeilenumbruch im Markdown-Source)
ein Satzzeichen (?!.) gefolgt von zwei Leerzeichen ( ) und einem Return ist ein Zeilenumbruch innerhalb eines Absatz (in html ein br-Tag)
ein Return gefolgt von einer Leeren Zeile ist ein Absatzende (in html eine Klammer aus p-Tag und /p-Tag).

Nachfolgend sollen einige grundlegende Beispiele gegeben werden. Die wichtigsten Formatierungsmöglichkeiten sind auch über die ein- und ausblendbare Werkzeugleiste oberhalb des Editors erreichbar.

Auch unser Forum und Redmine unterstützen Markdown, was eine einfache Übernahme der erarbeiteten Texte ermöglicht. Für das Wiki gilt dies momentan leider nicht.

Weitere Informationen sind beispielsweise in der Wikipeda verfügbar.

Textformatierung

Normaler Text wird ohne Formatierung so dargestellt, wie er eingegeben wurde. Zwei oder mehr Leerzeichen am Zeilenende erzeugen einen Zeilenumbruch. Eine Leerzeile erzeugt einen neuen Absatz.

Eingabe	Ergebnis
`Text ohne Formatierung`	Text ohne Formatierung
`_kursiv_`	kursiv
`fett`	fett
`_fett und kursiv_`	fett und kursiv
`~~durchgestrichen~~`	~~durchgestrichen~~
`Code`	`Code`

Listen

Die Punkte einer Liste bekommen jeweils eine eigene Zeile. Punkte einer ungeordneten Listen beginnen mit * und Punkte einer geordneten Listen werden einfach durchnummeriert. Unterpunkte werden mit Leerzeichen eingerückt.

Eingabe	Ergebnis
* Ein Punkt * Ein Unterpunkt * Noch ein Punkt	Ein Punkt Ein Unterpunkt Noch ein Punkt
1. Ein Punkt 1. Ein Unterpunkt 2. Noch ein Punkt	Ein Punkt Ein Unterpunkt Noch ein Punkt

Überschriften

Überschriften werden mit Doppelkreuzen gekennzeichnet. Dabei entspricht deren Anzahl der gewünschten Überschriftenebene.

Eingabe	Ergebnis
# Überschrift Ebene 1 ## Überschrift Ebene 2 ### Überschrift Ebene 3 #### Überschrift Ebene 4 ##### Überschrift Ebene 5 ###### Überschrift Ebene 6	Überschrift Ebene 1 Überschrift Ebene 2 Überschrift Ebene 3 Überschrift Ebene 4 Überschrift Ebene 5 Überschrift Ebene 6

Links

Erkannte Adressen werden automatisch in klickbare Links umgewandelt. Es können auch Links mit einer Beschriftung erzeugt werden.

Eingabe	Ergebnis
`https://wiki.piratenpartei.de`	https://wiki.piratenpartei.de
`[Piratenpartei](https://www.piratenpartei.de)`	Piratenpartei</code>

Zitate

Zitate werden gekennzeichnet, indem jeder Zeile > vorangestellt wird:

Eingabe	Ergebnis
> Dies ist ein Zitat, > das sich über mehrere > Zeilen erstreckt.	Dies ist ein Zitat, das sich über mehrere Zeilen erstreckt.

Registrierung

Für einige Funktionen ist es nützlich, ein Benutzerkonto anzulegen. Hierzu muss lediglich ein Benutzername und ein Passwort angegeben werden. Eine E-Mail-Adresse oder sonstige Informationen werden nicht benötigt.

ACHTUNG: Bewahre den gewählten Benutzernamen und das Passwort sicher auf. Wenn du die Angaben vergisst, können deine Daten nicht wiederhergestellt werden.

Dein Profil

Dein Profil ist stets über die Ecke oben rechts erreichbar. Wenn du ein Profilfoto hochgeladen hast, wird dieses anzeigt. Andernfalls erscheint dort der erste Buchstabe deines Namens.

Profilinformationen

Bei der gemeinsamen Arbeit an Dokumenten kann es nützlich sein, wenn die Autoren mehr Informationen über sich angegeben. Die aktiven Nutzer erscheinen mit Profilfoto und Namen (sofern angegeben) an der linken Seite des Pads.

Du kannst ein Profilfoto hochladen. Außerdem kannst du den Link zu deiner Webseite eintragen. In der Beschreibung kannst du weitere Informationen angegeben, wobei eine Formatierung mit Markdown möglich ist.

HINWEIS: Alle Angaben sind freiwillig und zur Verwendung des CryptPads nicht notwendig.

Persönliche Einstellungen

In den Einstellungen kannst du beispielsweise dein Passwort ändern, ein Backup deiner Daten anfertigen oder das Konto löschen.

Außerdem können einige Voreinstellungen gesetzt werden, damit du sie nicht jedes Mal beim Erstellen von Pads vornehmen musst.

CryptDrive

HINWEIS: Derzeit ist der Speicherplatz standardmäßig auf 20 MB begrenzt. In bestimmten Fällen (Vorstandsmitglieder etc.) kann dieses Limit erhöht werden.

Über das CryptDrive kannst du deine Pads organisieren. Für die Ablage der Pads steht begrenzter Speicherplatz zur Verfügung.

Nach Anklicken eines Pads oder eines Ordners stehen die Optionen über die Werkzeugleiste oben rechts zur Verfügung. Alternativ kannst du die Optionen über das Rechtsklick-Menü erreichen.

Um ein Pad oder einen Ordner zu öffnen, klicke den Eintrag doppelt an.

Ordner

Du kannst beliebig viele Ordner anlegen, um die gespeicherten Pads zu organisieren. Verschiebe Pads, indem du sie auf den gewünschten Ordner ziehst.

Geteilte Ordner

Für die Arbeit im Team können geteilte Ordner angelegt werden.

Bei der Erstellung des Ordners kann festgelegt werden, ob dies dein eigener Ordner sein soll. Eigene Ordner werden vom Server gelöscht, sobald du sie löschst, und sind dann auch für andere Nutzer nicht mehr verfügbar. Andernfalls werden sie erst vom Server gelöscht, wenn sie der letzte Nutzer aus seinem CryptDrive entfernt.

Über das Rechtsklick-Menüs des Ordners kannst du dir den Link zum Teilen anzeigen lassen. Wenn andere den Link aufrufen, wird der Ordner zu ihrem CryptDrive hinzugefügt.

Erweiterte Funktionen

Vorlagen

Pads können über die rechte Werkzeugleiste als Vorlage gespeichert werden. Bei der Erstellung neuer Pads wird dir dann zukünftig angeboten, diese Vorlage zu verwenden.

Diese Funktion eignet sich beispielsweise für Protokolle, die in der Regel einen ähnlichen Aufbau haben.

Export / Import

Über das Menü ganz rechts können Text-Dateien in das geöffnete Pad importiert werden. Beachte, dass dabei der gesamte Pad-Text überschrieben wird.

Außerdem können Pads als Textdatei gespeichert werden. Wähle dazu den Punkt "Export" aus und gib den den gewünschten Dateinamen an. Anschließend wird das Dokument heruntergeladen.

Passwortschutz

Du kannst deine eigenen Pads und geteilte Ordner zusätzlich mit einem Passwort schützen. Es reicht dann nicht aus, den Link zu kennen. Um Zugriff auf den Pad oder den Ordner zu erhalten, muss das Passwort eingegeben werden.

Den Passwortschutz kannst du direkt bei der Erstellung des Pads oder des Ordners einrichten. Bei Pads ist auch eine nachträgliche Einrichtung über die Pad-Eigenschaften möglich (erreichbar über das Menü ganz rechts). Wenn du ein neues Passwort setzt oder das Passwort änderst, verlieren alle Nutzer den Zugriff auf das Pad und müssen das neue Passwort eingeben.

ACHTUNG: Bewahre das Passwort sicher auf. Wenn du es vergisst, können deine Daten nicht wiederhergestellt werden.

CryptPad für Teams

Für Teams empfehlen wir folgende Vorgehensweise:

Legt euch einen geteilten Ordner an. Dieser sollte nicht als eigener Ordner angelegt werden, damit er nicht von einzelnen Personen abhängig ist.
Den Link zum Ordner verteilt ihr an die Mitglieder des Teams. Diese können den Ordner dann zu ihrem CryptDrive hinzufügen und zukünftig darüber aufrufen.
Innerhalb des Ordners könnt ihr euch eine Struktur mit Unterordnern (z. B. Projekte, Protokolle, Archiv, usw.) anlegen.
Die Pads erstellt ihr am besten nicht als eigene Pads. Legt diese in dem geteilten Ordner ab.