Sort relations by token ids.

Author: jdchoi77

README.md

@@ -1,15 +1,15 @@
 # StreamSide
 
-StreamSide is a annotation toolkit that derives a semantic network from plain text.
-This is an open-source project led by the [Emory NLP Research Laboratory](http://nlp.cs.emory.edu).
-
-* Latest release: [0.2](../../releases/tag/streamside-0.2) (8/13/2020).
+StreamSide provides you an open-source framework to annotate meaning representations such as [Abstract Meaning Representation](https://amr.isi.edu) (AMR) or [Widely Interpretable Semantic Representation](https://github.com/emorynlp/wiser) (WISeR) that can be easily customized for any representation in any language.
+This project is led by the [Emory NLP Research Laboratory](http://nlp.cs.emory.edu) and under the [Apache 2.0](https://github.com/emorynlp/StreamSide/blob/master/LICENSE) license.
+* Latest release: [0.4](https://github.com/emorynlp/StreamSide/releases/tag/streamside-0.4) (6/25/2021).
 
 ## Documentations
 
-* [Getting Started](docs/getting_started.md)
-* [Graph Annotator](docs/graph_annotator.md)
-* [JSON to Penman Convertor](docs/json_to_penman.md)
+* [Getting Started](https://github.com/emorynlp/StreamSide/blob/master/docs/getting_started.md)
+* [Graph Annotator](https://github.com/emorynlp/StreamSide/blob/master/docs/graph_annotator.md)
+* [JSON to Penman Convertor](https://github.com/emorynlp/StreamSide/blob/master/docs/json_to_penman.md)
+* [Penman to JSON Convertor](https://github.com/emorynlp/StreamSide/blob/master/docs/penman_to_json.md)
 
 ## Contact
 

docs/getting_started.md

@@ -31,8 +31,8 @@ Under the virtual environment, install StreamSide:
 (venv) $ pip install streamside
 ```
 
-Launch the [Graph Annotator](graph_annotator.md) using the following command (replace `AID` with your ID):
+Launch the [Graph Annotator](graph_annotator.md) using the following command (replace `ANNOTATOR_ID` with your ID):
 
 ```bash
-(venv) $ python -m streamside.annotator -a AID &
-```
+(venv) $ python -m streamside.annotator -a ANNOTATOR_ID &
+```

docs/graph_annotator.md

@@ -11,22 +11,32 @@ python -m streamside.annotator -a ANNOTATOR_ID [-m wiser|amr -r RESOURCE_DIR] &
 * `-m` or `--mode`: choose the representation `wisen` (default) or `amr`.
 * `-r` or `--resources`: the path to a custom resource directory; if not specified, it uses the default [resources](../streamside/resources/).
 
+> For the following sections, replace the `Ctrl` key with the `Cmd` key if you are using a mac.
 
-## Annotate
 
-> If you are using a mac, replace the `Ctrl` key with the `Cmd` key .
+## File Menu
 
-### Open File
+### Open
 
 Press `Ctrl+o` to prompt a file dialog:
 
-* For the initial annotation, choose a text file comprising a sentence per line (e.g., [training-examples.txt](training-examples.txt)).
-* For a returning annotation, choose a JSON file that is previously saved (e.g., [training-examples.jdchoi.json](training-examples.jdchoi.json)).
+* For the initial annotation, choose a text file comprising a sentence per line (e.g., [sample-amr.txt](../samples/sample-amr.txt)).
+* For a returning annotation, choose a JSON file that is previously saved (e.g., [sample-amr.jdchoi.json](../samples/sample-amr.jdchoi.json)).
+* If you have an existing annotation in the Penman notation, choose a Penman file (e.g., [sample-amr.penman](../samples/sample-amr.penman)).
 
-### Save File
+> StreamSide supports only the following file extensions: `txt`, `json`, `penman`. 
+
+### Save
 
 Press `Ctrl+s` to save the current annotation to the JSON file whose name includes the annotator ID.
 
+### Quit
+
+Press `Ctrl+q` to quit the annotator.
+
+
+## Edit Menu
+
 ### Create Concept
 
 Any of the following actions will prompt the input dialog to create a concept:
@@ -76,6 +86,18 @@ Once the input dialog is prompted:
 * To make an inverse relation (`*-of`), press `Ctrl+f` or check the `Inverse` box.
 * Press `Enter` or the `OK` button to create the concept.
 
+> The `Referent` box gets automatically checked if (1) the child concept already has another parent concept or (2) if the child concept is an ancestor of the parent concept.   
+
+### Update
+
+To update the name of a concept or an attribute:
+
+* Highlight the ID of the concept/attribute and press `Ctrl+f`.
+
+To update the label of a relation:
+
+* Highlight the label of the relation and press `Ctrl+f`.
+
 ### Delete
 
 To delete a concept or an attribute:
@@ -86,16 +108,13 @@ To delete a relation:
 
 * Highlight the label of the relation and press `Ctrl+d`.
 
-### Update
-
-To update the name of a concept or an attribute:
-
-* Highlight the ID of the concept/attribute and press `Ctrl+f`.
+### Add/Remove Text Span
 
-To update the label of a relation:
-
-* Highlight the label of the relation and press `Ctrl+f`.
+To add/remove certain text spans to an existing concept (or attribute):
 
+* Highlight the ID of the concept and press `z` that shows it as well as text spans associated with the concept in a <span style="background-color:burlywood;">burlywood</span> background.
+* Highlight text spans you want to add/remove to/from the concept and press `v`.
+* To deselect the concept/attribute, press `Shift+z`.
 
 ### Navigate
 

docs/json_to_penman.md

@@ -6,4 +6,4 @@ The following command converts the JSON files generated by StreamSide to the Pen
 python -m streamside.json_to_penman -i INPUT_PATH [-o OUTPUT_PATH]
 ```
 * `-i` or `--input`: the path to a JSON file or a directory containing JSON files (required).
-* `-o` or `--output`: the path to the output file(s) (default: the input directory).
+* `-o` or `--output`: the path to the Penman output file(s) (default: the input directory).

docs/penman_to_json.md

@@ -0,0 +1,9 @@
+# Penman to JSON Converter
+
+The following command converts the JSON files generated by StreamSide to the Penman notation:
+
+```bash
+python -m streamside.penman_to_json -i INPUT_PATH [-o OUTPUT_PATH]
+```
+* `-i` or `--input`: the path to a Penman file or a directory containing Penman files (required).
+* `-o` or `--output`: the path to the JSON output file(s) (default: the input directory).