> For the complete documentation index, see [llms.txt](https://intelligent-virtual-platform.gitbook.io/intelligent-virtual-platform/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://intelligent-virtual-platform.gitbook.io/intelligent-virtual-platform/home/ivp-planning/advanced-tools/markup-tool.md).

# Markup Tool

The markup tool is an easy to use function of iVP that can be used to annotate issues or highlights inside your project and improve communication with colleagues and clients.

For better understanding and training we created a iVP YouTube Tutorial where you can find a detailed information for the markup tool.

{% embed url="<https://youtu.be/DYKIYcZMrVE>" %}
How to use the markup tool
{% endembed %}

## Placement:

The markup tool can be activated by clicking the markup icon in the \[2D View toolbar]\(../user-interface/the-2d-view\.md#the-toolbar-of-the-2D View).

![](/files/eKU5g0lZufErdswuHll2)

As soon as the tool is active, a small markup icon will follow the mouse cursor to indicate that you are in the markup mode.

![](/files/h39Rnkq2LTlPpFk43dxE)

To create a markup, **left click on a position** in the [2D View](/intelligent-virtual-platform/home/ivp-planning/user-interface/the-2d-view.md) or [3D View](/intelligent-virtual-platform/home/ivp-planning/user-interface/the-3d-view.md). A blue markup (a pin resembling a map location marker) will appear that marks the spot where you clicked and functions as an interactable highlight point.

![](/files/UqnGF5ajXokKRFy2SGY4)

The placed markup will be added to the [hierarchy](https://github.com/iVP-GmbH/iVP-gitbook/blob/main/home/ivp-planning/user-interface/the-machine-list.md) and can be used like any other object. It can be [renamed and grouped in folders](/intelligent-virtual-platform/home/ivp-planning/machines/renaming-objects-and-folders.md), [set in/visible](/intelligent-virtual-platform/home/ivp-planning/user-interface/hierarchy-panel.md#hideunhide-objects), set to be [un/locked](/intelligent-virtual-platform/home/ivp-planning/user-interface/hierarchy-panel.md#lockunlock-objects) and [recolored](/intelligent-virtual-platform/home/ivp-planning/machines/highlighting-objects.md).

## Editing a Markup:

After placing a markup, the [properties panel](https://github.com/iVP-GmbH/iVP-gitbook/blob/main/home/ivp-planning/user-interface/the-info-panel.md) will show the default options to [move an object](/intelligent-virtual-platform/home/ivp-planning/machines/move-objects.md#moving-objects-via-the-info-panel) and foremost a section to edit the selected markup.

![](/files/lpNDXdpoSAvohvXtPBg5)

## The default fields:

* Default: the general information of a markup regarding
  * ***Name:*** the name of the object which [can be changed](/intelligent-virtual-platform/home/ivp-planning/machines/renaming-objects-and-folders.md) at any time
  * ***ID:*** the unique ID of the object which is generated when the markup is [placed](/intelligent-virtual-platform/home/ivp-planning/machines/first-steps-with-3d-object.md) in the [2D-](/intelligent-virtual-platform/home/ivp-planning/user-interface/the-2d-view.md) or [3D View](/intelligent-virtual-platform/home/ivp-planning/user-interface/the-3d-view.md); the ID is unchangeable
  * ***Author:*** the author of the markup, per default "Planner"; this information is unchangeable and independent from the object name
  * ***Created:*** exact time and date when the markup was created; this information is unchangeable
* Transform: the panel containing information of the markup regarding
  * ***Dimensions:*** the dimensions of the object; this information is only changeable by changing the [scale](/intelligent-virtual-platform/home/ivp-planning/machines/scale-objects.md)
  * ***Position:*** the position of the object, changing this will [move the object](/intelligent-virtual-platform/home/ivp-planning/machines/move-objects.md#moving-objects-via-the-info-panel)
  * ***Scale:*** the [scale](/intelligent-virtual-platform/home/ivp-planning/machines/scale-objects.md) of the object; use with caution!
  * ***Rotation:*** the [rotation](/intelligent-virtual-platform/home/ivp-planning/machines/rotate-objects.md) of the object
* Markup: the panel containing information about the markup regarding
  * ***Priority:*** a Priority can be set for each individual markup, which helps with sorting markups in the [markups panel](/intelligent-virtual-platform/home/ivp-planning/user-interface/markups-panel.md) and works great if combined with [recoloring](/intelligent-virtual-platform/home/ivp-planning/machines/highlighting-objects.md)
    * ***Low:*** set the priority of the selected markup to low
    * ***Medium:*** Set the priority of the selected markup to medium (default)
    * ***High:*** set the priority of the selected markup to high
  * ***Status:*** the status of a markup can be set and this information will be reflected in the [markups panel](/intelligent-virtual-platform/home/ivp-planning/user-interface/markups-panel.md).
    * ***Open:*** Set the status of the selected markup to open (default)
    * ***Closed:*** set the status of the selected markup to closed
  * ***Description:*** the description of the selected markup

## Conversation with Markups:

In addition to the description of a markup, it is possible to **add information to a markup without creating a new one**.

The conversation section contains all text entries and screenshots made by users using the markup tool.

![](/files/uhZxzrBi6rF5ddGDHplS)

## Using Conversations:

The conversation tab can be opened by **clicking on the corresponding markup** and will be shown in the lower part of the [properties](https://github.com/iVP-GmbH/iVP-gitbook/blob/main/home/ivp-planning/user-interface/the-info-panel.md).

|                                  |                                                                                                                                                                                                                                                                                                          |
| -------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| ![](/files/Io3ntfMkwQuvDkSZrvZ4) | Input field for text to be shown in the conversation below                                                                                                                                                                                                                                               |
|                                  |                                                                                                                                                                                                                                                                                                          |
| ![](/files/DUhbga0SMOF1gruTGCon) | Sends text to be shown in conversation below (alternatively press **Enter** in the input field )                                                                                                                                                                                                         |
|                                  |                                                                                                                                                                                                                                                                                                          |
| ![](/files/gddGJPlZFICcRMGfWsQT) | Replaces the [3d-view](https://github.com/iVP-GmbH/iVP-gitbook/blob/main/home/ivp-planning/advanced-tools/..user-interface/the-3d-view.md) with a panel that lets you [take and edit screenshots](https://github.com/iVP-GmbH/iVP-gitbook/blob/main/markup-tool.md#taking-a-screenshot-in-conversations) |
|                                  |                                                                                                                                                                                                                                                                                                          |
| ![](/files/WwfPEXutnlbNYB07XZuA) | After sending a text it will be shown in a chat with date/time of the text and who posted it; to delete a text, click the small bin icon                                                                                                                                                                 |
|                                  |                                                                                                                                                                                                                                                                                                          |
| ![](/files/88rRzZaA19SHCqIinZtm) | After [creating a screenshot](#taking-a-screenshot-in-conversations) it will be shown with the date and time it was posted; to delete a screenshot from the conversation, click the small bin icon                                                                                                       |
|                                  |                                                                                                                                                                                                                                                                                                          |
| ![](/files/E1gUgsmq9B6vhKdpCMBu) | Reopens the panel to [create a screenshot](#taking-a-screenshot-in-conversations) and will post a new screenshot in the conversation after confirming                                                                                                                                                    |
|                                  |                                                                                                                                                                                                                                                                                                          |

## Taking a screenshot in Conversations

After you press the Button **Create Screenshot**, the [3d-view](/intelligent-virtual-platform/home/ivp-planning/user-interface/the-3d-view.md) will be replaced with a panel that offers the possibility to take and edit screenshots.

![](/files/Qd2xEQvOzPAb7qWBjqqX)

You can use the 3d-view to [change the content of the screenshot](/intelligent-virtual-platform/home/ivp-planning/getting-started/moving-the-camera.md) until it fits your need.

![](/files/Jj6Lh6GjxwVAugdkr0YV)

When you are ready to take the screenshot, you have the option to confirm or cancel the screenshot. To do so, use **the buttons in the upper right corner of the screenshot**.

|                                  |                                                                                                                                 |
| -------------------------------- | ------------------------------------------------------------------------------------------------------------------------------- |
| ![](/files/TdmHqeytzszJccI82Dxn) | Change the color of the brush                                                                                                   |
|                                  |                                                                                                                                 |
| ![](/files/z3NHrjeW2yq1HvP3zbqq) | Use a brush to scribble directly onto the screenshot; change the size of the brush by clicking the small triangle in the corner |
|                                  |                                                                                                                                 |
| ![](/files/ocJa50V3mdgyaMAECoPr) | Use an eraser to delete scribbles on the screenshot; change the size of the eraser by clicking the small triangle in the corner |
|                                  |                                                                                                                                 |
| ![](/files/4Hj4jdnhyhNb4QCxC0dw) | Delete all scribbles on the screenshot; does not delete the screenshot itself!                                                  |
|                                  |                                                                                                                                 |
| ![](/files/y6tTm9VgZRx9XhsVq6JP) | Undo the last action (painting or erasing), or redo the last action                                                             |
|                                  |                                                                                                                                 |
| ![](/files/Xth5XBOIQLahzLzEicue) | Confirm the screenshot and send it to the conversation, or cancel the screenshot                                                |
|                                  |                                                                                                                                 |
