Workflow

Login

Es gibt verschiedene Möglichkeiten sich in die WebApp einzuloggen.

Normalerweise wird einfach der Link im Browser aufgerufen, um sich mittels Username und Passwort einzuloggen.

Wenn man sich häufiger auf ein und dem selben Gerät einloggt, ist es sinnvoll auf Authentifikationslinks oder gleich die Desktop-Application umzusteigen.

Authentifikationslinks

Ein Authentifikationslink besteht aus aus dem Link zum Notes-Server sowie dem Username und dem Authentifikationscode, er hat die Form: https://notes.example.com/#<username>:<authcode>.

Einen solcher Link wird im Useraccountmanager erstellt, diesen erreicht man über das Personen-Icon oben rechts, welches nach dem Login angezeigt wird. Der Useraccountmanager erlaubt es auch das Passwort zu ändern.

Im Useraccountmanager werden alle Authentifikationscodes aufgelistet (wobei nur der Anfang und der Zeitpunkt der letzten Nutzung sichtbar ist), hier kann man sie auch löschen.

Jeder Authentifikationscode wird nur einmal vollständig angezeigt, direkt nach der Erstellung. Nutzen Sie also die Möglichkeit den Authentifikationslink mittels QR-Code abzurufen.
Hier ist es auch nützlich sich den Authentifikationslink als Lesezeichen zu hinterlegen oder auf einem mobilen Gerät dem Homescreen hinzufügen (KIMB-Notes ist so programmiert, dass es sich dann wie eine App verhält).

Mit einem Klick auf den Link landen Sie jetzt direkt in ihrer Notizliste.

Notizliste

Nach dem Login sehen sie diese Ansicht, hier haben Sie die Möglichkeit ihre Notizen zu öffnen.

Zum Erstellen einer Notiz geben Sie oben den gewünschten Namen (lässt sich nicht mehr ändern) an und klicken Sie auf Neu.
Mit den Pfeilen ↓ und ↑ können Sie die Reihenfolge Ihrer Notizen ändern.

Notizen können nicht gelöscht werden, um Datenverlust zu verhindern. Um eine Notiz jedoch aus der Liste zu verbannen lässt sie sich mittels ↻ archivieren. Sie ist dann immernoch vollständig aus dem Notizarchiv wiederherstellbar.

Mit dem Stern ★ können Notizen als wichtig hervorgehoben werden, wichtige Notizen können nicht sofort archiviert werden.

Es ist möglich zwei Notizen mit dem gleichen Namen zu erstellen, sie lassen sich intern durch IDs eindeutig identifizieren. (Aus Gründen der Übersicht ist davon aber abzuraten.)

Notiz erstellen

Die Ansicht zur Erstellung der Notizen besteht oben aus einer Life-Vorschau der Eingabe und darunter dem eigentlichen Eingabefeld.

Jede Änderung wird lokal im Browser gespeichert, außerdem werden die Änderungen regelmäßig dem Server mitgeteilt. Sollte es dabei zu Problemen kommen (Internetverbindung getrennt etc.) wird ein Dialog nach dem weiteren Vorgehen fragen.

Unten links befindet sich ein Indikator, welcher anzeigt ob der aktuelle Stand mit dem Server abgeglichen wurde oder nicht. Falls es Änderungen gibt, können diese mit einem Klick auf den Indikator übertragen werden.

Mit einem klick auf Schließen wird die aktuelle Version an den Server übertragen und wieder die Notizliste aufgerufen.

Aktuell ist es nicht möglich Dateien in KIMB-Notes hinzuzufügen, es können aber externe Dateien verlinkt und auch externe Bilder eingefügt werden.

Die Inhalte ihrer Notiz liegen auf dem Server unverschlüsselt vor, sofern der Server https nutzt ist die Übertragung der Daten verschlüsselt.
Das Passwort für das Login in KIMB-Notes wird immer geschützt übertragen und liegt nie in Klartext auf dem Server vor (SaltedHash; SHA256).

Markdown

Als Renderer für die Markdown Eingaben kommt Marked zum Einsatz.

