Aktionen im Dokumentationssystem

Im Abschnitt Aktionen fügen Sie Elemente in Ihre Dokumentation an der Stelle ein, an der aktuell Ihr Mauszeiger platziert ist.

Sie können diese Elemente einfügen:

Bild
Video
Video (YouTube)
Video (Vimeo)
Code Block
Tabelle
Hinweisbox
Link zu anderer Dokumentation
agorum-Link
Externer Link
Handlungsanweisung

Ein Bild einfügen

Sie können diese Bildformate einfügen:

jpg
jpeg
gif
png

Wählen Sie Einfügen beim Cursor > Bild.
Wählen Sie ein vorhandenes Bild über oder laden Sie ein Bild über in einen Ordner.
Geben Sie optional einen Untertitel für das Bild ein.
Fügen Sie das Bild in die Dokumentation ein.

Ein Bild einfügen

Ein Video einfügen

Sie können das Videoformat mp4 einfügen.

Wählen Sie Einfügen beim Cursor > Video.
Wählen Sie ein vorhandenes Video über oder laden Sie ein Video über in einen Ordner.
Fügen Sie das Video in die Dokumentation ein.

Ein Video einfügen

Ein Video (YouTube) einfügen

Für die Einbettung von YouTube-Links verwendet das System automatisch eine No-Cookie-Variante, um den aktuell gültigen Datenschutzbestimmungen zu entsprechen.
Das System zeigt die YouTube-Videos im Editor nur als Platzhalter an. Wechseln Sie über die Schaltfläche Anschauen oben im Dokumentationseditor zur Dokumentationsansicht, um das eingefügte Video zu sehen.

Wählen Sie Einfügen über Cursor > Video (Youtube).
Geben Sie einen Link zum YouTube-Video ein.
Fügen Sie das YouTube-Video in die Dokumentation ein.

Ein YouTube-Video einfügen

Ein Video (Vimeo) einfügen

Das System zeigt die Vimeo-Videos im Editor nur als Platzhalter an. Wechseln Sie über die Schaltfläche Anschauen oben im Dokumentationseditor zur Dokumentationsansicht, um das eingefügte Video zu sehen.

Wählen Sie Einfügen beim Cursor > Video (Vimeo).
Geben Sie die URL zum Video oder die ID des Videos an.
Fügen Sie das Vimeo-Video in die Dokumentation ein.

Ein Vimeo-Video einfügen

Einen Code Block einfügen

Mit einem Code Block fügen Sie etwa einen Ausschnitt eines JavaScripts (oder jede andere Art von Code) in das Dokument ein.

Das System stellt den Code Block im Dokumentationseditor und in der Dokumentationsansicht in unterschiedlichen Farben dar. So hat etwa eine Kommentarzeile eine andere Farbe als ein Statement.
Das System erkennt automatisch, um welchen Code es sich handelt.
Erkennt das System keinen speziellen Code, stellt es den Code schwarz dar.

Wählen Sie Einfügen beim Cursor > Code Block.
Geben Sie Code ein.
Fügen Sie den Code Block in die Dokumentation ein.

Einen Code Block einfügen

Eine Tabelle einfügen

Das System formatiert die Tabelle immer auf die gesamte Breite der Dokumentation.
Sie können zwischen verschiedenen Tabellentypen wählen.
Jeder Typ ist unterschiedlich formatiert.

Wählen Sie Einfügen beim Cursor > Tabelle.
Wählen Sie die Anzahl an Zeilen für die Tabelle.
Wählen Sie einen Typ.
Fügen Sie die Tabelle in die Dokumentation ein.

Eine Tabelle einfügen

Tipp: Im Dokumentationseditor können Sie alternativ oben im Menü über eine Tabelle einfügen und selbst formatieren.

Eine Hinweisbox einfügen

Sie können zwischen verschiedenen Hinweisboxtypen wählen.
Jeder Typ ist unterschiedlich formatiert.

Wählen Sie Einfügen beim Cursor > Hinweisbox.
Geben Sie optional einen Titel sowie Text ein.

Das System füllt den Titel automatisch mit dem Namen des Typs, wenn Sie den Titel leer lassen.
Wählen Sie einen Typ.
Fügen Sie die Hinweisbox in die Dokumentation ein.

Hinweisbox einfügen

Einen Link zu anderer Dokumentation einfügen

Mit dieser Aktion fügen Sie einen Link zu einer anderen Dokumentation ein. Optional können Sie auch eine Überschrift innerhalb der anderen Dokumentation wählen. Klickt der Leser diesen Link zur anderen Dokumentation an, landet er automatisch in dieser Dokumentation oder in einer der dortigen Überschriften, sofern Sie eine solche ausgewählt haben.

Wählen Sie Einfügen beim Cursor > Dokumentations-Dokument.
Suchen Sie ein Dokument über .
Wählen Sie optional eine Überschrift aus dem gesuchten Dokument, um eine Sprungmarke zu setzen.
Vergeben Sie einen Titel für den Link.

Das System schlägt automatisch anhand des verlinkten Dokuments und der Überschrift einen Titel vor.
Entfernen Sie den Haken bei der Einstellung Der eingefügten Dokumentation folgen und eine Baumstruktur erstellen oder lassen Sie ihn gesetzt.

Wenn Sie diese Einstellung gesetzt lassen, erstellt das System nachts automatisch einen Link zu dieser anderen Dokumentation in der Baumstruktur.
Fügen Sie den Link zur anderen Dokumentation in die Dokumentation ein.

Einen Link zu anderer Dokumentation einfügen

Einen agorum-Link einfügen

Mit dieser Aktion fügen Sie einen Link auf ein agorum-Objekt in die Dokumentation ein.

Als Objekte dienen etwa Dateien wie ZIP-Archive.
Eingefügte Dateien lassen sich über den Link in der Dokumentation herunterladen.

Wählen Sie Einfügen beim Cursor > agorum Link
Suchen Sie ein Objekt über oder laden Sie ein Objekt über in einen Ordner.
Vergeben Sie einen Titel.
Fügen Sie den agorum-Link in das Dokument ein.

agorum-Link einfügen

Einen externen Link einfügen

Mit dieser Aktion fügen Sie einen Link auf eine externe Seite außerhalb von agorum core ein.

Wählen Sie Einfügen beim Cursor > externer Link
Vergeben Sie optional einen Titel.
Geben Sie den Link ein.
Fügen Sie den externen Link in das Dokument ein.

Externer Link einfügen

Eine Handlungsanweisung einfügen

Mit dieser Aktion fügen Sie speziell formatierte Handlungsanweisungen in die Dokumentation ein.

Sie können jederzeit manuell Schritte in der Handlungsanweisung hinzufügen, indem Sie eine neue Zeile mit der Enter-Taste erzeugen.

Wählen Sie Einfügen beim Cursor > Handlungsanweisungen.
Geben Sie die Anzahl an Handlungsschritten ein.
Fügen Sie die Handlungsanweisung in die Dokumentation ein.

Eine Handlungsanweisung einfügen