Skip to content
Nils Reiter edited this page Mar 2, 2019 · 4 revisions

v1.8.0

Since version 1.8, it is possible to add custom flags that can be attached to mentions, entities and detached mention parts. Flags are stored in the document.

Flag editor

The flag editor can be opened via the tools menu.

New menu entry to open the flag editor

The editor shows a table with four columns, each row representing one flag (type). A flag is defined by four features (shown in the table from left to right):

The flag editor

  • Icon: Each flag is associated with an icon to help annotators to recognize it. The icon can be selected from the selection shown on this page. It's recommended to search for a useful icon on the page, as it is much easier to compare and see
  • Key: The key is used internally to link to the flags. Each annotation that is flagged stores this key. Initially, the key will be universally unique identifier (UUID), and it can remain this way. For merging and comparing, it is recommended to harmonize the keys in different files. If the key is changed, please note that it should still be unique within the document.
  • Label: The label is displayed in the menus and user interface. This is what the annotators see.
  • Target class: Flags can be associated with types of annotations. I.e., each flag can only be assigned to annotations of the kind specified here. There is currently no way of having flags applicable on different annotation types, but it is not a problem to have multiple flags with the same label/icon and different target classes.

Applying flags

Context menu to mark an entity with a flag

Flags can be applied via the top menu bar or with a secondary click on an entity or mention. The latter opens a context menu which is shown above.

Flag collections

There is a number of flags that is expected to be needed often. These can be added automatically via so called flag collections. The flag collections will be extended as needed in future versions.

In v1.8.0, the following flags are included. Check this page for the icons.

Flag collection 1 (flags for entities)

Icon Key Label Target type
MDI_GENDER_FEMALE female Female Entity
MDI_GENDER_MALE male Male Entity
MDI_GENDER_MALE_FEMALE male-female Male/Female Entity
MDI_GENDER_TRANSGENDER transgender Transgender Entity

Flag collection 2 (flags for mentions)

Icon Key Label Target type
MDI_GAVEL predicate Predicate Mention
MDI_ARROW_TOP_LEFT pronoun Pronoun Mention
MDI_TAG name Proper name Mention