Dabei wird ein etwas veränderter Renderer sowie die Optionen GitHub Flavored Markdown gfm und Tabellen tables genutzt.
Ein gute Einleitung in die Syntax von Markdown befindet sich hier.
(Aktuell wird GitHub Flavored Markdown nicht vollständig untersützt, es fehlen: Task Lists, SHA references, Issue references within a repository, Username @mentions, Emoji - siehe Issues für geplante Features).

Codeblöcke

Ein Codeblock hat folgende Form, wobei lang für die Sprache des Inhaltes steht (ohne Sprachangabe kein Syntaxhighlighting/ Rendering):

```lang
Code
```

Syntaxhighlighting wird für Codeblöcke mit folgenden Sprachen unterstützt:

• Markup: markup
• CSS: css
• C: clike oder c
• JavaScript: javascript
• Bash: bash
• C++: cpp
• C#: csharp
• Ruby: ruby
• git: git
• INI: ini
• Java: java
• JSON: json
• Lua: lua
• Markdown: markdown
• Matlab: matlab
• Objective C: objectivec
• Perl: perl
• PHP: php
• Python: python
• R: r
• SQL: sql
• Swift: swift

Weiterhin werden Codeblöcke mit folgenden Sprachen gerendert:

• LaTeX (nur Mathe): tex

Basierend auf PrismJS und KaTeX

Verlauf

Der Server sichert bei größeren Änderungen oder Änderungen nach längerer Zeit die vorherigen Versionen und legt so einen Verlauf an.

Über den Button Verlauf lässt sich eine Übersicht aller gespeicherten Versionen und deren Unterschiede zur aktuellen Version aufrufen. Auch ist es hier möglich zu einer der Versionen zurückzukehren. (Dabei bleibt der Verlauf unverändert, es wird also nicht zurückgesprungen, sondern einfach die alte Version als aktuelle hinzugefügt.)

Freigabe

Über den Button Freigabe lässt sich die aktuelle Notiz über einen Link freigeben.

Nach den Klick sehen Sie eine Liste aller vorhandenen Freigaben mit Zeitpunkt der Erstellung und des letzten Aufrufs sowie der Anzahl aller Aufrufe. Weiterhin können Sie den Zugriffslink erneut abrufen (u.a. als QR-Code), natürlich ist auch das Löschen möglich.

Bei der Erstellung einer Freigabe werden Sie nach einem Namen gefragt (dieser ist nur für Sie zur Übersicht) und gebeten anzugeben, ob man mit dem Link auch bearbeiten darf oder nicht.

Beim Aufruf einer Freigaben wird direkt die Notiz gezeigt, wenn aktiviert, inklusive Eingabefeld. Eine Speicherung erfolg hier erst mit einem Klick auf Schließen.

Offline Modus

Aktuelle Versionen von Google Chrome unterstützen keinen WebCache mehr, daher gibt es dort keinen Offline-Modus (Stand 9.11.2021). Siehe auch #21 für einen neuen Offline-Modus.

KIMB-Notes besitzt einen Offline Modus, welcher mittels WebCache erstellt wurde.

Das heißt, dass beim ersten Aufruf von KIMB-Notes das gesamte Tool im Browser gespeichert wird und danach auch ohne Internetverbindung aufgerufen werden kann (einfach den Link aufrufen, bzw. den Shortcut auf dem Homescreen).

Mit vorhandener Internetverbindung werden die Inhalte der jeweiligen Notizen lokal gespeichert und können dann auch ohne Internetverbindung zwischendurch aufgerufen und geändert werden. Die Änderungen werden dann beim nächsten Start von KIMB-Notes mit vorhandener Internetverbindung auf den Server hochgeladen.

Achtung, Browser löschen das Programm und evtl. Teile der Daten, wenn der Speicher auf der Festplatte knapp wird oder eine Seite lange nichtmehr aufgerufen wurde.

Im Offline Modus sind einige Buttons, deren Funktionen eine Internetverbindung benötigen, ausgeblendet (z.B.: Freigabe, Verlauf, Notizarchiv, Authentifikationslinks bearbeiten).

Wird der Hinweis, dass man im Offline-Modus ist, fälschlicherweise angezeigt, so kann man durch einen Klick auf diesen eine erneute Verbindung versuchen.

Achtung, sollte man an mehreren Geräten Offline Änderungen an der gleichen Notiz vornehmen, besteht die Gefahr, dass Daten überschrieben werden.