Web-based application for T2WML, used to run alongside the main project here: https://github.com/usc-isi-i2/t2wml
The default setting is to use port 13000 for the back-end API.
From the main window (as shown in picture below; the designated file upload area is outlined in red) users are able to upload data files (Excel or CSV).
This can be done by clicking anywhere inside the designated upload area and choosing a file from the file system browser, or simply "dragging" the file into the designated file upload area.
Once the file upload is finished and upload successful message is shown, the data will be processed into a table overview.
Instructions on how to annotate the data will be shown on the right hand side.
With data uploaded and processed into the table overview, users can start annotating.
Users are able to select the countries as the main subject in the table following these actions:
- Select the area by pressing down the left mouse button and holding it while moving in the desired direction. Alternatively users can select an area and use the draggable square in the bottom right corner to resize the selection.
- Adjust the range of the selected area by changing the column and/or row in the annotation pop-up.
- Select country as the main subject from the "role" dropdown menu in the annotation pop-up.
- Confirm the selected area by pressing the "Submit new annotation" button.
Once the annotation is confirmed and the success message is shown - the selected area with the countries will be highlighted in blue.
Country names are automatically wikified (connected to the respective Qnodes in WikiData) and also highlighted in blue.
In addition, the wikified countries should now appear in the output preview on the right hand side.
In order to annotate the time qualifier area in the data table:
- Select the area by pressing down the left mouse button and holding it while moving in the desired direction. Alternatively users can select an area and use the draggable square in the bottom right corner to resize the selection.
- Adjust the range of the selected area by changing the column and/or row in the annotation pop-up.
- Select qualifier from the "role" dropdown menu in the annotation pop-up.
- Select time from the "type" dropdown menu in the annotation pop-up.
- Confirm the selected area by pressing the "Submit new annotation" button.
Once the annotation is confirmed and the success message is shown - the selected area with the time qualifier will be highlighted in purple.
If additional information is required, users can expand the annotation menu by pressing on the "Show additional inputs" button and enter precision and format of the time values as shown in the image below.
Annotated time qualifier should now appear in the output preview on the right hand side.
In order to annotate the dependent variable area in the data table:
- Select the area by pressing down the left mouse button and holding it while moving in the desired direction. Alternatively users can select an area and use the draggable square in the bottom right corner to resize the selection.
- Adjust the range of the selected area by changing the column and/or row in the annotation pop-up.
- Select dependent variable from the "role" dropdown menu.
- Select the correct variable type from the "type" dropdown menu in the annotation pop-up. The choices are "string", "quantity", "time" and "country". Each of which are explained in the tooltips marked with a (?).
- Confirm the selected area by pressing the "Submit new annotation" button.
Once the annotation is confirmed and the success message is shown - the selected area with the dependent variable will be highlighted in green.
Annotated dependent variable should now appear in the output preview on the right hand side.
In order to annotate the property area in the data table:
- Select the area by pressing down the left mouse button and holding it while moving in the desired direction. Alternatively users can select an area and use the draggable square in the bottom right corner to resize the selection.
- Adjust the range of the selected area by changing the column and/or row in the annotation pop-up.
- Select property from the "role" dropdown menu.
- Confirm the selected area by pressing the "Submit new annotation" button.
Once the annotation is confirmed and the success message is shown - the selected area with the property will be highlighted in orange.
Annotated property should now appear in the output preview on the right hand side.
If the property is not present in the data table, the users can create a custom property:
- Select the annotation area that requires a custom property.
- Press on the "Add a new property" button in the annotation pop-up, as shown in the image below.
- In the "Create a new property" pop-up window, enter the property label and description, as shown in the image below.
- Press the "Submit new property" button to confirm.
Once created, the property will appear in the annotation menu as shown in the image below.
To change the property label and/or description, press the pencil button and the property pop-up window will come up again.
Annotated property should now appear in the output preview on the right hand side.
Users can choose to let our system automatically suggest annotation blocks.
Select the "Suggest annotations" option from the project menu, or press the "Suggest annotations" button in the header.
With suggested annotations in place the output preview on the right hand side should be updated to reflect the changes.
Please note that if you have previously created annotations, this functionality will overwrite those with automatically suggested annotations.
Press the pencil button next to the property in order to change the label and/or description.
This can be done from either block or cell tab of the annotation pop-up window.
This will bring up the "Edit property" pop-up window.
Edit the label and/or description of the property and press "Save changes".
The changes should be automatically reflected in the output window on the right.
Press the "Show property tags" button to bring up the property tags window.
This will bring up the "Property tags" pop-up window.
In this window users can enter values for DocID, FactorClass, Normalizer, Relevance and Units tags.
Alternatively, users can create custom tags with the keys and values of their own choosing.
Changes are saved automatically and should be reflected in the output preview on the right.
Users can change the dataset name, description and or data set URL at any time in the "Project Settings" pop-up.
To bring up the project settings pop-up, select "Project Settings" from the menu in the top-left corner.
The "Project Settings" pop-up is where users can change the dataset name, description and/or data set URL.
The changes to the project settings are saved automatically.
To upload the FIDIL file, select the "Upload FIDIL" option in the project menu.
To download the FIDIL file, select the "FIDIL" option from download section of the project menu.
Select the "Saved Project" option in order to download and save the ".t2wmlz" project file to disk in order to save your progress.
To restore the project at a later time, simply upload this ".t2wmlz" file from the main screen.
Select the "Apply Annotations" option fromt he project menu in order to apply existing annotations.
This will bring up a pop-up window to upload an existing annotations file.
