Classes
The Classes tool window allows managing the classes of output information of the project, that is:
- The domains to which categorization rules can give points
- The templates of the extraction records whose fields can be set by extraction rules
The tool window has two panels:
- Taxonomy
- Templates
Taxonomy
The Taxonomy panel displays and allows managing the project taxonomy, that is, the tree structure in which categorization domains are defined.
The default view is a table in which each row represents a first-level domain. Rows can then be expanded to reveal descendant domains.
Columns are:
Name | Description |
---|---|
Name | Domain name |
Label | Domain description |
Rules | Number of categorization rules that give points to the domain |
Ann | Number of times the domain was annotated as a target output category for test documents |
Shortlist | Selection check box |
Info
Selected domains become part of the list from which you can choose when annotating target categories for a test document in the Project tool window or in the editor.
Context menu
Name | Description |
---|---|
Expand Node | Expand the current node. Available only if there are descendant domains. |
Compress Node | Collapse the current node. Available only if there are descendant domains. |
Add Node | Add a sibling domain, that is, a domain on the same level of the hierarchy. |
Add Child | Add a child domain. |
Edit Node | Modify domain name and/or description. |
Delete Node | Delete the domain. |
Annotate XXXX for file YYYY | Annotate domain XXXX as a categorization target for the test document YYYY that's currently opened and selected in the editor. |
When one or more domains are checked, the context menu has also the following commands:
Name | Description |
---|---|
Annotate checked nodes for file XXXX | Annotate the checked domains as a categorization target for the test file XXXX that's currently opened and selected in the editor. |
Annotate checked nodes for all opened files | Annotate the checked domains as a categorization target for all the test files currently opened in the editor. Option available for more than one file opened |
Add Node, Add Child and Edit Node commands open the Taxonomy Node dialog box. In it, the Generate command creates a suggested name for the domain. You can overwrite the suggestion and give the domain the name you prefer.
Toolbar
Icon | Name | Description |
---|---|---|
![]() |
Expand All | Expand all the nodes of the tree |
![]() |
Collapse All | Collapse all the nodes of the tree |
Search: box | Specify search criteria | |
![]() |
Reset | Reset the search criteria |
![]() |
Find next | Find the next match for the search criteria |
![]() |
Toggle Description Visibility | Toggle the display of the Description column |
![]() |
Open Taxonomy File | Open the taxonomy XML file |
![]() |
Uncheck All Nodes | Deselect all the checked nodes |
![]() |
Toggle Checked List | Toggle a summary view in which only checked domains are displayed |
![]() |
Show/hide annotations | Toggle the display of the Ann column |
![]() |
Refresh counters | Update rules and annotation counters |
Note
The Taxonomy tool window and the taxonomy.xml
file are synchronized, so each change made on one side is soon reflected on the other.
Other available mouse commands
Command | Description |
---|---|
double-click an item in the Name columns or in the Label column | Open the Taxonomy node window, where it is possible to modify the Name or the Label value. |
double-click an item in the Rules column | Open the Rule files window showing the list of files containing rules that give points to the domain. double-click on a file name to open the file in the editing area. |
double-click an item in the Ann column | Open the Annotation files window showing the list of files containing annotations of the domain. double-click on a file name to open the file in the editing area. |
Info bar
The info bar shows the total number of nodes and the number of selected nodes.
Templates
The Templates panel displays project's extraction templates.
The default view is a table in which each row represents a template. Rows can then be expanded to reveal templates' fields.
Columns are:
Name | Description |
---|---|
Name | Template or field name |
Attributes | Field attributes |
Rules | Number of rules that extract the field. For templates, the number if bracketed and represents the sum of the counters for template's fields. |
Ann | Number of times the field was annotated as a target output extraction for test documents. For templates, the number is bracketed and represents the sum of the counters of template's fields. |
Shortlist | Selection check box |
Info
Selected fields become part of the list from which you can choose when annotating target extractions for a test document in the editor.
Context menu
Name | Description |
---|---|
Expand Node | Expand the current node. Available for templates only. |
Compress Node | Collapse the current node. Available for templates only. |
Toolbar
Icon | Name | Description |
---|---|---|
![]() |
Expand All | Expand all the templates' nodes |
![]() |
Collapse All | Collapse all the templates' nodes |
Search: box | Specify search criteria | |
![]() |
Reset | Reset the search criteria |
![]() |
Find next | Find the next match for the search criteria |
![]() |
Toggle Attribute Visibility | Toggle the display of the Attributes column |
![]() |
Open Config File | Open the config.cr where templates are typically defined |
![]() |
Uncheck All Nodes | Deselect all the checked nodes |
![]() |
Toggle Checked List | Toggle a summary view in which only checked fields are displayed |
![]() |
Show/hide annotations | Toggle the display of the Ann column |
![]() |
Refresh counters | Update the view |
Other available mouse commands
Command | Description |
---|---|
double-click an item in the Rules column | (For fields only) Open the Rule files window showing the list of files containing rules that give points to the field. double-click on a file name to open the file in the editing area. |
double-click an item in the Ann column | (For fields only) Open the Annotation files window showing the list of files containing annotations of the field. double-click on a file name to open the file in the editing area. |