IT/CryptPad
Einführung
Allgemein
Wir stellen Pads unter https://cryptpad.piratenpartei.de für die gemeinsame Erarbeitung von Texten zur Verfügung. Bisher waren 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 von Pads auf Basis der Software CryptPad entschieden.
Wichtige Hinweise:
- 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.
- Wir können Pads oder Accounts nicht wiederherstellen. Erstelle daher regelmäßig Backups.
- Möglicherweise musst du im Browser das Öffnen von Popup-Fenstern erlauben.
Unterschiede CryptPad und Etherpad
Autorenfarben
Die nützliche Kennzeichnung der Autoren durch verschiedene Schriftfarben steht im Code-Pad als experimentelle Funktion zur Verfügung. Die Funktion muss vom Besitzer des Pads eventuell unter dem Menüpunkt "Themes" aktiviert werden. Der Besitzer benötigt einen Account im Cryptpad.
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.
"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.
Grundlagen
Pad-Arten
Bei uns stehen die nachfolgend beschriebenen Pad-Arten zur Verfügung. Außerdem können angemeldete Nutzer beliebige Dateien in ihr CryptDrive hochladen und darüber anderen zugänglich machen.
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ü "Theme" ausgewählt werden.
Experimentell stehen Autorenfarben zur Verfügung. Diese müssen eventuell über das Menü "Theme" aktiviert werden.
Rich Text
Mit Rich-Text-Pads können Textdokumente erstellt werden. Es stehen mehr Formatierungsmöglichkeiten als bei den Markdown-Pads zur Verfügung. Formatierungen werden direkt am Text vorgenommen.
Das Pad kann mit den angewendeten Formatierungen als HTML-Dokument exportiert werden. Die weitere Verwendung in anderen Diensten ist nur eingeschränkt möglich.
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.
Office
Die Pad-Arten Dokumente (Beta) und Tabelle erlauben das Erstellen anspruchsvollerer Textdokumente und Tabellen (ähnlich zu LibreOffice).
Bitte beachte, dass sich das Dokumenten-Pad noch in Entwicklung befindet und es zu Datenverlust kommen kann. Zur Verwendung wird ein Benutzerkonto benötigt.
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 rechts werden die im Pad aktiven Nutzer angezeigt. Bei den auf Markdown basierenden Pads ist das Fenster aufgeteilt in den Editor auf der linken Seite und die Anzeige des formatierten Dokuments auf der rechten Seite. Die Vorschau entfällt bei den anderen Pad-Arten. Wenn dich die Anzeigen stören, kannst du sie über die entsprechenden Schaltflächen ausblenden.
Pads teilen
Bevor du den Pad-Link weitergibst oder gar veröffentlichst, solltest du dir darüber Gedanken machen, ob der Betrachter das Pad bearbeiten oder nur ansehen soll.
CryptPad unterstützt dich dabei mit einer Funktion zum Teilen von Pads. Diese Funktion ist sowohl über das CryptDrive als auch in der Pad-Ansicht verfügbar. Hierbei kannst du auswählen, welche Rechte du einräumen möchtest. Es wird dann ein passender Link angezeigt, den du an andere Nutzer weitergegeben kannst.
Die mit einem Pad-Link verbundenen Rechte kann man leicht ablesen:
- Bearbeiten: https://cryptpad.piratenpartei.de/code/#/2/code/edit/YPJ+LlamkZv8MixRJg04TsyD/
- Nur Ansehen: https://cryptpad.piratenpartei.de/code/#/2/code/view/BSgt6Fw5BIE8fg7PBkkYiMwRPH45mTWpY5j7+rykl0w/
Rechteverwaltung bei Pads
Als Eigentümer eines Pads kann man im CryptDrive per Klick über den Menüpunkt Zugriff festlegen, wer (Mit-)Eigentümer vom Pad ist und wer Zugriff auf das Pad haben soll. Wenn diese Zugriffsliste aktiviert ist, dann bekommt man keinen Zugriff über den Link, falls man nicht eingetragen ist.
Ein bisschen Markdown
Markdown vereint das schnelle, einfache Schreiben von formatierten Texten und gute Lesbarkeit auch des unformatierten Textes. Wer schon mal in HTML zu schreiben oder HTML-Quelltext zu lesen versucht hat, erkennt das besonders schnell.
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. Ein einfacher Zeilenumbruch führt in der formatierten Darstellung nur zu einem Leerzeichen. Um einen Zeilenumbruch zu erhalten, können zwei oder mehr Leerzeichen am Zeilenende gesetzt werden. 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~~
|
|
`Code`
|
Code
|
Listen
Die Punkte einer Liste bekommen jeweils eine eigene Zeile. Punkte einer ungeordneten Liste beginnen mit * und Punkte einer geordneten Liste werden einfach durchnummeriert. Unterpunkte werden mit Leerzeichen eingerückt.
| Eingabe | Ergebnis |
|---|---|
* Ein Punkt * Ein Unterpunkt * Noch ein Punkt |
|
1. Ein Punkt 1. Ein Unterpunkt 2. Noch ein Punkt |
|
Überschriften
Überschriften werden mit Doppelkreuzen gekennzeichnet. Dabei entspricht deren Anzahl der gewünschten Überschriftenebene. Mit [TOC] kann in Markdown-Pads ein Inhaltsverzeichnis erzeugt werden.
| 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 |
Zitate
Zitate werden gekennzeichnet, indem jeder Zeile > vorangestellt wird:
| Eingabe | Ergebnis |
|---|---|
> Dies ist ein Zitat, > das sich über mehrere > Zeilen erstreckt. |
|
Registrierung
Für einige Funktionen ist es nützlich, ein Benutzerkonto anzulegen. Hierzu zählt beispielsweise:
- Erstellung eines Benutzerprofils
- Ablage und Organisation von Pads im CryptDrive, ohne Ablauf der Pads aufgrund von längerer Inaktivität
- Weitergabe von geteilten Ordnern an andere Teammitglieder
Hierzu müssen lediglich ein Benutzername und ein Passwort angegeben werden. Eine E-Mail-Adresse oder sonstige Informationen werden nicht benötigt.
Dein Profil
Dein Profil ist stets über die Ecke oben rechts erreichbar. Wenn du ein Profilfoto hochgeladen hast, wird dieses angezeigt. 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 rechten 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.
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
Über das CryptDrive kannst du deine Pads organisieren.
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ü 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 das Menü "Datei" 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ü "Datei" 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 das 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ü "Zugriff"). 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.
Backup
Du kannst in den Einstellungen unter "CryptDrive" ein Backup deiner Pads herunterladen. Dieses enthält nicht den Inhalt der Pads, sondern die für den Zugriff benötigten Schlüssel. Solltest du den Zugang zu deinen Account verlieren, kannst du einen neuen Account anlegen und mit dem Backup den Zugriff auf die Pads wiederherstellen.
Mit "Mein CryptDrive herunterladen" kannst du den Inhalt der Pads in einem lesbaren Format sichern. Dies funktioniert bei den Markdown-, Rich-Text- und Präsentation-Pads.
CryptPad für Teams
Für Teams gibt es zwei Möglichkeiten. Es gibt das integrierte Teams-Feature, welches eine Mitglieder- und Rechteverwaltung beinhaltet und einen getrennten Bereich zum normalen CryptDrive bereitstellt und es gibt geteile Ordner, die Teil des normalen CryptDrive sind.
Teams Funktion
Über einen Klick auf sein Profilbild kann man in die Teams-App, wo man ein Team anlegen kann. Wenn man in das Team rein geht, kann man über die Seitenleiste Benutzer einladen und ihnen Rechte geben. Im Team kann man eine eigene Ordnerstruktur anlegen. Die Pads müssen im Team-Interface angelegt werden, damit die auch im Team verwendet werden können.
Wenn man normale Pads im Team verwenden will, muss man das Pad über die "Teilen" dem Team bereitstellen.
Geteilter Ordner
- 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.
Adblocker/Scriptblocker
Das CryptPad benötigt für das Fuktionieren JavaScript und ruft Daten über andere URLs ab. Stelle bitte sicher, dass der Zugriff auf die URLs "cryptpad.piratenpartei.de", "padapi.piratenpartei.de" und "cryptpad-sandbox.piratenpartei.de" möglich ist.