# Typographical Conventions

## Markings in Images

In this document, text regularly refers to elements in a screenshot.

In screenshots, such elements are marked with letters in black squares.

In text, these elements are represented as e.g. **\[A]**, **\[B]**, **\[C]** ...

## Paths

Paths can indicate the following:

* They show how you need to navigate within the BuildingPro Suites interface. In this case, a specific action is required from you.
* Arrows indicate the location of a menu. In this case, the path is for your information only, and no action is required from you.

Which option is meant will be clear from the respective context.

Paths are identified by an arrow "->".

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

Navigate to: Engineering -> Users -> Archive

**Explanation**

This instruction tells you to click on the "Engineering" menu item, then the "Users" menu item, and then the "Archive" menu item.
{% endhint %}

### Variables in Paths

Often you need to select dynamic elements within paths, e.g. user names. Such variables are set in *\[italicized square brackets]*.

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

Navigate to: Engineering -> Users -> \[*Select a user*]

**Explanation**

This instruction tells you to click on the "Engineering" menu item, then the "Users" menu item, and then click on a user name.
{% endhint %}

### Proper Nouns

Proper nouns, e.g. of apps but also of menu items, are displayed in *italics*.

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

*Xovis People Counter App*
{% endhint %}

### Links

#### Internal Links

Internal links lead you to a relevant page within this document.

Internal links are introduced by an arrow and are marked as a hyperlink.

{% hint style="info" %}
[-> Example of an internal link](https://docs.buildings.ability.abb/collection/preface/readme)
{% endhint %}

#### External Links

External links refer to other websites. External links are marked with an arrow -> and \[External Link].

{% hint style="info" %}
[-> \[External Link\] Example of an external link](https://www.wikipedia.de)
{% endhint %}

## Action Instructions

Action instructions show you step by step how to achieve a desired goal.

Sequences of actions are presented as a numbered list.

{% hint style="info" %}

1. First step
2. Second step
3. Third step
   {% endhint %}

#### Intermediate Results in Action Sequences

The result of an action is introduced by an empty, right-pointing triangle.

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

1. Click on Engineering\
   ▷ The "Engineering" menu opens
   {% endhint %}

#### Information in Action Instructions

Useful information within an action instruction is introduced by a diamond.

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

1. Give the asset a description under **\[F]**.\
   ◈ This description serves as a help or reminder for BuildingPro Suites users.
   {% endhint %}

#### Warnings in Action Instructions

Important notes within an action instruction are introduced by the **⚠** symbol.

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

* Activate the checkbox at **\[N]** to enable this asset for Augmented Reality\
  \&#xNAN;**⚠** Caution: Deleting this asset will also remove all associated data and cannot be undone.
  {% endhint %}

#### Options in Action Instructions

Places where you can choose between several options are indicated by the following symbol:

**⇄ OR**

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

1. Click on **\[N]** to create the user and complete the process

   ▷ The window **\[D]** is closed\
   ▷ A new user is created\
   ▷ The new user appears in the user list\
   \
   \&#xNAN;**⇄ OR**
2. Click on **\[O]** to create the user and continue directly with the creation of another user\
   ▷ A new user is created\
   ▷ The window **\[D]** remains open\
   ▷ All information is reset\
   ▷ Repeat the process from step 4
   {% endhint %}

## Info Boxes

The warning messages are based on the requirements of the standard EN-82079-1.

{% hint style="info" %}
The blue info box displays useful information.
{% endhint %}

{% hint style="warning" %}
The orange info box warns of a minor risk, e.g. if your just-made settings could be lost
{% endhint %}

{% hint style="danger" %}
**DANGER!**\
The red info box warns of serious risks that could lead to property damage or personal injury
{% endhint %}

{% hint style="success" %}
The green info box contains further information
{% endhint %}