# Typografische Konventionen

## Markierungen in Bildern

In diesem Dokument bezieht sich Text regelmäßig auf Elemente in einem Screenshot.

In Screenshots sind solche Elemente mit Buchstaben in schwarzen Quadraten markiert.

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

## Pfade

Pfade können Folgendes anzeigen:

* Sie zeigen, wie Sie in der BuildingPro-Suites-Oberfläche navigieren müssen. In diesem Fall ist eine bestimmte Handlung 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 Handlung 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 weist Sie an, 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 innerhalb von Pfaden dynamische Elemente 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 weist Sie an, 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 %}

### Verknüpfungen

#### 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](/collection/german/vorwort/readme.md)
{% 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.

Handlungsabläufe werden als nummerierte Liste dargestellt.

{% hint style="info" %}

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

#### Zwischenergebnisse in Handlungsabläufen

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

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

1. Klicken Sie auf Engineering\
   ▷ Das Menü "Engineering" wird geöffnet
   {% 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]**&#x65;ine Beschreibung.\
   ◈ Diese Beschreibung dient als Hilfe oder Erinnerung für Nutzer 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]** ist 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 %}

## Infoboxen

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

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

{% hint style="warning" %}
Die orange Infobox warnt vor einem geringfügigen Risiko, z. B. wenn Ihre gerade vorgenommenen Einstellungen verloren gehen könnten
{% endhint %}

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

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


---

# Agent Instructions: Querying This Documentation

If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter:

```
GET https://docs.buildings.ability.abb/collection/german/vorwort/typographical-conventions.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.
