# Typographic conventions

The following typographic conventions are used in this document:

## Markup in images

In this document, reference is regularly made in text to elements in a screenshot. 

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

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

## Paths

Paths can indicate the following:

* They show you how you must navigate within the ABB BuildingPro 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; no action is required from you.

Which option is meant is 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 the menu item "Engineering", then the menu item "Users", and then the menu item "Archive". 
{% endhint %}

### Variables in paths

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

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

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

**Explanation**

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

## Proper names

Proper names, e.g. of apps, but possibly also of menu items, are *italicized* displayed.

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

*Xovis People Counter App*
{% endhint %}

## Links

### Internal links

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

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

{% hint style="info" %}
[-> Example of an internal link](/collection/english-v14/foreword/welcome.md)
{% 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://docs.buildings.ability.abb/collection/english-v14/foreword/www.wikipedia.de)
{% endhint %}

## Instructions

Instructions show you step by step how to achieve a desired goal. 

Procedures are presented as a numbered list.

{% hint style="info" %}

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

### Intermediate results in procedures 

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 instructions

Useful information within an instruction is introduced by a diamond

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

1. Enter for the asset under **\[F]** a description.\
   ◈ This description serves as help or a memory aid for users of ABB BuildingPro. 
   {% endhint %}

### Warnings in instructions

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

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

* Check the box for **\[N]**, to enable this asset for Augmented Reality\
  \&#xNAN;**⚠** Attention: This process costs Infravolts!
  {% endhint %}

### Options in instructions

Places where you can choose between several options are identified 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 creating another user\
   ▷ A new user is created\
   ▷ The window **\[D]** remains open\
   ▷ All entries are reset\
   ▷ Repeat the process from step 4 
   {% endhint %}

## Information boxes

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

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

{% hint style="warning" %}
The orange information box warns of a minor danger, e.g. if the settings you have just made could be lost
{% endhint %}

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

{% hint style="success" %}
The green information box contains further information 
{% 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/english-v14/foreword/typographic-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.