Aktionen im Dokumentationssystem

Im Abschnitt Aktionen können Sie Elemente in das Dokument an der Stelle einfügen, an der aktuell Ihr Cursor platziert ist.

Sie können diese Elemente einfügen:

• Bild
• Code Block
• Tabelle
• Hinweisbox
• Link zu anderer Dokumentation
• agorum Link
• externer Link
• Handlungsanweisungen
• Video
• Video (Youtube)
• Video (Vimeo)
• Miroboard

Ein Bild einfügen

Folgende Formate sind möglich:

• jpg
• jpeg
• gif
• png

1. Wählen Sie Einfügen beim Cursor > Bild.
2. Wählen Sie ein vorhandenes Bild über oder laden Sie ein Bild über  in einen Ordner.
3. Geben Sie optional einen Untertitel für das Bild ein.
4. Fügen Sie das Bild in das Dokument ein.

 

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 in der Vorschau und in der Live-Ansicht 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.

1. Wählen Sie Einfügen beim Cursor > Code Block.
2. Geben Sie Code ein.
3. Fügen Sie den Code Block in das Dokument ein.

 

Eine Tabelle einfügen

• Das System formatiert die Tabelle immer auf die gesamte Breite des Dokumentes.
• Es stehen verschiedene Tabellentypen zur Auswahl.
• Jeder Typ ist unterschiedlich formatiert.

1. Wählen Sie Einfügen beim Cursor > Tabelle.
2. Wählen Sie die Anzahl an Zeilen für die Tabelle.
3. Wählen Sie einen Typ.
4. Fügen Sie die Tabelle in das Dokument ein.

 

 

Eine Hinweisbox einfügen

• Es stehen verschiedene Typen zur Auswahl.
• Jeder Typ ist unterschiedlich formatiert.

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

   Hinweis: Das System füllt den Titel automatisch mit dem Namen des Typs.

3. Wählen Sie einen Typ aus.
4. Fügen Sie die Hinweisbox in das Dokument ein.

 

Ein Link zu einer anderen Dokumentation einfügen

Mit dieser Aktion fügen Sie einen Link zu einer anderen Dokumentation sowie optional eine Sprungmarke zu einer Überschrift in dieser Dokumentation ein.

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

   Hinweis: Das System schlägt automatisch anhand des verlinkten Dokumentes und der Überschrift einen Titel vor.

5. Fügen Sie den Link in das Dokument ein.

 

Einen agorum Link einfügen

Mit dieser Aktion können Sie einen Link auf ein agorum-Objekt in das Dokument einfügen.

• Als Objekte dienen etwa Bilder, Dateien und andere Dokumente.
• Auch andere Dokumentations-Dokumente können Sie verlinken.
• Eingefügte Dateien lassen sich über den Link in der Dokumentation herunterladen.

1. Wählen Sie Einfügen beim Cursor > agorum Link
2. Suchen Sie ein Objekt über  oder laden Sie ein Objekt über  in einen Ordner.
3. Vergeben Sie einen Titel.

Einen externen Link einfügen

Mit dieser Aktion können Sie einen Link auf eine externe Seite außerhalb von agorum core einfügen.

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

 

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.

1. Wählen Sie Einfügen beim Cursor > Handlungsanweisungen.
2. Geben Sie die Anzahl an Handlungssschritten ein.
3. Fügen Sie die Handlungsanweisungen in das Dokument ein.

 

Ein Video einfügen

Folgende Formate sind möglich:

• mp4

1. Wählen Sie Einfügen beim Cursor > Video.
2. Wählen Sie ein vorhandenes Video über oder laden Sie ein Video über  in einen Ordner.
3. Fügen Sie das Video in das Dokument ein.

 

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 nicht direkt an, es erscheint lediglich ein Platzhalter.
• Erst in der Live-Ansicht des Dokumentes wird das eingebettete Video sichtbar.

1. Wählen Sie Einfügen über Cursor > Video (Youtube).
2. Geben Sie einen Link zum Youtube-Video ein.
3. Fügen Sie das Youtube-Video in das Dokument ein.

 

Ein Video (Vimeo) einfügen

• Das System zeigt die Vimeo-Videos im Editor nicht direkt an, es erscheint lediglich ein Platzhalter.
• Erst in der Live-Ansicht des Dokumentes wird das eingebettete Video sichtbar.

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

Miroboard einfügen

• Das System zeigt eine Präsentationsansicht des angegbenen Miroboards ähnlich wie ein eingebettes Video an. Voraussetzung ist, dass der Benutzer Zugriff auf das Miroboard hat.
• Das angezeigte Miroboard dient als Information für die Leser der Dokumentation, dass weitere Informationen in Miro vorhanden sind.

1. Wählen Sie Einfügen beim Cursor > Miroboard.
2. Geben Sie die URL des Miroboards an.
3. Fügen Sie das Miroboard in das Dokument ein.