Skip to main content

Dictionary Management

Dictionary Management keeps one source of truth for the wording of skills, objects, targets, adverbials, annotation tags, and data tags, so that the same data stays consistent across annotators and projects. Entries are grouped by ownership into global, project-internal shared, and project-specific, and each group limits editing by role and project membership.

Dictionary list (Skills tab, with English, Chinese, and Japanese columns)

Prerequisites​

ItemDetails
Menu entryData → Dictionary
Route/dicts
Page module permissionView Dictionaries
Required permissionManage Dictionaries
Visible rolesAdministrator, Project Manager, Auditor, Annotator
PrerequisiteNone

Browsing Dictionaries​

Dictionary Types​

The tabs at the top of the page correspond to dictionary types. The number in parentheses after a tab name is the entry count for that type.

TabData model typeContents
SkillsskillAction skill names and descriptions
ObjectsobjectObjects the action acts on
TargettargetTarget position or result of the action
AdverbialadverbialManner or condition of the action
Annotation TagsinvalidAnnotation validity tags
Data TagstagDataset classification tags
Label categorytagCategoryCategories of data tags, visible to administrators only

List Fields​

FieldNotes
Multi-selectSelect to run a batch delete
Usage CountNumber of times the entry is used in data; sortable
EnglishEnglish content; sortable
ChineseChinese content; sortable
JapaneseJapanese content; sortable, may be empty
OwnershipGlobal, same-project shared, or project-specific
CreatedEntry creation time; sortable
ActionsEdit, Delete; buttons for entries without permission are grayed out

The search box matches keywords in the English, Chinese, and Japanese content. The ownership filter is limited to All, Same-project shared, Project, or Global.

Ownership and Permissions​

OwnershipVisible scopeCreate permissionEdit and delete permission
Global DictionaryAll projectsAdministrators onlyAdministrators only
Project-internal shared dictionarySame project space of the current accountAll writable rolesThe creator; administrators unrestricted
Project-specific dictionaryMembers of the given projectProject membersThe creator; a project manager can manage dictionaries of own projects; administrators unrestricted

Global dictionaries are marked with a Global tag in the list, project-internal shared dictionaries with Same-project shared, and project-specific dictionaries with the project name.

Maintaining Entries​

Creating and Editing​

  1. On the tab of the target dictionary type, click Create Dictionary.
  2. Select the ownership; when the ownership is Project-specific dictionary, select a project.
  3. Fill in the English and Chinese content; the Japanese content is optional.
  4. After submission, the entry is written to the list.

Create dictionary dialog (with the {A} and {B} skill template description)

When adding an entry, switch to batch add to enter rows.

FieldTypeRequiredValuesNotes
OwnershipRadioYesGlobal Dictionary, Project-internal shared dictionary, Project-specific dictionaryGlobal and project-specific are limited by role and membership
ProjectRadioRequired when the ownership is project-specificProjects the current account belongs toDetermines the project's visible scope
EnglishTextYesNon-empty, must not contain Chinese charactersEnglish must be unique within a type
ChineseTextYesNon-emptyNone
JapaneseTextNoMay be emptyNone

Click Edit on an entry row to open the edit dialog, where the content and ownership can be changed; the ownership of a global dictionary cannot be changed.

Batch Add​

Batch add is entered as text in the create dialog and does not support import from a file.

ItemValue
Input formatOne entry per line, with fields separated by a comma or tab
Field orderEnglish, Chinese, Japanese
Separator requirementUse the English half-width comma
Submission resultEntries are created one by one and the success count is reported

Skill Placeholders​

The skill dictionary supports placeholders in the content, so the same action sentence can be applied to different objects. A site can enable placeholder validation, after which the English and Chinese placeholders must match one to one.

PlaceholderMeaning
{A}First object of the action, that is, the primary object
{B}Second object of the action, that is, the target position or an auxiliary object

For example, pick up {A} can be applied as pick up apple and pick up cup. The create and edit dialogs provide shortcut buttons to insert placeholders.

Export and Delete​

ActionLocationResult
Export CSVUpper right of the listExport all entries of the current dictionary type as CSV
Delete selected dictionariesUpper right of the listDelete the selected entries one by one, skipping entries without permission
Delete a single dictionaryActions column of an entry rowDelete that entry

Export and delete follow the type and ownership permissions; only administrators can delete global dictionaries.

Constraints and Limits​

ItemValueApplies to
English contentMust not contain Chinese charactersAll types
English uniquenessEnglish must be unique within a typeGlobal dictionaries and the scope of one creator
Global dictionary creationAdministrators onlyAll types
Japanese contentMay be emptyAll types
Skill placeholder consistencyWhen validation is enabled, English and Chinese placeholders must matchSkills type
Batch add sourceText input onlyCreating entries

Troubleshooting​

SymptomPossible causeResolutionOwner
"Dictionary cannot contain Chinese" is shownThe English content contains Chinese charactersChange it to English-only contentOperator
"A dictionary with the same English entry already exists" is shownThe English is duplicated within the same typeUse a different English entry, or edit the existing oneOperator
"Please use English comma to separate languages" is shownThe batch input used a Chinese commaSwitch to the English half-width commaOperator
"Keep placeholders aligned in English and Chinese" is shownThe Chinese and English placeholders do not matchAlign the placeholders or remove them allOperator
"Only admins can modify the global dictionary" is shownA non-administrator created or edited a global dictionarySwitch to project-internal shared or project-specific ownershipOperator
"Project dictionary requires specifying a project" is shownThe ownership is project-specific but no project was selectedSelect a projectOperator
A no-permission message is shown for edit or deleteThe entry ownership is outside the current account's scopeContact the creator or an administratorOperator, Administrator
"No delete permission" is shownThe entry is protectedContact an administratorAdministrator
PagePurpose
Annotation TasksReference dictionaries during annotation
Data ManagementEntry point for using data tags
Project ManagementProject and member scope
Module PermissionsConfigure View Dictionaries and Manage Dictionaries