Deleting entity instanced from highlighted text fails to restore original text

This bug/behavior relates to a critical UX research repository we’ve built (trying to replace some Dovetail functionality)

  1. Create an entity (call it a research article or something, lots of text copied from a web article)
  2. Highlight text inside the entity (inside description field) and create entity from that text (we call the new entity type a ‘Highlight’)
  3. View and then delete the new Highlight instance
  4. go back to the research article where the highlight was created from
  5. the text that was highlighted is deleted and in its place there’s instead a “Highlights not found” inline error message

This is not actually a bug, this is intended behaviour.
There are two ways to link to an entity from within text: ‘mentions’ or ‘linked highlights’.
If you create an entity directly from highlighted text, you are creating a mention, which is equivalent to using # to mention an existing item.
The name of the entity is the text of the mention (and vice versa!) so if you edit the entity’s name then the ‘mention’ text changes, and if you delete the entity, the text will be lost.

Alternatively, you can highlight text and link to an existing entity. This creates a linked highlight, which behaves somewhat like a traditional reference/footnote - editing the entity does not affect the highlighted text, and deleting the entity just removes the reference without affecting the original text.

Admittedly, it is much easier to create an entity from scratch by using the mention method, compared with the two-stage process required for a linked highlight (create the entity and then reference it).

We are thinking about ways to make the distinction clearer and ways to make linked highlight entity creation simpler.

1 Like

Fyi, you should be able to restore the entity from the Trash bin, and then you can manually convert the link from mention to linked highlight.