Gathering module administration manual
All of the following functionality is available through the Django administration panel at under /admin on the gathering server. Currently the administration panel is deployed under https://pz-gathering.mini.pw.edu.pl/admin/
Links to all configuration panels described below are listed on the main page of the administration panel.
The object type panel is available at /admin/publications/objecttype/, where all available object types are listed. You add a new object type by clicking on the Add object type link in the top-right corner.
One can also edit existing types by clicking on any of the types in the type list. Properties of an object type:
- Name – the name visible to the annotator.
- Key – the value used to compare the types (in code) and also the value saved in annotation JSONs. We recommend the key to be written in lowercase with underscores (_) as word separators, for consistency.
- Parent type – the parent object type this type will inherit all subobject types from. This lets you specify valid subobject types on only one master object type and then inherit these types on other object types.
- Subtypes – the subobject types available to annotators for this object type. See the next section for more information on subobject types.
- Sortkey – a numerical key to be used when ordering object types in the graphical interface for annotators. There are no specific rules for sortkeys, you can use any value that you see fit.
The available subobject types can be changed at /admin/publications/subobjecttype/.
This administration panel is very similar to the one previously described. One can also add, edit and remove subobject types. Properties of a subobject type:
- Name – the name visible to the annotator.
- Key – the value used to compare the types (in code) and also the value saved in annotation JSONs. We recommend the key to be written in lowercase with underscores (_) as word separators, for consistency.
- Is text annotation – sets whether the annotation should be of textual (marking text word by word) or “normal” type (marking objects with a bounding box).
- Orientation – only applies to non-textual subobject types. Sets the initial shape of the annotation bounding box. Neutral produces a square, Vertical – a tall rectangle (e.g. a Y axis) and Horizontal – a wide rectangle (e.g. a table row).
- Sortkey – a numerical key to be used when ordering subobject types in the graphical interface for annotators. There are no specific rules for sortkeys, you can use any value that you see fit.
The available annotation tags can be changed at /admin/publications/annotationtag/.
This administration panel is very similar to both panels previously described. One can also add, edit and remove annotation tags. Properties of an annotation tag:
- Name – the name visible to the annotator.
- Key – the value used to compare the types (in code) and also the value saved in annotation JSONs. We recommend the key to be written in lowercase with underscores (_) as word separators, for consistency.
- Sortkey – a numerical key to be used when ordering annotation tags types in the graphical interface for annotators. There are no specific rules for sortkeys, you can use any value that you see fit.
The password can be changed at /admin/auth/user/.
You will be presented with a list of users. Click on any of them in order to change their password. The Change user form will be shown. In the Info section you can find the Password field with a link to a form that will let you change this user’s password.
