---
title: "Annotated documents"
section: "Operator"
route: /operatoranndocuments
account: {accountId}
bruce_api: https://{accountId}.api.nextspace.host
guardian_api: https://guardian.nextspace.host
---
# Annotated documents

Annotated documents are files with hot-spots that let you traverse between 2D and 3D views. Upload a PDF or SVG file in Operator to create one.

Once an annotated document is made, you can drop a .HIT file onto a .SVG document, or a .XML onto a PDF document to automatically create the hot-spots. Hot-spots can also be manually created on selected areas on the document.

Once a hot-spot is made and associated with an Entity, the document will appear in the `Attachments` tab in Navigator when the Entity is selected.

Below is an example of a .HIT file that can be dropped onto a .SVG file to create hot-spots.

```text
100.1 10 my_key1 'This is a description of a hotspot'
200.2 50 my_key2 'This is another description of a hotspot'
```

The order of the columns is `X-coordinate`, `Y-coordinate`, `foreign-key`, and `Description`. The description is optional.

You will be able to perform a query to match the foreign-keys with a selected Entity attribute to link the hot-spots to Entities.

You can automatically include the Entity ID by adding `(Nextspace Entity ID: abcdef)` to the end of the description.
For example:

```text
100.1 10 my_key1 'This is a description of a hotspot (Nextspace Entity ID: abcdef)'
```

When hot-spotting a PDF, the .XML file will look like this:

```xml
<Hotspots>
    <Map
        GOID="12345"
        Name="Hotspot1"
        PageIndex="0"
        XMIN="100" YMIN="200" XMAX="150" YMAX="250"
        Width="800" Height="600"
        NextspaceEntityID="abcdef" />

    <Map
        GOID="67890"
        Name="Hotspot2"
        PageIndex="0"
        XMIN="200" YMIN="300" XMAX="250" YMAX="350"
        Width="800" Height="600"
        NextspaceEntityID="ghijkl" />
</Hotspots>
```

The primary difference between .HIT and .XML is that .XML will specify what page of the PDF the hot-spot is on. If unspecified, we assume page index 0. If no width and height are specified then we assume the hot-spot coordinates don't need adjustmnet to the target document proportions.

If you need samples of .HIT or .XML files, you can manually place them then export the hot-spot file from Operator.

---

Urls on this page are resolved for account `{accountId}`.
Site index: https://docs.nextspace.host/llms.txt · whole site in one file: https://docs.nextspace.host/llms-full.txt
Human-readable version of this page: https://docs.nextspace.host/operatoranndocuments