# Typografische Konventionen

## Kennzeichnungen in Bildern

In diesem Dokument wird im Text regelmäßig auf Elemente in einem Screenshot verwiesen.

In Screenshots werden solche Elemente mit Buchstaben in schwarzen Kästchen markiert.

Im Text werden diese Elemente z. B. als **\[A]**, **\[B]**, **\[C]** ...

## Pfade

Pfade können auf Folgendes hinweisen:

* Sie zeigen, wie Sie sich innerhalb der BuildingPro Suites-Oberfläche navigieren müssen. In diesem Fall ist eine bestimmte Aktion von Ihnen erforderlich.
* Pfeile geben die Position eines Menüs an. In diesem Fall dient der Pfad nur zu Ihrer Information, und es ist keine Aktion von Ihnen erforderlich.

Welche Option gemeint ist, ergibt sich aus dem jeweiligen Kontext.

Pfade werden durch einen Pfeil "->" gekennzeichnet.

{% hint style="info" %}
**Beispiel**

Navigieren Sie zu: Engineering -> Users -> Archive

**Erklärung**

Diese Anweisung fordert Sie auf, auf den Menüpunkt "Engineering", dann auf den Menüpunkt "Users" und anschließend auf den Menüpunkt "Archive" zu klicken.
{% endhint %}

### Variablen in Pfaden

Oft müssen Sie dynamische Elemente innerhalb von Pfaden auswählen, z. B. Benutzernamen. Solche Variablen werden in *\[kursiv gesetzten eckigen Klammern]*.

{% hint style="info" %}
**Beispiel**

Navigieren Sie zu: Engineering -> Users -> \[*Benutzer auswählen*]

**Erklärung**

Diese Anweisung fordert Sie auf, auf den Menüpunkt "Engineering", dann auf den Menüpunkt "Users" und anschließend auf einen Benutzernamen zu klicken.
{% endhint %}

### Eigennamen

Eigennamen, z. B. von Apps, aber auch von Menüpunkten, werden in *Kursivschrift*.

{% hint style="info" %}
**Beispiel**

*Xovis People Counter App*
{% endhint %}

### Links

#### Interne Links

Interne Links führen Sie zu einer relevanten Seite innerhalb dieses Dokuments.

Interne Links werden durch einen Pfeil eingeleitet und als Hyperlink gekennzeichnet.

{% hint style="info" %}
[-> Beispiel für einen internen Link](https://docs.buildings.ability.abb/collection/german/vorwort/readme)
{% endhint %}

#### Externe Links

Externe Links verweisen auf andere Websites. Externe Links sind mit einem Pfeil -> und \[Externer Link] gekennzeichnet.

{% hint style="info" %}
[-> \[Externer Link\] Beispiel für einen externen Link](https://www.wikipedia.de)
{% endhint %}

## Handlungsanweisungen

Handlungsanweisungen zeigen Ihnen Schritt für Schritt, wie Sie ein gewünschtes Ziel erreichen.

Abläufe von Handlungen werden als nummerierte Liste dargestellt.

{% hint style="info" %}

1. Erster Schritt
2. Zweiter Schritt
3. Dritter Schritt
   {% endhint %}

#### Zwischenergebnisse in Handlungsfolgen

Das Ergebnis einer Handlung wird durch ein leeres, nach rechts zeigendes Dreieck eingeleitet.

{% hint style="info" %}
**Beispiel**

1. Auf Engineering klicken\
   ▷ Das Menü "Engineering" öffnet sich
   {% endhint %}

#### Informationen in Handlungsanweisungen

Nützliche Informationen innerhalb einer Handlungsanweisung werden durch eine Raute eingeleitet.

{% hint style="info" %}
**Beispiel**

1. Geben Sie dem Asset unter **\[F]**.\
   ◈ Diese Beschreibung dient als Hilfe oder Erinnerung für Benutzer von BuildingPro Suites.
   {% endhint %}

#### Warnhinweise in Handlungsanweisungen

Wichtige Hinweise innerhalb einer Handlungsanweisung werden durch das **⚠** Symbol eingeleitet.

{% hint style="info" %}
**Beispiel**

* Aktivieren Sie das Kontrollkästchen bei **\[N]** um dieses Asset für Augmented Reality zu aktivieren\
  \&#xNAN;**⚠** Achtung: Das Löschen dieses Assets entfernt auch alle zugehörigen Daten und kann nicht rückgängig gemacht werden.
  {% endhint %}

#### Optionen in Handlungsanweisungen

Stellen, an denen Sie zwischen mehreren Optionen wählen können, werden durch das folgende Symbol gekennzeichnet:

**⇄ ODER**

{% hint style="info" %}
**Beispiel**:

1. Klicken Sie auf **\[N]** um den Benutzer zu erstellen und den Vorgang abzuschließen

   ▷ Das Fenster **\[D]** wird geschlossen\
   ▷ Ein neuer Benutzer wird erstellt\
   ▷ Der neue Benutzer erscheint in der Benutzerliste\
   \
   \&#xNAN;**⇄ ODER**
2. Klicken Sie auf **\[O]** um den Benutzer zu erstellen und direkt mit der Erstellung eines weiteren Benutzers fortzufahren\
   ▷ Ein neuer Benutzer wird erstellt\
   ▷ Das Fenster **\[D]** bleibt geöffnet\
   ▷ Alle Informationen werden zurückgesetzt\
   ▷ Wiederholen Sie den Vorgang ab Schritt 4
   {% endhint %}

## Infokästen

Die Warnhinweise basieren auf den Anforderungen der Norm EN-82079-1.

{% hint style="info" %}
Der blaue Infokasten zeigt nützliche Informationen an.
{% endhint %}

{% hint style="warning" %}
Der orangefarbene Infokasten warnt vor einem geringen Risiko, z. B. wenn die eben vorgenommenen Einstellungen verloren gehen könnten
{% endhint %}

{% hint style="danger" %}
**GEFAHR!**\
Der rote Infokasten warnt vor schweren Risiken, die zu Sachschäden oder Personenschäden führen können
{% endhint %}

{% hint style="success" %}
Der grüne Infokasten enthält weitere Informationen
{% endhint %}